az connection

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Commands to manage Service Connector local connections which allow local environment to connect Azure Resource. If you want to manage connection for compute service, please run 'az webapp/containerapp/spring connection'.

Commands

Name	Description	Type	Status
az connection create	Create a connection from local to a target resource.	Core and Extension	GA
az connection create app-insights	Create a Service Connector local connection to app-insights.	Core	GA
az connection create appconfig	Create a Service Connector local connection to appconfig.	Core	GA
az connection create confluent-cloud	Create a local connection to confluent-cloud.	Core	GA
az connection create cosmos-cassandra	Create a Service Connector local connection to cosmos-cassandra.	Core	GA
az connection create cosmos-gremlin	Create a Service Connector local connection to cosmos-gremlin.	Core	GA
az connection create cosmos-mongo	Create a Service Connector local connection to cosmos-mongo.	Core	GA
az connection create cosmos-sql	Create a Service Connector local connection to cosmos-sql.	Core	GA
az connection create cosmos-table	Create a Service Connector local connection to cosmos-table.	Core	GA
az connection create eventhub	Create a Service Connector local connection to eventhub.	Core	GA
az connection create keyvault	Create a Service Connector local connection to keyvault.	Core	GA
az connection create mysql	Create a Service Connector local connection to mysql.	Core	GA
az connection create mysql-flexible	Create a Service Connector local connection to mysql-flexible.	Core	GA
az connection create mysql-flexible (serviceconnector-passwordless extension)	Create a Service Connector local connection to mysql-flexible.	Extension	GA
az connection create postgres	Create a Service Connector local connection to postgres.	Core	GA
az connection create postgres (serviceconnector-passwordless extension)	Create a Service Connector local connection to postgres.	Extension	GA
az connection create postgres-flexible	Create a Service Connector local connection to postgres-flexible.	Core	GA
az connection create postgres-flexible (serviceconnector-passwordless extension)	Create a Service Connector local connection to postgres-flexible.	Extension	GA
az connection create redis	Create a Service Connector local connection to redis.	Core	GA
az connection create redis-enterprise	Create a Service Connector local connection to redis-enterprise.	Core	GA
az connection create servicebus	Create a Service Connector local connection to servicebus.	Core	GA
az connection create signalr	Create a Service Connector local connection to signalr.	Core	GA
az connection create sql	Create a Service Connector local connection to sql.	Core	GA
az connection create sql (serviceconnector-passwordless extension)	Create a Service Connector local connection to sql.	Extension	GA
az connection create storage-blob	Create a Service Connector local connection to storage-blob.	Core	GA
az connection create storage-file	Create a Service Connector local connection to storage-file.	Core	GA
az connection create storage-queue	Create a Service Connector local connection to storage-queue.	Core	GA
az connection create storage-table	Create a Service Connector local connection to storage-table.	Core	GA
az connection create webpubsub	Create a Service Connector local connection to webpubsub.	Core	GA
az connection delete	Delete a Service Connector local connection.	Core	GA
az connection generate-configuration	Generate configurations of a Service Connector local connection. The result should be put to application configuration file or set as environment variables.	Core	GA
az connection list	List local connections of Service Connector.	Core	GA
az connection list-support-types	List client types and auth types supported by local connections.	Core	GA
az connection preview-configuration	Preview the expected configurations of local connection.	Core	GA
az connection preview-configuration app-insights	Preview the expected configurations of local connection to app-insights.	Core	GA
az connection preview-configuration appconfig	Preview the expected configurations of local connection to appconfig.	Core	GA
az connection preview-configuration confluent-cloud	Preview the expected configurations of local connection to confluent-cloud.	Core	GA
az connection preview-configuration cosmos-cassandra	Preview the expected configurations of local connection to cosmos-cassandra.	Core	GA
az connection preview-configuration cosmos-gremlin	Preview the expected configurations of local connection to cosmos-gremlin.	Core	GA
az connection preview-configuration cosmos-mongo	Preview the expected configurations of local connection to cosmos-mongo.	Core	GA
az connection preview-configuration cosmos-sql	Preview the expected configurations of local connection to cosmos-sql.	Core	GA
az connection preview-configuration cosmos-table	Preview the expected configurations of local connection to cosmos-table.	Core	GA
az connection preview-configuration eventhub	Preview the expected configurations of local connection to eventhub.	Core	GA
az connection preview-configuration keyvault	Preview the expected configurations of local connection to keyvault.	Core	GA
az connection preview-configuration mysql	Preview the expected configurations of local connection to mysql.	Core	GA
az connection preview-configuration mysql-flexible	Preview the expected configurations of local connection to mysql-flexible.	Core	GA
az connection preview-configuration postgres	Preview the expected configurations of local connection to postgres.	Core	GA
az connection preview-configuration postgres-flexible	Preview the expected configurations of local connection to postgres-flexible.	Core	GA
az connection preview-configuration redis	Preview the expected configurations of local connection to redis.	Core	GA
az connection preview-configuration redis-enterprise	Preview the expected configurations of local connection to redis-enterprise.	Core	GA
az connection preview-configuration servicebus	Preview the expected configurations of local connection to servicebus.	Core	GA
az connection preview-configuration signalr	Preview the expected configurations of local connection to signalr.	Core	GA
az connection preview-configuration sql	Preview the expected configurations of local connection to sql.	Core	GA
az connection preview-configuration storage-blob	Preview the expected configurations of local connection to storage-blob.	Core	GA
az connection preview-configuration storage-file	Preview the expected configurations of local connection to storage-file.	Core	GA
az connection preview-configuration storage-queue	Preview the expected configurations of local connection to storage-queue.	Core	GA
az connection preview-configuration storage-table	Preview the expected configurations of local connection to storage-table.	Core	GA
az connection preview-configuration webpubsub	Preview the expected configurations of local connection to webpubsub.	Core	GA
az connection show	Get the details of a Service Connector local connection.	Core	GA
az connection update	Update a Service Connector local connection.	Core	GA
az connection update app-insights	Update a local to app-insights connection.	Core	GA
az connection update appconfig	Update a local to appconfig connection.	Core	GA
az connection update confluent-cloud	Update a local connection to confluent-cloud.	Core	GA
az connection update cosmos-cassandra	Update a local to cosmos-cassandra connection.	Core	GA
az connection update cosmos-gremlin	Update a local to cosmos-gremlin connection.	Core	GA
az connection update cosmos-mongo	Update a local to cosmos-mongo connection.	Core	GA
az connection update cosmos-sql	Update a local to cosmos-sql connection.	Core	GA
az connection update cosmos-table	Update a local to cosmos-table connection.	Core	GA
az connection update eventhub	Update a local to eventhub connection.	Core	GA
az connection update keyvault	Update a local to keyvault connection.	Core	GA
az connection update mysql	Update a local to mysql connection.	Core	GA
az connection update mysql-flexible	Update a local to mysql-flexible connection.	Core	GA
az connection update postgres	Update a local to postgres connection.	Core	GA
az connection update postgres-flexible	Update a local to postgres-flexible connection.	Core	GA
az connection update redis	Update a local to redis connection.	Core	GA
az connection update redis-enterprise	Update a local to redis-enterprise connection.	Core	GA
az connection update servicebus	Update a local to servicebus connection.	Core	GA
az connection update signalr	Update a local to signalr connection.	Core	GA
az connection update sql	Update a local to sql connection.	Core	GA
az connection update storage-blob	Update a local to storage-blob connection.	Core	GA
az connection update storage-file	Update a local to storage-file connection.	Core	GA
az connection update storage-queue	Update a local to storage-queue connection.	Core	GA
az connection update storage-table	Update a local to storage-table connection.	Core	GA
az connection update webpubsub	Update a local to webpubsub connection.	Core	GA
az connection validate	Validate a Service Connector local connection.	Core	GA
az connection wait	Place the CLI in a waiting state until a condition of the connection is met.	Core	GA

