Update-FabricCopyJob
Updates an existing Copy Job in a specified Microsoft Fabric workspace.
Syntax
Update-FabricCopyJob [-WorkspaceId] <guid> [-CopyJobId] <guid> [-CopyJobName] <string>
[[-CopyJobDescription] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Sends a PATCH request to the Microsoft Fabric API to update an existing Copy Job in the specified workspace. Allows updating the Copy Job's name and optionally its description.
Examples
Example 1
Updates the Copy Job with ID "copyjob-67890" in the workspace "workspace-12345" with a new name and description.
Update-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "copyjob-67890" -CopyJobName "Updated Copy Job" -CopyJobDescription "Updated description"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -CopyJobId | guid | ✓Required | 1 | – | The unique identifier of the Copy Job to be updated. This parameter is mandatory. |
| -CopyJobName | string | ✓Required | 2 | – | The new name for the Copy Job. This parameter is mandatory. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace containing the Copy Job. This parameter is mandatory. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -CopyJobDescription | string | 3 | – | An optional new description for the Copy Job. |
|
| -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
- Ensures token validity by calling
Confirm-TokenStatebefore making the API request.
Author: Tiago Balabuch, Kamil Nowinski