az datafactory integration-runtime

  • Reference

Note

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

Manage integration runtime with datafactory.

Commands

Name Description Type Status
az datafactory integration-runtime delete

Deletes an integration runtime.

 Extension GA
az datafactory integration-runtime get-connection-info

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

 Extension GA
az datafactory integration-runtime get-monitoring-data

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

 Extension GA
az datafactory integration-runtime get-status

Gets detailed status information for an integration runtime.

 Extension GA
az datafactory integration-runtime linked-integration-runtime

Manage integration runtime with datafactory sub group linked-integration-runtime.

 Extension GA
az datafactory integration-runtime linked-integration-runtime create

Create a linked integration runtime entry in a shared integration runtime.

 Extension GA
az datafactory integration-runtime list

Lists integration runtimes.

 Extension GA
az datafactory integration-runtime list-auth-key

Retrieves the authentication keys for an integration runtime.

 Extension GA
az datafactory integration-runtime managed

Manage integration runtime with datafactory sub group managed.

 Extension GA
az datafactory integration-runtime managed create

Create an integration runtime.

 Extension GA
az datafactory integration-runtime regenerate-auth-key

Regenerates the authentication key for an integration runtime.

 Extension GA
az datafactory integration-runtime remove-link

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

 Extension GA
az datafactory integration-runtime self-hosted

Manage integration runtime with datafactory sub group self-hosted.

 Extension GA
az datafactory integration-runtime self-hosted create

Create an integration runtime.

 Extension GA
az datafactory integration-runtime show

Gets an integration runtime.

 Extension GA
az datafactory integration-runtime start

Starts a ManagedReserved type integration runtime.

 Extension GA
az datafactory integration-runtime stop

Stops a ManagedReserved type integration runtime.

 Extension GA
az datafactory integration-runtime sync-credentials

Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.

 Extension GA
az datafactory integration-runtime update

Updates an integration runtime.

 Extension GA
az datafactory integration-runtime upgrade

Upgrade self-hosted integration runtime to latest version if availability.

 Extension GA
az datafactory integration-runtime wait

Place the CLI in a waiting state until a condition of the datafactory integration-runtime is met.

 Extension GA

az datafactory integration-runtime delete

Deletes an integration runtime.

az datafactory integration-runtime delete [--factory-name]
                                          [--ids]
                                          [--integration-runtime-name]
                                          [--resource-group]
                                          [--subscription]
                                          [--yes]

Examples

IntegrationRuntimes_Delete

az datafactory integration-runtime delete --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime get-connection-info

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

az datafactory integration-runtime get-connection-info [--factory-name]
                                                       [--ids]
                                                       [--integration-runtime-name]
                                                       [--resource-group]
                                                       [--subscription]

Examples

IntegrationRuntimes_GetConnectionInfo

az datafactory integration-runtime get-connection-info --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime get-monitoring-data

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

az datafactory integration-runtime get-monitoring-data [--factory-name]
                                                       [--ids]
                                                       [--integration-runtime-name]
                                                       [--resource-group]
                                                       [--subscription]

Examples

IntegrationRuntimes_GetMonitoringData

az datafactory integration-runtime get-monitoring-data --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime get-status

Gets detailed status information for an integration runtime.

az datafactory integration-runtime get-status [--factory-name]
                                              [--ids]
                                              [--integration-runtime-name]
                                              [--resource-group]
                                              [--subscription]

Examples

IntegrationRuntimes_GetStatus

az datafactory integration-runtime get-status --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime list

Lists integration runtimes.

az datafactory integration-runtime list --factory-name
                                        --resource-group

Examples

IntegrationRuntimes_ListByFactory

az datafactory integration-runtime list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name

The factory name.

--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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime list-auth-key

Retrieves the authentication keys for an integration runtime.

az datafactory integration-runtime list-auth-key --factory-name
                                                 --integration-runtime-name
                                                 --resource-group

Examples

IntegrationRuntimes_ListAuthKeys

az datafactory integration-runtime list-auth-key --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name

The factory name.

--integration-runtime-name --name -n

The integration runtime name.

--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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime regenerate-auth-key

Regenerates the authentication key for an integration runtime.

