Get-AzureRmDataFactoryV2Pipeline
Gets information about pipelines in Data Factory.
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
Get-AzureRmDataFactoryV2Pipeline
[[-Name] <String>]
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2Pipeline
[[-Name] <String>]
[-DataFactory] <PSDataFactory>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2Pipeline
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmDataFactoryV2Pipeline cmdlet gets information about pipelines in Azure Data Factory. If you specify the name of a pipeline, this cmdlet gets information about that pipeline. If you do not specify a name, this cmdlet gets information about all the pipelines in the data factory.
Examples
Example 1: Get information about all pipelines
PS C:\> Get-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
PipelineName : DPWikisample
ResourceGroupName : ADF
DataFactoryName : WikiADF
Activities : {MyWebActivity}
Parameters : {[url, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]}
PipelineName : DPTwittersample
ResourceGroupName : ADF
DataFactoryName : WikiADF
Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0}
Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]}
This command gets information about all pipelines in the data factory named WikiADF. You can use either one of the following example commands. The second one uses a DataFactory object as a parameter.
Example 2: Get information about a specific pipeline
PS C:\> Get-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List
PipelineName : DPWikisample
ResourceGroupName : ADF
DataFactoryName : WikiADF
Activities : {MyCopyActivity_0_0, MyCopyActivity_1_0}
Parameters : {[OutputBlobName, Microsoft.Azure.Management.DataFactory.Models.ParameterSpecification]}
This command gets information about the pipeline named DPWikisample in the data factory named WikiADF. The command passes that information to the Format-List cmdlet by using the pipeline operator. That Windows PowerShell cmdlet formats the results. For more information, type Get-Help Format-List.
Example 3: Get the properties for a specific pipeline
PS C:\> (Get-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Activities
Source : Microsoft.Azure.Management.DataFactory.Models.BlobSource
Sink : Microsoft.Azure.Management.DataFactory.Models.BlobSink
Translator :
EnableStaging :
StagingSettings :
ParallelCopies :
CloudDataMovementUnits :
EnableSkipIncompatibleRow :
RedirectIncompatibleRowSettings :
Inputs : {}
Outputs : {}
LinkedServiceName :
Policy :
Name : MyCopyActivity_0_0
Description :
DependsOn :
Source : Microsoft.Azure.Management.DataFactory.Models.BlobSource
Sink : Microsoft.Azure.Management.DataFactory.Models.BlobSink
Translator :
EnableStaging :
StagingSettings :
ParallelCopies :
CloudDataMovementUnits :
EnableSkipIncompatibleRow :
RedirectIncompatibleRowSettings :
Inputs : {}
Outputs : {}
LinkedServiceName :
Policy :
Name : MyCopyActivity_1_0
Description :
DependsOn : {Microsoft.Azure.Management.DataFactory.Models.ActivityDependency}
This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Activities property associated with that pipeline.
Example 6: Get information about inputs for the first activity
PS C:\> (Get-AzureRmDataFactoryV2Pipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Activities[0].Inputs | Format-List
ReferenceName : dsIn
Parameters :
This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Activities property associated with that pipeline. The command displays the Inputs property of the first element of the Activities array by using the Format-List cmdlet.
Parameters
-DataFactory
Specifies a PSDataFactory object. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.
Type: | PSDataFactory |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DataFactoryName
Specifies the name of a data factory. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.
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 |
-Name
Specifies the name of the pipeline about which to get information.
Type: | String |
Aliases: | PipelineName |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of an Azure resource group. This cmdlet gets pipelines that belong to the group that this parameter specifies.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceId
The Azure resource ID.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Parameters: DataFactory (ByValue)
Outputs
Notes
Keywords: azure, azurerm, arm, resource, management, manager, data, factories