az connection delete

Delete a Service Connector local connection.

az connection delete [--connection]
                     [--id]
                     [--location]
                     [--no-wait]
                     [--resource-group]
                     [--yes]

Examples

Delete a local connection interactively

az connection delete

Delete a local connection by connection name

az connection delete -g resourceGroup --connection MyConnection

Delete a local connection by connection id

az connection delete --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}

Optional Parameters

--connection

Name of the connection.

--id

The id of connection.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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

--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 connection generate-configuration

Generate configurations of a Service Connector local connection. The result should be put to application configuration file or set as environment variables.

az connection generate-configuration [--connection]
                                     [--id]
                                     [--location]
                                     [--resource-group]

Examples

Generate a connection's local configurations by connection name

az connection generate-configuration -g resource_group --connection MyConnection

Generate a connection's local configurations by connection id

az connection generate-configuration --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}

Optional Parameters

--connection

Name of the connection.

--id

The id of connection.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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

List local connections of Service Connector.

az connection list --resource-group
                   [--location]

Examples

List connections by resource group

az connection list -g resource_group

List connections by source resource group and location

az connection list -g resource_group --location eastus

Required Parameters

--resource-group -g

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

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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 connection list-support-types

List client types and auth types supported by local connections.

az connection list-support-types [--target-type {app-insights, appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}]

Examples

List all supported target resource types and auth types

az connection list-support-types -o table

List supported auth types for a specific target resource type

az connection list-support-types --target-type storage-blob -o table

Optional Parameters

--target-type -t

The target resource type.

accepted values: app-insights, appconfig, confluent-cloud, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub

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

Get the details of a Service Connector local connection.

az connection show [--connection]
                   [--id]
                   [--location]
                   [--resource-group]

Examples

Get a connection interactively

az connection show

Get a connection by connection name

az connection show -g resourceGroup --connection MyConnection

Get a connection by connection id

az connection show --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}

Optional Parameters

--connection

Name of the connection.

--id

The id of connection.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--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 connection validate

Validate a Service Connector local connection.

az connection validate [--connection]
                       [--id]
                       [--location]
                       [--resource-group]

Examples

Validate a connection interactively

az connection validate

Validate a connection by connection name

az connection validate -g resourceGroup --connection MyConnection

Validate a connection by connection id

az connection validate --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}

Optional Parameters

--connection

Name of the connection.

--id

The id of connection.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--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 connection wait

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

az connection wait [--connection]
                   [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--id]
                   [--interval]
                   [--location]
                   [--resource-group]
                   [--timeout]
                   [--updated]

Examples

Wait until the connection is successfully created.

az connection wait --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName} --created

Optional Parameters

--connection

Name of the connection.

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

--id

The id of connection.

--interval

Polling interval in seconds.

default value: 30

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

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

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