Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureDataFactoryPipeline

Get-AzureDataFactoryPipeline

microsoft.azure.commands.datafactories.dll

Synopsis

Gets information about pipelines in Data Factory.

Syntax

Get-AzureDataFactoryPipeline [-ResourceGroupName] [-Name] [-DataFactoryName] [<CommonParameters>]

Get-AzureDataFactoryPipeline [-DataFactory] [-Name] [<CommonParameters>]

Detailed Description

The Get-AzureDataFactoryPipeline 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.

You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.

Parameters

-DataFactory <PSDataFactory>

Specifies a PSDataFactory object. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DataFactoryName <String>

Specifies the name of a data factory. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of the pipeline about which to get information.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ResourceGroupName <String>

Specifies the name of an Azure resource group. This cmdlet gets pipelines that belong to the group that this parameter specifies.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type

System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSPipeline, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] Microsoft.WindowsAzure.Commands.Utilities.PSPipeline

Notes

None

Examples

Example 1: Get information about all pipelines

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.

                    PS C:\> Get-AzureDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
                

Example 2: Get information about a specific pipeline

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.

                    PS C:\> Get-AzureDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List
                    PipelineName      : DPWikisample
                    ResourceGroupName : ADF
                    DataFactoryName   : WikiADF
                    Properties        : Microsoft.DataFactories.PipelineProperties
                

Example 3: Get the properties for a specific pipeline

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.

                    PS C:\> (Get-AzureDataFactoryPipeline -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
                

Example 4: Get the activities for a specific pipeline

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.

                    PS C:\> (Get-AzureDataFactoryPipeline -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
                

Example 5: Get the runtime information for a specific pipeline

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.

                    PS C:\> (Get-AzureDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.RuntimeInfo
                    DeploymentTime
                    --------------
                    6/5/2014 10:36:46 PM
                

Example 6: Get information about inputs for the first activity

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.

                    PS C:\> (Get-AzureDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Properties.Activities[0].Inputs | Format-List
                    EndTime   :
                    Length    :
                    Name      : DAWikipediaClickEvents
                    StartTime :
                

New-AzureDataFactoryPipeline
Remove-AzureDataFactoryPipeline
Resume-AzureDataFactoryPipeline
Set-AzureDataFactoryPipelineActivePeriod
Suspend-AzureDataFactoryPipeline