Edit

Get-AzDataTransferConnection

Module:
Az.DataTransfer Module

Gets connection resource.

Syntax

List (Default) 

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

Get 

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

List1 

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

GetViaIdentity 

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

Description

Gets connection resource.

Examples

Example 1: Get a specified connection

Get-AzDataTransferConnection -ResourceGroupName ResourceGroup01 -Name Connection01

Approver                     :
DateSubmitted                :
Direction                    : Receive
FlowType                     : {Mission}
ForceDisabledStatus          :
Id                           : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/connections/Connection01
IdentityPrincipalId          :
IdentityTenantId             :
IdentityType                 : None
IdentityUserAssignedIdentity : {}
Justification                : Required for data processing
LinkStatus                   : Unlinked
LinkedConnectionId           :
Location                     : EastUS
Name                         : Connection01
Pin                          :
Pipeline                     : Pipeline01
Policy                       :
PrimaryContact               :
ProvisioningState            : Succeeded
RemoteSubscriptionId         :
RequirementId                : 0
ResourceGroupName            : ResourceGroup01
Schema                       :
SchemaUri                    :
SecondaryContact             :
Status                       : InReview
StatusReason                 :
SystemDataCreatedAt          : 6/10/2099 11:47:31 AM
SystemDataCreatedBy          : test@test.com
SystemDataCreatedByType      : User
SystemDataLastModifiedAt     : 6/10/2099 11:47:31 AM
SystemDataLastModifiedBy     : test@test.com
SystemDataLastModifiedByType : User
Tag                          : {
                                 "creationTime": "2099-06-10T11:47:28.6330313Z",
                                 "vteam": "Experience"
                               }
Type                         : microsoft.azuredatatransfer/connections

This example retrieves a specific connection named Connection01 within the resource group ResourceGroup01.

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

$connectionsInResourceGroup = Get-AzDataTransferConnection -ResourceGroupName ResourceGroup01

Approver                     :
DateSubmitted                :
Direction                    : Receive
FlowType                     : {Mission}
ForceDisabledStatus          :
Id                           : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/connections/Connection01
IdentityPrincipalId          :
IdentityTenantId             :
IdentityType                 : None
IdentityUserAssignedIdentity : {}
Justification                : Required for data processing
LinkStatus                   : Unlinked
LinkedConnectionId           :
Location                     : EastUS
Name                         : Connection01
Pin                          :
Pipeline                     : Pipeline01
Policy                       :
PrimaryContact               :
ProvisioningState            : Succeeded
RemoteSubscriptionId         :
RequirementId                : 0
ResourceGroupName            : ResourceGroup01
Schema                       :
SchemaUri                    :
SecondaryContact             :
Status                       : InReview
StatusReason                 :
SystemDataCreatedAt          : 6/10/2099 11:47:31 AM
SystemDataCreatedBy          : test@test.com
SystemDataCreatedByType      : User
SystemDataLastModifiedAt     : 6/10/2099 11:47:31 AM
SystemDataLastModifiedBy     : test@test.com
SystemDataLastModifiedByType : User
Tag                          : {
                                 "creationTime": "2099-06-10T11:47:28.6330313Z",
                                 "vteam": "Experience"
                               }
Type                         : microsoft.azuredatatransfer/connections

This example retrieves all connections in the resource group ResourceGroup01.

Example 3: Get a list of connections in a subscription

$connectionsInSubscription = Get-AzDataTransferConnection -SubscriptionId "00000000-0000-0000-0000-000000000000"

Approver                     :
DateSubmitted                :
Direction                    : Receive
FlowType                     : {Mission}
ForceDisabledStatus          :
Id                           : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/connections/Connection01
IdentityPrincipalId          :
IdentityTenantId             :
IdentityType                 : None
IdentityUserAssignedIdentity : {}
Justification                : Required for data processing
LinkStatus                   : Unlinked
LinkedConnectionId           :
Location                     : EastUS
Name                         : Connection01
Pin                          :
Pipeline                     : Pipeline01
Policy                       :
PrimaryContact               :
ProvisioningState            : Succeeded
RemoteSubscriptionId         :
RequirementId                : 0
ResourceGroupName            : ResourceGroup01
Schema                       :
SchemaUri                    :
SecondaryContact             :
Status                       : InReview
StatusReason                 :
SystemDataCreatedAt          : 6/10/2099 11:47:31 AM
SystemDataCreatedBy          : test@test.com
SystemDataCreatedByType      : User
SystemDataLastModifiedAt     : 6/10/2099 11:47:31 AM
SystemDataLastModifiedBy     : test@test.com
SystemDataLastModifiedByType : User
Tag                          : {
                                 "creationTime": "2099-06-10T11:47:28.6330313Z",
                                 "vteam": "Experience"
                               }
Type                         : microsoft.azuredatatransfer/connections

This example retrieves all connections 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 connection to perform the operation on.

Parameter properties

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

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

IConnection