az data-transfer connection

Preview

Note

This reference is part of the data-transfer extension for the Azure CLI (version 2.0.24 or higher). The extension will automatically install the first time you run an az data-transfer connection command. Learn more about extensions.

Command group 'az data-transfer' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Data transfer connection commands.

Commands

Name	Description	Type	Status
az data-transfer connection create	Create the connection resource.	Extension	Preview
az data-transfer connection delete	Delete the connection resource.	Extension	Preview
az data-transfer connection flow	Data transfer flow commands.	Extension	Preview
az data-transfer connection flow create	Create data flow for the approved connection.	Extension	Preview
az data-transfer connection flow delete	Delete data flow for the approved connection.	Extension	Preview
az data-transfer connection flow disable	Disables the specified flow in the connection.	Extension	Preview
az data-transfer connection flow enable	Enables the specified flow in the connection.	Extension	Preview
az data-transfer connection flow link	Links the specified flow in the connection.	Extension	Preview
az data-transfer connection flow list	List all the flows in a connection.	Extension	Preview
az data-transfer connection flow show	Show a specific flow in the connection.	Extension	Preview
az data-transfer connection flow update	Update the flow resource.	Extension	Preview
az data-transfer connection flow wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az data-transfer connection link	Links the connection to its pending connection.	Extension	Preview
az data-transfer connection list	List all the connections.	Extension	Preview
az data-transfer connection list-pending-connection	Lists all pending remote connections that are linkable to this connection.	Extension	Preview
az data-transfer connection list-pending-flow	List all pending flows for linking to a receive flow.	Extension	Preview
az data-transfer connection show	Get connection resource.	Extension	Preview
az data-transfer connection update	Update the connection resource.	Extension	Preview
az data-transfer connection wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az data-transfer connection create

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the connection resource.

az data-transfer connection create --connection --connection-name --name
                                   --resource-group
                                   [--direction {Receive, Send}]
                                   [--flow-types]
                                   [--justification]
                                   [--location]
                                   [--mi-system-assigned --system-assigned]
                                   [--mi-user-assigned --user-assigned]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--pin]
                                   [--pipeline]
                                   [--primary-contact]
                                   [--remote-subscription-id]
                                   [--requirement-id]
                                   [--schema-uris]
                                   [--schemas]
                                   [--secondary-contacts]
                                   [--tags]

Examples

Creates a receive side connection

az data-transfer connection create --resource-group testRG --connection-name testConnection --flow-types Mission API --location eastus --justification justification --pipeline testdc --requirement-id id --direction Receive --remote-subscription-id 00000000-0000-0000-0000-000000000000
az data-transfer connection create --resource-group testRG --connection-name testConnection --flow-types ["Mission", "API"] --location eastus --justification justification --pipeline testdc --requirement-id id --direction Receive --remote-subscription-id 00000000-0000-0000-0000-000000000000

Creates a send side connection

az data-transfer connection create --resource-group testRG --connection-name testConnection --location eastus --pipeline testdc --pin '$-pe3' --flow-types Api Mission --direction Send
az data-transfer connection create --resource-group testRG --connection-name testConnection --location 'East US' --pipeline testdc --pin 12345 --flow-types Api Mission --direction Send

Required Parameters

--connection --connection-name --name -n

The name for the connection to perform the operation on.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--direction

Direction of data movement. Allowed values: Receive, Send.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Receive, Send

--flow-types

The flow types being requested for this connection Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--justification

Justification for the connection request.

Property	Value
Parameter group:	Properties Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Connection Arguments

--mi-system-assigned --system-assigned

Set the system managed identity.

Property	Value
Parameter group:	Identity Arguments

--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Identity Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--pin

PIN to link requests together.

Property	Value
Parameter group:	Properties Arguments

--pipeline

Pipeline to use to transfer data.

Property	Value
Parameter group:	Properties Arguments

--primary-contact

The primary contact for this connection request.

Property	Value
Parameter group:	Properties Arguments

--remote-subscription-id

Subscription ID to link cloud subscriptions together.

Property	Value
Parameter group:	Properties Arguments

--requirement-id

Requirement ID of the connection.

