Invoke-AzDataTransferLinkPendingFlow
Links the specified flow.
Syntax
LinkExpanded (Default)
Invoke-AzDataTransferLinkPendingFlow
-ConnectionName <String>
-FlowName <String>
-ResourceGroupName <String>
-PendingFlowId <String>
[-SubscriptionId <String>]
[-StatusReason <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LinkViaJsonString
Invoke-AzDataTransferLinkPendingFlow
-ConnectionName <String>
-FlowName <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LinkViaJsonFilePath
Invoke-AzDataTransferLinkPendingFlow
-ConnectionName <String>
-FlowName <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Link
Invoke-AzDataTransferLinkPendingFlow
-ConnectionName <String>
-FlowName <String>
-ResourceGroupName <String>
-Flow <IResourceBody>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LinkViaIdentityConnectionExpanded
Invoke-AzDataTransferLinkPendingFlow
-FlowName <String>
-ConnectionInputObject <IDataTransferIdentity>
-PendingFlowId <String>
[-StatusReason <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LinkViaIdentityConnection
Invoke-AzDataTransferLinkPendingFlow
-FlowName <String>
-ConnectionInputObject <IDataTransferIdentity>
-Flow <IResourceBody>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LinkViaIdentityExpanded
Invoke-AzDataTransferLinkPendingFlow
-InputObject <IDataTransferIdentity>
-PendingFlowId <String>
[-StatusReason <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LinkViaIdentity
Invoke-AzDataTransferLinkPendingFlow
-InputObject <IDataTransferIdentity>
-Flow <IResourceBody>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Links the specified flow.
Examples
Example 1: Link a pending flow by ID
$sendFlow = Get-AzDataTransferFlow -ResourceGroupName ResourceGroup01 -ConnectionName SendConnection01 -FlowName SendFlow01
Invoke-AzDataTransferLinkPendingFlow -ResourceGroupName ResourceGroup02 -ConnectionName ReceiveConnection01 -FlowName ReceiveFlow01 -PendingFlowId $sendFlow.Id -StatusReason "Linking approved" -Confirm:$false
ApiFlowOptionApiMode :
ApiFlowOptionAudienceOverride :
ApiFlowOptionCname :
ApiFlowOptionIdentityTranslation :
ApiFlowOptionRemoteCallingModeClientId :
ApiFlowOptionRemoteEndpoint :
ApiFlowOptionSenderClientId :
ConnectionId :
ConnectionLocation :
ConnectionName :
ConnectionSubscriptionName :
ConsumerGroup :
CustomerManagedKeyVaultUri :
DataType : Blob
DestinationEndpoint :
DestinationEndpointPort :
EventHubId :
FlowId : 00000000-0000-0000-0000-000000000000
FlowType : Mission
ForceDisabledStatus :
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup02/providers/Microsoft.AzureDataTransfer/connections/ReceiveConnection01/flows/ReceiveFlow01
IdentityPrincipalId :
IdentityTenantId :
IdentityType : None
IdentityUserAssignedIdentity : {}
KeyVaultUri :
LinkStatus : Linked
LinkedFlowId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/connections/SendConnection01/flows/SendFlow01
Location : eastus
MessagingOptionBillingTier :
Name : ReceiveFlow01
Passphrase :
PlanName :
PlanProduct :
PlanPromotionCode :
PlanPublisher :
PlanVersion :
Policy :
ProvisioningState : Succeeded
ResourceGroupName : ResourceGroup02
SchemaConnectionId :
SchemaContent :
SchemaDirection :
SchemaId :
SchemaName :
SchemaStatus :
SchemaType :
SchemaUri :
ServiceBusQueueId :
SourceAddressSourceAddresses :
Status : Enabled
StorageAccountId :
StorageAccountName : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup03/providers/Microsoft.Storage/storageAccounts/test
StorageContainerName : test-container
StorageTableName :
StreamId :
StreamLatency :
StreamProtocol :
SystemDataCreatedAt : 5/30/2099 10:06:51 AM
SystemDataCreatedBy : test@test.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 6/11/2099 6:07:36 AM
SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType : Application
Tag : {
"creationTime": "2099-05-30T10:06:48.5223272Z",
"vteam": "Experience"
}
Type : microsoft.azuredatatransfer/connections/flows
This example links a pending send side flow with the naem SendFlow01 to the receive side flow ReceiveFlow01 in the connection ReceiveConnection01 within the resource group ResourceGroup02 and provides a status reason.
Parameters
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None 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
-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
Identity Parameter
LinkViaIdentityConnectionExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentityConnection
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
LinkExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Link
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
-Flow
The resource to reference.
Parameter properties
Type: IResourceBody
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Link
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentityConnection
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-FlowName
The name for the flow to perform the operation on.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
LinkExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Link
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentityConnectionExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentityConnection
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
LinkViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Link operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
LinkViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Link operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
LinkViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None 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
-PendingFlowId
ID of the resource.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
LinkExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentityConnectionExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentityExpanded
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
LinkExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Link
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StatusReason
Reason for resource operation.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
LinkExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentityConnectionExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaIdentityExpanded
Position: Named Mandatory: False 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
LinkExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
LinkViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Link
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
