New-FabricCopyJob
Creates a new copy job in a specified Microsoft Fabric workspace.
Syntax
New-FabricCopyJob [-WorkspaceId] <guid> [-CopyJobName] <string> [[-CopyJobDescription] <string>]
[[-CopyJobPathDefinition] <string>] [[-CopyJobPathPlatformDefinition] <string>] [-WhatIf]
[-Confirm] [<CommonParameters>]Description
Sends a POST request to the Microsoft Fabric API to create a new copy job in the specified workspace. Supports optional parameters for description and definition files.
Examples
Example 1
Creates a new copy job named "New Copy Job" in the workspace with ID "workspace-12345".
New-FabricCopyJob -WorkspaceId "workspace-12345" -CopyJobName "New Copy Job" -CopyJobDescription "Description of the new copy job"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -CopyJobName | string | ✓Required | 1 | – | The name of the copy job to be created. Mandatory. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the copy job will be created. Mandatory. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -CopyJobDescription | string | 2 | – | Optional description for the copy job. |
|
| -CopyJobPathDefinition | string | 3 | – | Optional file path to the copy job definition JSON file. |
|
| -CopyJobPathPlatformDefinition | string | 4 | – | Optional file path to the platform definition file. |
|
| -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
- Calls
Confirm-TokenStateto ensure token validity before making the API request.
Author: Tiago Balabuch, Kamil Nowinski