Property	Value
Parameter group:	Properties Arguments

--schema-uris

The schema URIs for this connection Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--schemas

The schemas for this connection Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--secondary-contacts

The secondary contacts for this connection request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Connection Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az data-transfer connection delete

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the connection resource.

Deletes the connection specified by ids or by name and resource group.

az data-transfer connection delete [--connection-name --name]
                                   [--ids]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Examples

Deletes the connection resource

az data-transfer connection delete --resource-group testRG --connection-name testConnection
az data-transfer connection delete --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-name --name -n

The name for the connection to perform the operation on.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az data-transfer connection link

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Links the connection to its pending connection.

az data-transfer connection link --id --pending-connection-id
                                 [--connection-name --name]
                                 [--ids]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--status-reason]
                                 [--subscription]

Examples

Links the specified connection

az data-transfer connection link --resource-group testRG --connection-name receiveConnection --pending-connection-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/sendConnection
az data-transfer connection link --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/recieveConnection  --pending-connection-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/sendConnection

Required Parameters

--id --pending-connection-id

ID of the Send side connection to link.

Property	Value
Parameter group:	Connection Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-name --name -n

Name of the connection for linking(Receive side).

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--status-reason

Reason for resource operation.

Property	Value
Parameter group:	Connection Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az data-transfer connection list

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the connections.

az data-transfer connection list --resource-group
                                 [--max-items]
                                 [--next-token]

Examples

Gets connections in a resource group

az data-transfer connection list --resource-group testRG

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az data-transfer connection list-pending-connection

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists all pending remote connections that are linkable to this connection.

az data-transfer connection list-pending-connection --connection-name --name
                                                    --resource-group
                                                    [--max-items]
                                                    [--next-token]

Examples

Lists a list of pending connections

az data-transfer connection list-pending-connection --resource-group testRG --connection-name testConnection

Required Parameters

--connection-name --name -n

The name for the connection to perform the operation on.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az data-transfer connection list-pending-flow

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all pending flows for linking to a receive flow.

az data-transfer connection list-pending-flow --connection-name
                                              --resource-group
                                              [--max-items]
                                              [--next-token]

Examples

Lists a list of pending flows

az data-transfer connection list-pending-flow --resource-group testRG --connection-name testConnection

Required Parameters

--connection-name

The name for the connection to perform the operation on.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az data-transfer connection show

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get connection resource.

Get connection with specified ids or name.

az data-transfer connection show [--connection-name --name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Examples

Gets connection resource

az data-transfer connection show --resource-group testRG --connection-name testConnection
az data-transfer connection show --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-name --name -n

The name for the connection to perform the operation on.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az data-transfer connection update

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the connection resource.

az data-transfer connection update [--connection-name --name]
                                   [--ids]
                                   [--mi-system-assigned --system-assigned]
                                   [--mi-user-assigned --user-assigned]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--resource-group]
                                   [--subscription]
                                   [--tags]

Examples

Update the given connection

az data-transfer connection update --name connectionName --resourceGroup testRG --tags key1=value1 key2=value2

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-name --name -n

The name for the connection to perform the operation on.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--mi-system-assigned --system-assigned

Set the system managed identity.

Property	Value
Parameter group:	Identity Arguments

--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Identity Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Connection Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az data-transfer connection wait

Preview

Command group 'az data-transfer connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az data-transfer connection wait [--connection-name --name]
                                 [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-name --name -n

The name for the connection to perform the operation on.

Property	Value
Parameter group:	Resource Id Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Share via

az data-transfer connection

Commands

az data-transfer connection create

Examples

Required Parameters

Optional Parameters

az data-transfer connection delete

Examples

Optional Parameters

az data-transfer connection link

Examples

Required Parameters

Optional Parameters

az data-transfer connection list

Examples

Required Parameters

Optional Parameters

az data-transfer connection list-pending-connection

Examples

Required Parameters

Optional Parameters

az data-transfer connection list-pending-flow

Examples

Required Parameters

Optional Parameters

az data-transfer connection show

Examples

Optional Parameters

az data-transfer connection update

Examples

Optional Parameters

az data-transfer connection wait

Optional Parameters

Feedback