FabricTools v0.33.0 Public Preview

Get-FabricCopyJob

Retrieves CopyJob details from a specified Microsoft Fabric workspace.

Syntax

Get-FabricCopyJob [-WorkspaceId] <guid> [[-CopyJobId] <guid>] [[-CopyJob] <string>]
 [<CommonParameters>]

Description

This function retrieves CopyJob details from a specified workspace using either the provided CopyJobId or CopyJob. It handles token validation, constructs the API URL, makes the API request, and processes the response.

Examples

Example 1

This example retrieves the CopyJob details for the CopyJob with ID "CopyJob-67890" in the workspace with ID "workspace-12345".

Get-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobId "CopyJob-67890"

Example 2

This example retrieves the CopyJob details for the CopyJob named "My CopyJob" in the workspace with ID "workspace-12345".

Get-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJob "My CopyJob"

Parameters

NameTypeReq.Pos.PipelineDescription
-WorkspaceId guid ✓Required 0 –

The unique identifier of the workspace where the CopyJob exists. This parameter is mandatory.

-CopyJob string 2 –

The name of the CopyJob to retrieve. This parameter is optional.

-CopyJobId guid 1 –

The unique identifier of the CopyJob to retrieve. This parameter is optional.

This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.

Notes

Requires $FabricConfig global configuration, including BaseUrl and FabricHeaders. Calls Confirm-TokenState to ensure token validity before making the API request.

Author: Tiago Balabuch