FabricTools v0.33.0 Public Preview

Get-FabricDataPipeline

Retrieves data pipelines from a specified Microsoft Fabric workspace.

Syntax

Get-FabricDataPipeline [-WorkspaceId] <guid> [[-DataPipelineId] <guid>]
 [[-DataPipelineName] <string>] [<CommonParameters>]

Description

This function retrieves all data pipelines from a specified workspace using either the provided Data PipelineId or Data PipelineName. It handles token validation, constructs the API URL, makes the API request, and processes the response.

Examples

Example 1

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

Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineId "Data Pipeline-67890"

Example 2

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

Get-FabricDataPipeline -WorkspaceId "workspace-12345" -Data PipelineName "My Data Pipeline"

Parameters

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

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

-DataPipelineId guid 1 –

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

-DataPipelineName string 2 –

The name of the Data Pipeline 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