< Back
Get-AzureRmDataFactoryV2Pipeline
Post
NAME Get-AzureRmDataFactoryV2Pipeline
SYNOPSIS
Gets information about pipelines in Data Factory.
SYNTAX
Get-AzureRmDataFactoryV2Pipeline [-DataFactory] <PSDataFactory> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmDataFactoryV2Pipeline [-DefaultProfile <IAzureContextContainer>] -ResourceId <String> [<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.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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.
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
-Name <String>
Specifies the name of the pipeline about which to get information.
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline, Microsoft.Azure.Commands.DataFactoryV2,
Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... v2pipeline
Set-AzureRmDataFactoryV2Pipeline
Remove-AzureRmDataFactoryV2Pipeline
Invoke-AzureRmDataFactoryV2Pipeline
SYNOPSIS
Gets information about pipelines in Data Factory.
SYNTAX
Get-AzureRmDataFactoryV2Pipeline [-DataFactory] <PSDataFactory> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmDataFactoryV2Pipeline [-DefaultProfile <IAzureContextContainer>] -ResourceId <String> [<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.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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.
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
-Name <String>
Specifies the name of the pipeline about which to get information.
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline, Microsoft.Azure.Commands.DataFactoryV2,
Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
Microsoft.Azure.Commands.DataFactoryV2.Models.PSPipeline
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... v2pipeline
Set-AzureRmDataFactoryV2Pipeline
Remove-AzureRmDataFactoryV2Pipeline
Invoke-AzureRmDataFactoryV2Pipeline