az datafactory integration-runtime regenerate-auth-key [--factory-name]
                                                       [--ids]
                                                       [--integration-runtime-name]
                                                       [--key-name {authKey1, authKey2}]
                                                       [--resource-group]
                                                       [--subscription]

Examples

IntegrationRuntimes_RegenerateAuthKey

az datafactory integration-runtime regenerate-auth-key --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --key-name "authKey2" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--key-name

The name of the authentication key to regenerate.

accepted values: authKey1, authKey2
--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

az datafactory integration-runtime remove-link --linked-factory-name
                                               [--factory-name]
                                               [--ids]
                                               [--integration-runtime-name]
                                               [--resource-group]
                                               [--subscription]

IntegrationRuntimes_Upgrade

az datafactory integration-runtime remove-link --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --linked-factory-name "exampleFactoryName-linked" --resource-group "exampleResourceGroup"
--linked-factory-name

The data factory name for linked integration runtime.

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime show

Gets an integration runtime.

az datafactory integration-runtime show [--factory-name]
                                        [--ids]
                                        [--if-none-match]
                                        [--integration-runtime-name]
                                        [--resource-group]
                                        [--subscription]

Examples

IntegrationRuntimes_Get

az datafactory integration-runtime show --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--if-none-match

ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime start

Starts a ManagedReserved type integration runtime.

az datafactory integration-runtime start [--factory-name]
                                         [--ids]
                                         [--integration-runtime-name]
                                         [--no-wait]
                                         [--resource-group]
                                         [--subscription]

Examples

IntegrationRuntimes_Start

az datafactory integration-runtime start --factory-name "exampleFactoryName" --name "exampleManagedIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--no-wait

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

default value: False
--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime stop

Stops a ManagedReserved type integration runtime.

az datafactory integration-runtime stop [--factory-name]
                                        [--ids]
                                        [--integration-runtime-name]
                                        [--no-wait]
                                        [--resource-group]
                                        [--subscription]

Examples

IntegrationRuntimes_Stop

az datafactory integration-runtime stop --factory-name "exampleFactoryName" --name "exampleManagedIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--no-wait

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

default value: False
--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime sync-credentials

Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.

az datafactory integration-runtime sync-credentials [--factory-name]
                                                    [--ids]
                                                    [--integration-runtime-name]
                                                    [--resource-group]
                                                    [--subscription]

Examples

IntegrationRuntimes_SyncCredentials

az datafactory integration-runtime sync-credentials --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime update

Updates an integration runtime.

az datafactory integration-runtime update [--auto-update {Off, On}]
                                          [--factory-name]
                                          [--ids]
                                          [--integration-runtime-name]
                                          [--resource-group]
                                          [--subscription]
                                          [--update-delay-offset]

Examples

IntegrationRuntimes_Update

az datafactory integration-runtime update --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup" --auto-update "Off" --update-delay-offset "\"PT3H\""

Optional Parameters

--auto-update

Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189.

accepted values: Off, On
--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

--update-delay-offset

The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime upgrade

Upgrade self-hosted integration runtime to latest version if availability.

az datafactory integration-runtime upgrade [--factory-name]
                                           [--ids]
                                           [--integration-runtime-name]
                                           [--resource-group]
                                           [--subscription]

Examples

IntegrationRuntimes_Upgrade

az datafactory integration-runtime upgrade --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

--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.

--integration-runtime-name --name -n

The integration runtime name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory integration-runtime wait

Place the CLI in a waiting state until a condition of the datafactory integration-runtime is met.

az datafactory integration-runtime wait [--created]
                                        [--custom]
                                        [--deleted]
                                        [--exists]
                                        [--factory-name]
                                        [--ids]
                                        [--if-none-match]
                                        [--integration-runtime-name]
                                        [--interval]
                                        [--resource-group]
                                        [--subscription]
                                        [--timeout]
                                        [--updated]

Examples

Pause executing next line of CLI script until the datafactory integration-runtime is successfully created.

az datafactory integration-runtime wait --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup" --created

Optional Parameters

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--factory-name

The factory name.

--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.

--if-none-match

ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

--integration-runtime-name --name -n

The integration runtime name.

--interval

Polling interval in seconds.

default value: 30
--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.