< Back
Invoke-AzureRmDataFactoryV2Pipeline
Post
NAME Invoke-AzureRmDataFactoryV2Pipeline
SYNOPSIS
Invokes a pipeline to start a run for it.
SYNTAX
Invoke-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> [-PipelineName] <String> [[-ParameterFile] <String>]
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> [-PipelineName] <String> [[-Parameter] <Hashtable>]
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-ParameterFile] <String>] [-DefaultProfile <IAzureContextContainer>] [-Confirm]
[-WhatIf] [<CommonParameters>]
Invoke-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-Parameter] <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-Confirm]
[-WhatIf] [<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.
PARAMETERS
-DataFactoryName <String>
The data factory name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSPipeline>
The data factory object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Parameter <Hashtable>
Parameters for pipeline run.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ParameterFile <String>
The name of the file with parameters for pipeline run.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PipelineName <String>
The pipeline name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what happens if the cmdlet runs, but doesn't run the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline
System.String System.Collections.Hashtable
OUTPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline
NOTES
Example 1: Invoke a pipeline to start a run
PS C:\\> Invoke-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineName "DPWikisample"
867d9d9f-1efc-4fee-974d-d8e6320bfbcb
This command starts a run for "DPWikisample" pipeline in the "WikiADF" factory.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... v2pipeline
Get-AzureRmDataFactoryV2PipelineRun
Get-AzureRmDataFactoryV2ActivityRun
SYNOPSIS
Invokes a pipeline to start a run for it.
SYNTAX
Invoke-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> [-PipelineName] <String> [[-ParameterFile] <String>]
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> [-PipelineName] <String> [[-Parameter] <Hashtable>]
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-ParameterFile] <String>] [-DefaultProfile <IAzureContextContainer>] [-Confirm]
[-WhatIf] [<CommonParameters>]
Invoke-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-Parameter] <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-Confirm]
[-WhatIf] [<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.
PARAMETERS
-DataFactoryName <String>
The data factory name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSPipeline>
The data factory object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Parameter <Hashtable>
Parameters for pipeline run.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ParameterFile <String>
The name of the file with parameters for pipeline run.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PipelineName <String>
The pipeline name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what happens if the cmdlet runs, but doesn't run the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline
System.String System.Collections.Hashtable
OUTPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline
NOTES
Example 1: Invoke a pipeline to start a run
PS C:\\> Invoke-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -PipelineName "DPWikisample"
867d9d9f-1efc-4fee-974d-d8e6320bfbcb
This command starts a run for "DPWikisample" pipeline in the "WikiADF" factory.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... v2pipeline
Get-AzureRmDataFactoryV2PipelineRun
Get-AzureRmDataFactoryV2ActivityRun