Share via

az data-transfer pipeline

  • 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 pipeline 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 pipeline commands.

Commands

Name Description Type Status
az data-transfer pipeline approve-connection

Approves the specified connection request in a pipeline.

 Extension Preview
az data-transfer pipeline list

List all the pipelines.

 Extension Preview
az data-transfer pipeline reject-connection

Rejects the specified connection request in a pipeline.

 Extension Preview
az data-transfer pipeline show

Get pipeline resource.

 Extension Preview

az data-transfer pipeline approve-connection

Preview

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

Approves the specified connection request in a pipeline.

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

Examples

Approves the specified connection in a pipeline

az data-transfer pipeline approve-connection --resource-group testRG --pipeline-name testPipeline --connection-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection --status-reason Example reason

Required Parameters

--connection-id --id

ID of the connection to be approved.

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.

--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
--name --pipeline-name -n

The name for the pipeline to perform the operation on.

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 pipeline list

Preview

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

List all the pipelines.

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

Examples

Gets pipelines in a subscription

az data-transfer pipeline list

Gets pipelines in a resource group

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

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
--resource-group -g

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

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 pipeline reject-connection

Preview

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

Rejects the specified connection request in a pipeline.

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

Examples

Rejects the specified connection in a pipeline

az azure-data-transfer pipeline reject-connection --resource-group testRG --pipeline-name testPipeline --connection-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection --status-reason Example reason

Required Parameters

--connection-id --id

ID of the connection to be rejected.

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.

--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
--name --pipeline-name -n

The name for the pipeline to perform the operation on.

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 pipeline show

Preview

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

Get pipeline resource.

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

Examples

Gets pipeline resource

az data-transfer pipeline show --resource-group testRG --pipeline-name testPipeline

Optional Parameters

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

--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
--name --pipeline-name -n

The name for the pipeline to perform the operation on.

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