Update-FabricCopyJobDefinition
Updates the definition of a Copy Job in a Microsoft Fabric workspace.
Syntax
Update-FabricCopyJobDefinition [-WorkspaceId] <guid> [-CopyJobId] <guid>
[-CopyJobPathDefinition] <string> [[-CopyJobPathPlatformDefinition] <string>] [-WhatIf] [-Confirm]
[<CommonParameters>]Description
This function updates the content or metadata of a Copy Job within a Microsoft Fabric workspace. The Copy Job content and platform-specific definitions can be provided as file paths, which will be encoded as Base64 and sent in the request.
Examples
Example 1
Updates the content of the Copy Job with ID 67890 in the workspace 12345 using the specified Copy Job file.
Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb"Example 2
Updates both the content and platform-specific definition of the Copy Job with ID 67890 in the workspace 12345.
Update-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890" -CopyJobPathDefinition "C:\CopyJobs\CopyJob.ipynb" -CopyJobPathPlatformDefinition "C:\CopyJobs\Platform.json"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -CopyJobId | guid | ✓Required | 1 | – | (Mandatory) The unique identifier of the Copy Job to be updated. |
| -CopyJobPathDefinition | string | ✓Required | 2 | – | (Mandatory) The file path to the Copy Job content definition file. The file content will be encoded as Base64. |
| -WorkspaceId | guid | ✓Required | 0 | – | (Mandatory) The unique identifier of the workspace containing the Copy Job. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -CopyJobPathPlatformDefinition | string | 3 | – | (Optional) The file path to the platform-specific definition file for the Copy Job. The file content will be encoded as Base64. |
|
| -WhatIfalias: wi | switch | Named | – | Runs the command in a mode that only reports what would happen without performing the actions. |
This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.
Notes
- Validates token expiration using
Confirm-TokenStatebefore making the API request. - Encodes file content as Base64 before sending it to the Fabric API.
Author: Tiago Balabuch, Kamil Nowinski