Get-FabricCopyJobDefinition
Retrieves the definition of a Copy Job from a specific workspace in Microsoft Fabric.
Syntax
Get-FabricCopyJobDefinition [-WorkspaceId] <guid> [-CopyJobId] <guid> [[-CopyJobFormat] <string>]
[<CommonParameters>]Description
This function fetches the Copy Job's content or metadata from a workspace. It supports both synchronous and asynchronous operations, with detailed logging and error handling.
Examples
Example 1
Retrieves the definition of the Copy Job with ID 67890 from the workspace with ID 12345.
Get-FabricCopyJobDefinition -WorkspaceId "12345" -CopyJobId "67890"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -CopyJobId | guid | ✓Required | 1 | – | (Mandatory) The unique identifier of the Copy Job whose definition needs to be retrieved. |
| -WorkspaceId | guid | ✓Required | 0 | – | (Mandatory) The unique identifier of the workspace from which the Copy Job definition is to be retrieved. |
| -CopyJobFormat | string | 2 | – | (Optional) Specifies the format of the Copy Job definition. For example, 'json' or 'xml'. |
This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.
Notes
- Requires
$FabricConfigglobal configuration, includingBaseUrlandFabricHeaders. - Calls
Confirm-TokenStateto ensure token validity before making the API request. - Handles long-running operations asynchronously.
- Logs detailed information for debugging purposes.
Author: Tiago Balabuch