Update-FabricDataPipeline
Updates an existing DataPipeline in a specified Microsoft Fabric workspace.
Syntax
Update-FabricDataPipeline [-WorkspaceId] <guid> [-DataPipelineId] <guid>
[-DataPipelineName] <string> [[-DataPipelineDescription] <string>] [-WhatIf] [-Confirm]
[<CommonParameters>]Description
This function sends a PATCH request to the Microsoft Fabric API to update an existing DataPipeline in the specified workspace. It supports optional parameters for DataPipeline description.
Examples
Example 1
This example updates the DataPipeline with ID "pipeline-67890" in the workspace with ID "workspace-12345" with a new name and description.
Update-FabricDataPipeline -WorkspaceId "workspace-12345" -DataPipelineId "pipeline-67890" -DataPipelineName "Updated DataPipeline" -DataPipelineDescription "Updated description"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -DataPipelineId | guid | ✓Required | 1 | – | The unique identifier of the DataPipeline to be updated. This parameter is mandatory. |
| -DataPipelineName | string | ✓Required | 2 | – | The new name of the DataPipeline. This parameter is mandatory. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the DataPipeline exists. This parameter is optional. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -DataPipelineDescription | string | 3 | – | An optional new description for the DataPipeline. |
|
| -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
- Requires
$FabricConfigglobal configuration, includingBaseUrlandFabricHeaders. - Calls
Confirm-TokenStateto ensure token validity before making the API request.
Author: Tiago Balabuch