Get-AzSynapsePipelineRun
Gets information about pipeline runs.
Syntax
GetByNameAndId (Default)
Get-AzSynapsePipelineRun
-WorkspaceName <String>
-PipelineRunId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByNameAndTime
Get-AzSynapsePipelineRun
-WorkspaceName <String>
-RunStartedAfter <DateTimeOffset>
-RunStartedBefore <DateTimeOffset>
[-PipelineName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByObjectAndId
Get-AzSynapsePipelineRun
-WorkspaceObject <PSSynapseWorkspace>
-PipelineRunId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByObjectAndTime
Get-AzSynapsePipelineRun
-WorkspaceObject <PSSynapseWorkspace>
-RunStartedAfter <DateTimeOffset>
-RunStartedBefore <DateTimeOffset>
[-PipelineName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzSynapsePipelineRun command returns information about runs for the specified pipeline. If PipelineRunId is specified, it shows details for the run with that ID. If the PipelineRunId is not specified, then it shows information about all runs for the pipelines that happened between the values of RunStartedAfter and RunStartedBefore.
Examples
Example 1: Get pipeline run by ID
Get-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineRunId "61eb095a-fe23-4591-8a97-fade6c65ca72"
This command gets details about the pipeline run with ID "61eb095a-fe23-4591-8a97-fade6c65ca72".
Example 2: Get pipelines runs between the dates
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapsePipelineRun -RunStartedAfter "4/2/2007 7:23:57 PM" -RunStartedBefore "4/2/2027 7:23:57 PM"
This command gets details about the runs of all pipelines in the workspace ContosoWorkspace that started between "4/2/2007 7:23:57 PM" and "4/2/2027 7:23:57 PM"
Example 3: Get a single pipeline runs between the dates
Get-AzSynapsePipelineRun -WorkspaceName ContosoWorkspace -PipelineName ContosoPipeline -RunStartedAfter "4/2/2007 7:23:57 PM" -RunStartedBefore "4/2/2027 7:23:57 PM"
This command gets details about the runs of ContosoPipeline pipeline in the workspace ContosoWorkspace that started between "4/2/2007 7:23:57 PM" and "4/2/2027 7:23:57 PM"
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PipelineName
The pipeline name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByNameAndTime
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByObjectAndTime
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PipelineRunId
The pipeline run identifier.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByNameAndId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByObjectAndId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RunStartedAfter
The time at or after which the run event was updated in 'ISO 8601' format.
Parameter properties
Type: DateTimeOffset
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByNameAndTime
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByObjectAndTime
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RunStartedBefore
The time at or before which the run event was updated in 'ISO 8601' format.
Parameter properties
Type: DateTimeOffset
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByNameAndTime
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByObjectAndTime
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WorkspaceName
Name of Synapse workspace.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetByNameAndId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByNameAndTime
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WorkspaceObject
workspace input object, usually passed through the pipeline.
Parameter properties
Parameter sets
GetByObjectAndId
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
GetByObjectAndTime
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
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 .
Outputs
