Edit

Get-AzDataTransferFlow

Module:
Az.DataTransfer Module

Gets flow resource.

Syntax

List (Default) 

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

Get 

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

GetViaIdentityConnection 

Get-AzDataTransferFlow
    -Name <String>
    -ConnectionInputObject <IDataTransferIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

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

Description

Gets flow resource.

Examples

Example 1: Get a specified flow

Get-AzDataTransferFlow -ResourceGroupName ResourceGroup01 -ConnectionName Connection01 -Name Flow01

CustomerManagedKeyVaultUri         :
DataType                           : Blob
DestinationEndpoint                :
DestinationEndpointPort            :
FlowId                             : 00000000-0000-0000-0000-000000000000
FlowType                           : Mission
Id                                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/connections/Connection01/flows/Flow01
IdentityPrincipalId                :
IdentityTenantId                   :
IdentityType                       : None
IdentityUserAssignedIdentity       : {}
KeyVaultUri                        :
LinkStatus                         : Linked
LinkedFlowId                       : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup02/providers/Microsoft.AzureDataTransfer/connections/Connection02/flows/flow02
Location                           : westcentralus
MessagingOptionBillingTier         :
Name                               : Flow01
Passphrase                         :
PlanName                           :
PlanProduct                        :
PlanPromotionCode                  :
PlanPublisher                      :
PlanVersion                        :
Policy                             :
ProvisioningState                  : Succeeded
ResourceGroupName                  : ResourceGroup01
SchemaConnectionId                 :
SchemaContent                      :
SchemaDirection                    :
SchemaId                           :
SchemaName                         :
SchemaStatus                       :
SchemaType                         :
SchemaUri                          :
ServiceBusQueueId                  :
SourceAddressList                  :
Status                             : Enabled
StorageAccountId                   :
StorageAccountName                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupStorage/providers/Microsoft.Storage/storageAccounts/test
StorageContainerName               : test-container
StreamId                           :
StreamLatency                      :
StreamProtocol                     :
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           : 3/20/2025 11:25:07 AM
SystemDataLastModifiedBy           : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType       : Application
Tag                                : {}
Type                               : Microsoft.azuredatatransfer/connections/flows

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

Example 2: Get a list of flows in a connection

Get-AzDataTransferFlow -ResourceGroupName ResourceGroup01 -ConnectionName Connection01

CustomerManagedKeyVaultUri         :
DataType                           : Blob
DestinationEndpoint                :
DestinationEndpointPort            :
FlowId                             : 00000000-0000-0000-0000-000000000000
FlowType                           : Mission
Id                                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/connections/Connection01/flows/Flow01
IdentityPrincipalId                :
IdentityTenantId                   :
IdentityType                       : None
IdentityUserAssignedIdentity       : {}
KeyVaultUri                        :
LinkStatus                         : Linked
LinkedFlowId                       : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup02/providers/Microsoft.AzureDataTransfer/connections/Connection02/flows/flow02
Location                           : westcentralus
MessagingOptionBillingTier         :
Name                               : Flow01
Passphrase                         :
PlanName                           :
PlanProduct                        :
PlanPromotionCode                  :
PlanPublisher                      :
PlanVersion                        :
Policy                             :
ProvisioningState                  : Succeeded
ResourceGroupName                  : ResourceGroup01
SchemaConnectionId                 :
SchemaContent                      :
SchemaDirection                    :
SchemaId                           :
SchemaName                         :
SchemaStatus                       :
SchemaType                         :
SchemaUri                          :
ServiceBusQueueId                  :
SourceAddressList                  :
Status                             : Enabled
StorageAccountId                   :
StorageAccountName                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroupStorage/providers/Microsoft.Storage/storageAccounts/test
StorageContainerName               : test-container
StreamId                           :
StreamLatency                      :
StreamProtocol                     :
SystemDataCreatedAt                :
SystemDataCreatedBy                :
SystemDataCreatedByType            :
SystemDataLastModifiedAt           : 3/20/2025 11:25:07 AM
SystemDataLastModifiedBy           : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType       : Application
Tag                                : {}
Type                               : Microsoft.azuredatatransfer/connections/flows

This example retrieves all flows in the connection Connection01 within the resource group ResourceGroup01.

Parameters

-ConnectionInputObject

Identity Parameter

Parameter properties

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

Parameter sets

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

-ConnectionName

The name for the connection to perform the operation on.

Parameter properties

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

Parameter sets

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

-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 flow to perform the operation on.

Parameter properties

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

Parameter sets

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

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

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

IFlow