Get-AzDataTransferPendingFlow

Module:

Az.DataTransfer Module

Lists all remote flows that have not yet been linked to local flows

Syntax

Default (Default)

Get-AzDataTransferPendingFlow
    -ConnectionName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Lists all remote flows that have not yet been linked to local flows

Examples

Example 1: List all pending flows for a specific connection

$pendingFlows = Get-AzDataTransferPendingFlow -ResourceGroupName ResourceGroup01 -ConnectionName Connection01

ApiFlowOptionApiMode                   :
ApiFlowOptionAudienceOverride          :
ApiFlowOptionCname                     :
ApiFlowOptionIdentityTranslation       :
ApiFlowOptionRemoteCallingModeClientId :
ApiFlowOptionRemoteEndpoint            :
ApiFlowOptionSenderClientId            :
ConnectionId                           :
ConnectionLocation                     :
ConnectionName                         :
ConnectionSubscriptionName             :
ConsumerGroup                          :
CustomerManagedKeyVaultUri             :
DataType                               : Blob
DestinationEndpoint                    :
DestinationEndpointPort                :
EventHubId                             :
FlowId                                 : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
FlowType                               : Mission
ForceDisabledStatus                    :
Id                                     : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/connections/Connection02/flows/Flow02
KeyVaultUri                            :
LinkStatus                             :
LinkedFlowId                           :
Location                               : eastus
MessagingOptionBillingTier             :
Name                                   : Flow02
Passphrase                             :
Policy                                 :
ProvisioningState                      :
SchemaConnectionId                     :
SchemaContent                          :
SchemaDirection                        :
SchemaId                               :
SchemaName                             :
SchemaStatus                           :
SchemaType                             :
SchemaUri                              :
SelectedResourceId                     :
ServiceBusQueueId                      :
SourceAddressSourceAddresses           :
Status                                 :
StorageAccountId                       :
StorageAccountName                     :
StorageContainerName                   :
StorageTableName                       :
StreamId                               :
StreamLatency                          :
StreamProtocol                         :
SubscriptionId                         : 00000000-0000-0000-0000-000000000000
SystemDataCreatedAt                    :
SystemDataCreatedBy                    :
SystemDataCreatedByType                :
SystemDataLastModifiedAt               :
SystemDataLastModifiedBy               :
SystemDataLastModifiedByType           :
Tag                                    : {}
Type                                   : microsoft.azuredatatransfer/connections/flows

This example lists all pending flows on send side for the receive side connection Connection01 within the resource group ResourceGroup01.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
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

(All)

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

-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

(All)

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

(All)

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

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.

Outputs

IPendingFlow