Skip to content

Get-FabricCopyJobDefinition.md

Latest commit

 

History

History
133 lines (100 loc) · 2.87 KB

Get-FabricCopyJobDefinition.md

File metadata and controls

133 lines (100 loc) · 2.87 KB
Raw
document type cmdlet
external help file FabricTools-Help.xml
HelpUri
Locale en-US
Module Name FabricTools
ms.date 04/01/2026
PlatyPS schema version 2024-05-01
title Get-FabricCopyJobDefinition

Get-FabricCopyJobDefinition

SYNOPSIS

Retrieves the definition of a Copy Job from a specific workspace in Microsoft Fabric.

SYNTAX

__AllParameterSets

Get-FabricCopyJobDefinition [-WorkspaceId] <guid> [-CopyJobId] <guid> [[-CopyJobFormat] <string>]
 [<CommonParameters>]

ALIASES

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

-CopyJobFormat

(Optional) Specifies the format of the Copy Job definition. For example, 'json' or 'xml'.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-CopyJobId

(Mandatory) The unique identifier of the Copy Job whose definition needs to be retrieved.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WorkspaceId

(Mandatory) The unique identifier of the workspace from which the Copy Job definition is to be retrieved.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

  • Requires $FabricConfig global configuration, including BaseUrl and FabricHeaders.
  • Calls Confirm-TokenState to ensure token validity before making the API request.
  • Handles long-running operations asynchronously.
  • Logs detailed information for debugging purposes.

Author: Tiago Balabuch

RELATED LINKS

{{ Fill in the related links here }}