Get-AzDataFactoryPipeline
Gets information about pipelines in Azure Data Factory.
Syntax
ByFactoryName (Default)
Get-AzDataFactoryPipeline
[[-Name] <String>]
[-DataFactoryName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByFactoryObject
Get-AzDataFactoryPipeline
[[-Name] <String>]
[-DataFactory] <PSDataFactory>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzDataFactoryPipeline 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
Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
This command gets information about all pipelines in the data factory named WikiADF. You can 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
Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List
PipelineName : DPWikisample
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.DataFactories.PipelineProperties
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 cmdlet formats the results.
For more information, type Get-Help Format-List
.
Example 3: Get the properties for a specific pipeline
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Properties
Activities : {WikiHiveActivity, BlobToSqlCopyActivity}
Description : DP Wikipedia Sample Pipelines
End : 6/6/2014 8:00:00 AM
IsPaused :
RuntimeInfo : Microsoft.DataFactories.PipelineRuntimeInfo
Start : 6/5/2014 8:00:00 PM
This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Properties property associated with that pipeline.
Example 4: Get the activities for a specific pipeline
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.Activities
Transformation : Microsoft.DataFactories.HDInsightActivityProperties
Description :
Inputs : {DAWikipediaClickEvents}
LinkedServiceName : HDILinkedService
Name : WikiHiveActivity
Outputs : {DACuratedWikiData}
Policy : Microsoft.DataFactories.ActivityPolicy
Transformation : Microsoft.DataFactories.CopyActivityProperties
Description :
Inputs : {DACuratedWikiData}
LinkedServiceName : HDILinkedService
Name : BlobToSqlCopyActivity
Outputs : {DAWikiAggregatedData}
Policy : Microsoft.DataFactories.ActivityPolicy
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 5: Get the runtime information for a specific pipeline
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.RuntimeInfo
DeploymentTime
--------------
6/5/2014 10:36:46 PM
This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the RuntimeInfo property associated with that pipeline.
Example 6: Get information about inputs for the first activity
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Properties.Activities[0].Inputs | Format-List
EndTime :
Length :
Name : DAWikipediaClickEvents
StartTime :
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 Format-List.
Parameters
-DataFactory
Specifies a PSDataFactory object. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.
Parameter properties
Type: | PSDataFactory |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
ByFactoryObject
Position: | 0 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
-DataFactoryName
Specifies the name of a data factory. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
ByFactoryName
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 |
-Name
Specifies the name of the pipeline about which to get information.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 1 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of an Azure resource group. This cmdlet gets pipelines that belong to the group that this parameter specifies.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
ByFactoryName
Position: | 0 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | True |
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
String
PSDataFactory
Outputs
PSPipeline
Notes
- Keywords: azure, azurerm, arm, resource, management, manager, data, factories