Invoke-AzDataFactoryV2Pipeline

Reference

Module:: Az.DataFactory

Invokes a pipeline to start a run for it.

Syntax

Invoke-AzDataFactoryV2Pipeline
      [-ResourceGroupName] <String>
      [-DataFactoryName] <String>
      [-PipelineName] <String>
      [[-ParameterFile] <String>]
      [[-ReferencePipelineRunId] <String>]
      [-IsRecovery]
      [[-StartActivityName] <String>]
      [-StartFromFailure]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataFactoryV2Pipeline
      [-InputObject] <PSPipeline>
      [[-ParameterFile] <String>]
      [[-ReferencePipelineRunId] <String>]
      [-IsRecovery]
      [[-StartActivityName] <String>]
      [-StartFromFailure]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataFactoryV2Pipeline
      [-InputObject] <PSPipeline>
      [[-Parameter] <Hashtable>]
      [[-ReferencePipelineRunId] <String>]
      [-IsRecovery]
      [[-StartActivityName] <String>]
      [-StartFromFailure]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzDataFactoryV2Pipeline
      [-ResourceGroupName] <String>
      [-DataFactoryName] <String>
      [-PipelineName] <String>
      [[-Parameter] <Hashtable>]
      [[-ReferencePipelineRunId] <String>]
      [-IsRecovery]
      [[-StartActivityName] <String>]
      [-StartFromFailure]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

Examples

Example 1: Invoke a pipeline to start a run

Invoke-AzDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineName "DPWikisample"

867d9d9f-1efc-4fee-974d-d8e6320bfbcb

This command starts a run for "DPWikisample" pipeline in the "WikiADF" factory.

Example 2

Invokes a pipeline to start a run for it. (autogenerated)

Invoke-AzDataFactoryV2Pipeline -DataFactoryName 'WikiADF' -Parameter <Hashtable> -PipelineName 'DPWikisample' -ResourceGroupName 'ADF'

Parameters

-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

-DataFactoryName

The data factory name.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
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 data factory object.

Type:	PSPipeline
Position:	0
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:	5
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Parameter

Parameters for pipeline run.

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

-ParameterFile

The name of the file with parameters for pipeline run.

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

-PipelineName

The pipeline name.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
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:	4
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

The resource group name.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
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:	6
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-StartFromFailure

Start rerun from failed activities flag. In recovery mode, if specified, the rerun will start from failed activities.

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

-WhatIf

Shows what happens if the cmdlet runs, but doesn't run the cmdlet.

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

Inputs

PSPipeline

String

Hashtable

Outputs