Invoke-AzSynapsePipeline

Reference

Module:: Az.Synapse

Invokes a pipeline to start a run for it.

Syntax

Invoke-AzSynapsePipeline
      -WorkspaceName <String>
      -PipelineName <String>
      [-Parameter <Hashtable>]
      [-ParameterFile <String>]
      [-ReferencePipelineRunId <String>]
      [-IsRecovery]
      [-StartActivityName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzSynapsePipeline
      -InputObject <PSPipelineResource>
      [-Parameter <Hashtable>]
      [-ParameterFile <String>]
      [-ReferencePipelineRunId <String>]
      [-IsRecovery]
      [-StartActivityName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzSynapsePipeline
      -WorkspaceObject <PSSynapseWorkspace>
      -PipelineName <String>
      [-Parameter <Hashtable>]
      [-ParameterFile <String>]
      [-ReferencePipelineRunId <String>]
      [-IsRecovery]
      [-StartActivityName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Invoke-AzSynapsePipeline command starts a run on the specified pipeline and returns a ID for that run. This GUID can be passed to Get-AzSynapsePipelineRun or Get-AzSynapseActivityRun to obtain further details about this run.

Examples

Example 1

Invoke-AzSynapsePipeline -WorkspaceName ContosoWorkspace -PipelineName ContosoPipeline

This command starts a run for pipeline called ContosoPipeline in the workspace ContosoWorkspace.

Example 2

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

This command starts a run for pipeline called ContosoPipeline in the workspace ContosoWorkspace through pipeline.

Example 3

$pipeline = Get-AzSynapsePipeline -WorkspaceName ContosoWorkspace -Name ContosoPipeline
$pipeline | Invoke-AzSynapsePipeline

This command starts a run for pipeline called ContosoPipeline in the workspace ContosoWorkspace through pipeline.

Parameters

-AsJob

Run cmdlet in the background

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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

-InputObject

The information about the pipeline run.

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

-IsRecovery

Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.

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

-Parameter

Parameters for pipeline run.

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

-ParameterFile

The name of the file with parameters for pipeline run.

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

-PipelineName

The pipeline name.

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

-ReferencePipelineRunId

The pipeline run ID for rerun. If run ID is specified, the parameters of the specified run will be used to create a new run.

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

-StartActivityName

In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
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

PSPipelineResource

PSSynapseWorkspace

Outputs

PSCreateRunResponse