Invoke-AzDataFactoryV2Pipeline

Module:

Az.DataFactory Module

Invokes a pipeline to start a run for it.

Syntax

ByFactoryNameByParameterFile (Default)

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

ByPipelineObjectByParameterFile

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

ByPipelineObjectByParameterObject

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

ByFactoryNameByParameterObject

Invoke-AzDataFactoryV2Pipeline
    [-ResourceGroupName] <String>
    [-DataFactoryName] <String>
    [-PipelineName] <String>
    [[-Parameter] <Hashtable>]
    [[-ReferencePipelineRunId] <String>]
    [[-StartActivityName] <String>]
    [-IsRecovery]
    [-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.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DataFactoryName

The data factory name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByFactoryNameByParameterFile

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

ByFactoryNameByParameterObject

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-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

-InputObject

The data factory object.

Parameter properties

Type:	PSPipeline
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByPipelineObjectByParameterFile

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByPipelineObjectByParameterObject

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Parameter

Parameters for pipeline run.

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByPipelineObjectByParameterObject

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

ByFactoryNameByParameterObject

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ParameterFile

The name of the file with parameters for pipeline run.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByFactoryNameByParameterFile

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

ByPipelineObjectByParameterFile

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PipelineName

The pipeline name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByFactoryNameByParameterFile

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

ByFactoryNameByParameterObject

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ResourceGroupName

The resource group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByFactoryNameByParameterFile

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

ByFactoryNameByParameterObject

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-StartActivityName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-StartFromFailure

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	7
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
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.

Inputs

PSPipeline

String

Hashtable

Outputs

String

Related Links

• Get-AzDataFactoryV2PipelineRun
• Get-AzDataFactoryV2ActivityRun