Get-AzSynapsePipeline

Reference

Module:: Az.Synapse

Gets information about pipelines in workspace.

Syntax

Get-AzSynapsePipeline
   -WorkspaceName <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapsePipeline
   -WorkspaceObject <PSSynapseWorkspace>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapsePipeline cmdlet gets information about pipelines in workspace. If you specify the name of a pipeline, this cmdlet gets information about that pipeline. If you do not specify a name, this cmdlet gets information about all the pipelines in the workspace.

Examples

Example 1

Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace

This command gets information about all pipelines in the workspace named ContosoWorkspace.

Example 2

Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline

This command gets information about the pipeline named ContosoPipeline in the workspace named ContosoWorkspace.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapsePipeline -Name ContosoPipeline

This command gets information about the pipeline named ContosoPipeline in the workspace named ContosoWorkspace through pipeline.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The pipeline name.

Type:	String
Aliases:	PipelineName
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

Name of Synapse workspace.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type:	PSSynapseWorkspace
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

PSSynapseWorkspace

Outputs

PSPipelineResource