Invoke-AzureRmDataFactoryV2Pipeline
Invokes a pipeline to start a run for it.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Invoke-AzureRmDataFactoryV2Pipeline
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-PipelineName] <String>
[[-ParameterFile] <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-AzureRmDataFactoryV2Pipeline
[-InputObject] <PSPipeline>
[[-ParameterFile] <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-AzureRmDataFactoryV2Pipeline
[-InputObject] <PSPipeline>
[[-Parameter] <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-AzureRmDataFactoryV2Pipeline
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-PipelineName] <String>
[[-Parameter] <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Invoke-AzureRmDataFactoryV2Pipeline command starts a run on the specified pipeline and returns a ID for that run. This GUID can be passed to Get-AzureRmDataFactoryV2PipelineRun or Get-AzureRmDataFactoryV2ActivityRun to obtain further details about this run.
Examples
Example 1: Invoke a pipeline to start a run
PS C:\> Invoke-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineName "DPWikisample"
867d9d9f-1efc-4fee-974d-d8e6320bfbcbThis command starts a run for "DPWikisample" pipeline in the "WikiADF" factory.
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: | 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 |
-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 |
-ResourceGroupName
The resource group name.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| 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
Parameters: InputObject (ByValue)