Edit

Get-AzDataTransferPipeline

Module:
Az.DataTransfer Module

Gets pipeline resource.

Syntax

List (Default) 

Get-AzDataTransferPipeline
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzDataTransferPipeline
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1 

Get-AzDataTransferPipeline
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzDataTransferPipeline
    -InputObject <IDataTransferIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Gets pipeline resource.

Examples

Example 1: Get a specified pipeline

$pipeline01 = Get-AzDataTransferPipeline -ResourceGroupName ResourceGroup01 -Name Pipeline01

Connection                         : {}
DisabledFlowType                   :
DisplayName                        :
FlowType                           : {Complex, Mission, Messaging, API}
Id                                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/Pipelines/Pipeline01
IdentityPrincipalId                :
IdentityTenantId                   :
IdentityType                       : None
IdentityUserAssignedIdentity       : {}
Location                           : eastus
Name                               : Pipeline01
Policy                             :
ProvisioningState                  : Succeeded
QuarantineDownloadStorageAccount   :
QuarantineDownloadStorageContainer :
RemoteCloud                        : Pipeline01
ResourceGroupName                  : ResourceGroup01
Status                             :
Subscriber                         :
SystemDataCreatedAt                : 5/23/2099 8:24:10 PM
SystemDataCreatedBy                : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
SystemDataCreatedByType            : Application
SystemDataLastModifiedAt           : 6/10/2099 4:59:58 PM
SystemDataLastModifiedBy           : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
SystemDataLastModifiedByType       : Application
Tag                                : {}
Type                               : microsoft.azuredatatransfer/pipelines

This example retrieves a specific pipeline named Pipeline01 within the resource group ResourceGroup01.

Example 2: Get a list of pipelines in a resource group

$pipelinesInResourceGroup = Get-AzDataTransferPipeline -ResourceGroupName ResourceGroup01

Connection                         : {}
DisabledFlowType                   :
DisplayName                        :
FlowType                           : {Complex, Mission, Messaging, API}
Id                                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/Pipelines/Pipeline01
IdentityPrincipalId                :
IdentityTenantId                   :
IdentityType                       : None
IdentityUserAssignedIdentity       : {}
Location                           : eastus
Name                               : Pipeline01
Policy                             :
ProvisioningState                  : Succeeded
QuarantineDownloadStorageAccount   :
QuarantineDownloadStorageContainer :
RemoteCloud                        : Pipeline01
ResourceGroupName                  : ResourceGroup01
Status                             :
Subscriber                         :
SystemDataCreatedAt                : 5/23/2099 8:24:10 PM
SystemDataCreatedBy                : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
SystemDataCreatedByType            : Application
SystemDataLastModifiedAt           : 6/10/2099 4:59:58 PM
SystemDataLastModifiedBy           : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
SystemDataLastModifiedByType       : Application
Tag                                : {}
Type                               : microsoft.azuredatatransfer/pipelines

This example retrieves all pipelines in the resource group ResourceGroup01.

Example 3: Get a list of pipelines in a subscription

$pipelinesInSubscription = Get-AzDataTransferPipeline -SubscriptionId "00000000-0000-0000-0000-000000000000"

Connection                         : {}
DisabledFlowType                   :
DisplayName                        :
FlowType                           : {Complex, Mission, Messaging, API}
Id                                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/Pipelines/Pipeline01
IdentityPrincipalId                :
IdentityTenantId                   :
IdentityType                       : None
IdentityUserAssignedIdentity       : {}
Location                           : eastus
Name                               : Pipeline01
Policy                             :
ProvisioningState                  : Succeeded
QuarantineDownloadStorageAccount   :
QuarantineDownloadStorageContainer :
RemoteCloud                        : Pipeline01
ResourceGroupName                  : ResourceGroup01
Status                             :
Subscriber                         :
SystemDataCreatedAt                : 5/23/2099 8:24:10 PM
SystemDataCreatedBy                : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
SystemDataCreatedByType            : Application
SystemDataLastModifiedAt           : 6/10/2099 4:59:58 PM
SystemDataLastModifiedBy           : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
SystemDataLastModifiedByType       : Application
Tag                                : {}
Type                               : microsoft.azuredatatransfer/pipelines

This example retrieves all pipelines in the subscription with the ID 00000000-0000-0000-0000-000000000000.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases: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

-InputObject

Identity Parameter

Parameter properties

Type:IDataTransferIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name for the pipeline to perform the operation on.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PipelineName

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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

IDataTransferIdentity

Outputs

IPipeline