az connection create

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.

Create a connection from local to a target resource.

Commands

Name	Description	Type	Status
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 create app-insights

Create a Service Connector local connection to app-insights.

az connection create app-insights --resource-group
                                  [--app-insights]
                                  [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python}]
                                  [--connection]
                                  [--customized-keys]
                                  [--location]
                                  [--no-wait]
                                  [--secret]
                                  [--target-id]
                                  [--target-resource-group]

Examples

Create a connection from local to app-insights interactively

az connection create app-insights -g resourceGroup

Create a connection from local to app-insights with resource name

az connection create app-insights -g resourceGroup --tg AppInsightsRG --app-insights MyAppInsights --secret

Create a connection from local to app-insights with resource id

az connection create app-insights -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/microsoft.insights/components/{appinsights} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--app-insights

Name of the app insights. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--app-insights'] are not specified.

--target-resource-group --tg

The resource group which contains the app insights. Required if '--target-id' is not specified.

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

Create a Service Connector local connection to appconfig.

az connection create appconfig --resource-group
                               [--app-config]
                               [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                               [--connection]
                               [--customized-keys]
                               [--location]
                               [--no-wait]
                               [--secret]
                               [--service-principal]
                               [--target-id]
                               [--target-resource-group]
                               [--user-account]

Examples

Create a connection from local to appconfig interactively

az connection create appconfig -g resourceGroup

Create a connection from local to appconfig with resource name

az connection create appconfig -g resourceGroup --tg AppconfigRG --app-config MyConfigStore --secret

Create a connection from local to appconfig with resource id

az connection create appconfig -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.AppConfiguration/configurationStores/{config_store} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--app-config

Name of the app configuration. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--app-config'] are not specified.

--target-resource-group --tg

The resource group which contains the app configuration. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create confluent-cloud

Create a local connection to confluent-cloud.

az connection create confluent-cloud --bootstrap-server
                                     --kafka-key
                                     --kafka-secret
                                     --resource-group
                                     --schema-key
                                     --schema-registry
                                     --schema-secret
                                     [--client-type {dotnet, dotnet-internal, go, java, none, python, springBoot}]
                                     [--connection]
                                     [--customized-keys]
                                     [--location]
                                     [--no-wait]

Examples

Create a connection form local to confluent-cloud

az connection create confluent-cloud -g resourceGroup --connection myConnection --bootstrap-server xxx.eastus.azure.confluent.cloud:9092 --kafka-key Name --kafka-secret Secret --schema-registry https://xxx.eastus.azure.confluent.cloud --schema-key Name --schema-secret Secret

Required Parameters

--bootstrap-server

Kafka bootstrap server url.

--kafka-key

Kafka API-Key (key).

--kafka-secret

Kafka API-Key (secret).

--resource-group -g

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

--schema-key

Schema registry API-Key (key).

--schema-registry

Schema registry url.

--schema-secret

Schema registry API-Key (secret).

Optional Parameters

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, go, java, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

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 create cosmos-cassandra

Create a Service Connector local connection to cosmos-cassandra.

az connection create cosmos-cassandra --resource-group
                                      [--account]
                                      [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                      [--connection]
                                      [--customized-keys]
                                      [--key-space]
                                      [--location]
                                      [--no-wait]
                                      [--secret]
                                      [--service-principal]
                                      [--target-id]
                                      [--target-resource-group]
                                      [--user-account]

Examples

Create a connection from local to cosmos-cassandra interactively

az connection create cosmos-cassandra -g resourceGroup

Create a connection from local to cosmos-cassandra with resource name

az connection create cosmos-cassandra -g resourceGroup --tg CosmosRG --account MyAccount --key-space MyKeySpace --secret

Create a connection from local to cosmos-cassandra with resource id

az connection create cosmos-cassandra -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/cassandraKeyspaces/{key_space} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--key-space

Name of the keyspace. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--key-space'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create cosmos-gremlin

Create a Service Connector local connection to cosmos-gremlin.

az connection create cosmos-gremlin --resource-group
                                    [--account]
                                    [--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python}]
                                    [--connection]
                                    [--customized-keys]
                                    [--database]
                                    [--graph]
                                    [--location]
                                    [--no-wait]
                                    [--secret]
                                    [--service-principal]
                                    [--target-id]
                                    [--target-resource-group]
                                    [--user-account]

Examples

Create a connection from local to cosmos-gremlin interactively

az connection create cosmos-gremlin -g resourceGroup

Create a connection from local to cosmos-gremlin with resource name

az connection create cosmos-gremlin -g resourceGroup --tg CosmosRG --account MyAccount --database MyDB --graph MyGraph --secret

Create a connection from local to cosmos-gremlin with resource id

az connection create cosmos-gremlin -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/gremlinDatabases/{database}/graphs/{graph} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, php, python

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the database. Required if '--target-id' is not specified.

--graph

Name of the graph. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--database', '--graph'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create cosmos-mongo

Create a Service Connector local connection to cosmos-mongo.

az connection create cosmos-mongo --resource-group
                                  [--account]
                                  [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, springBoot}]
                                  [--connection]
                                  [--customized-keys]
                                  [--database]
                                  [--location]
                                  [--no-wait]
                                  [--secret]
                                  [--service-principal]
                                  [--target-id]
                                  [--target-resource-group]
                                  [--user-account]

Examples

Create a connection from local to cosmos-mongo interactively

az connection create cosmos-mongo -g resourceGroup

Create a connection from local to cosmos-mongo with resource name

az connection create cosmos-mongo -g resourceGroup --tg CosmosRG --account MyAccount --database MyDB --secret

Create a connection from local to cosmos-mongo with resource id

az connection create cosmos-mongo -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/mongodbDatabases/{database} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create cosmos-sql

Create a Service Connector local connection to cosmos-sql.

az connection create cosmos-sql --resource-group
                                [--account]
                                [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                [--connection]
                                [--customized-keys]
                                [--database]
                                [--location]
                                [--no-wait]
                                [--secret]
                                [--service-principal]
                                [--target-id]
                                [--target-resource-group]
                                [--user-account]

Examples

Create a connection from local to cosmos-sql interactively

az connection create cosmos-sql -g resourceGroup

Create a connection from local to cosmos-sql with resource name

az connection create cosmos-sql -g resourceGroup --tg CosmosRG --account MyAccount --database MyDB --secret

Create a connection from local to cosmos-sql with resource id

az connection create cosmos-sql -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/sqlDatabases/{database} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create cosmos-table

Create a Service Connector local connection to cosmos-table.

az connection create cosmos-table --resource-group
                                  [--account]
                                  [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                  [--connection]
                                  [--customized-keys]
                                  [--location]
                                  [--no-wait]
                                  [--secret]
                                  [--service-principal]
                                  [--table]
                                  [--target-id]
                                  [--target-resource-group]
                                  [--user-account]

Examples

Create a connection from local to cosmos-table interactively

az connection create cosmos-table -g resourceGroup

Create a connection from local to cosmos-table with resource name

az connection create cosmos-table -g resourceGroup --tg CosmosRG --account MyAccount --table MyTable --secret

Create a connection from local to cosmos-table with resource id

az connection create cosmos-table -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DocumentDB/databaseAccounts/{account}/tables/{table} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the cosmos database account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--table

Name of the table. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account', '--table'] are not specified.

--target-resource-group --tg

The resource group which contains the cosmos database account. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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

Create a Service Connector local connection to eventhub.

az connection create eventhub --resource-group
                              [--client-type {dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot}]
                              [--connection]
                              [--customized-keys]
                              [--location]
                              [--namespace]
                              [--no-wait]
                              [--secret]
                              [--service-principal]
                              [--target-id]
                              [--target-resource-group]
                              [--user-account]

Examples

Create a connection from local to eventhub interactively

az connection create eventhub -g resourceGroup

Create a connection from local to eventhub with resource name

az connection create eventhub -g resourceGroup --tg EventhubRG --namespace MyNamespace --secret

Create a connection from local to eventhub with resource id

az connection create eventhub -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.EventHub/namespaces/{namespace} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--location -l

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

--namespace

Name of the eventhub namespace. Required if '--target-id' is not specified.

--no-wait

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

default value: False

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--namespace'] are not specified.

--target-resource-group --tg

The resource group which contains the eventhub. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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

Create a Service Connector local connection to keyvault.

az connection create keyvault --resource-group
                              [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                              [--connection]
                              [--customized-keys]
                              [--location]
                              [--no-wait]
                              [--service-principal]
                              [--target-id]
                              [--target-resource-group]
                              [--user-account]
                              [--vault]

Examples

Create a connection from local to keyvault interactively

az connection create keyvault -g resourceGroup

Create a connection from local to keyvault with resource name

az connection create keyvault -g resourceGroup --tg KeyvaultRG --vault MyVault --user-account

Create a connection from local to keyvault with resource id

az connection create keyvault -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.KeyVault/vaults/{vault} --user-account

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--vault'] are not specified.

--target-resource-group --tg

The resource group which contains the keyvault. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

--vault

Name of the keyvault. Required if '--target-id' is not specified.

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

Create a Service Connector local connection to mysql.

az connection create mysql --resource-group
                           [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                           [--connection]
                           [--customized-keys]
                           [--database]
                           [--location]
                           [--no-wait]
                           [--secret]
                           [--server]
                           [--target-id]
                           [--target-resource-group]

Examples

Create a connection from local to mysql interactively

az connection create mysql -g resourceGroup

Create a connection from local to mysql with resource name

az connection create mysql -g resourceGroup --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to mysql with resource id

az connection create mysql -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBForMySQL/servers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the mysql database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of the mysql server. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the mysql server. Required if '--target-id' is not specified.

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 create mysql-flexible

Create a Service Connector local connection to mysql-flexible.

az connection create mysql-flexible --resource-group
                                    [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                    [--connection]
                                    [--customized-keys]
                                    [--database]
                                    [--location]
                                    [--no-wait]
                                    [--secret]
                                    [--server]
                                    [--target-id]
                                    [--target-resource-group]
                                    [--user-account]

Examples

Create a connection from local to mysql-flexible interactively

az connection create mysql-flexible -g resourceGroup

Create a connection from local to mysql-flexible with resource name

az connection create mysql-flexible -g resourceGroup --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to mysql-flexible with resource id

az connection create mysql-flexible -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the mysql flexible database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of the mysql flexible server. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the mysql flexible server. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account mysql-identity-id=xx object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided. mysql-identity-id : Optional. ID of identity used for MySQL flexible server AAD Authentication. Ignore it if you are the server AAD administrator.

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 create mysql-flexible (serviceconnector-passwordless extension)

Create a Service Connector local connection to mysql-flexible.

az connection create mysql-flexible --resource-group
                                    [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                    [--connection]
                                    [--customized-keys]
                                    [--database]
                                    [--location]
                                    [--no-wait]
                                    [--secret]
                                    [--server]
                                    [--service-principal]
                                    [--target-id]
                                    [--target-resource-group]
                                    [--user-account]
                                    [--yes]

Examples

Create a connection from local to mysql-flexible interactively

az connection create mysql-flexible -g resourceGroup

Create a connection from local to mysql-flexible with resource name

az connection create mysql-flexible -g resourceGroup --tg MysqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to mysql-flexible with resource id

az connection create mysql-flexible -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforMySQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the mysql flexible database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of the mysql flexible server. Required if '--target-id' is not specified.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the mysql flexible server. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account mysql-identity-id=xx object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided. mysql-identity-id : Optional. ID of identity used for MySQL flexible server Microsoft Entra Authentication. Ignore it if you are the server Microsoft Entra administrator.

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

Create a Service Connector local connection to postgres.

az connection create postgres --resource-group
                              [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                              [--connection]
                              [--customized-keys]
                              [--database]
                              [--location]
                              [--no-wait]
                              [--secret]
                              [--server]
                              [--target-id]
                              [--target-resource-group]
                              [--user-account]

Examples

Create a connection from local to postgres interactively

az connection create postgres -g resourceGroup

Create a connection from local to postgres with resource name

az connection create postgres -g resourceGroup --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to postgres with resource id

az connection create postgres -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/servers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of postgres database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of postgres server. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the postgres service. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create postgres (serviceconnector-passwordless extension)

Create a Service Connector local connection to postgres.

az connection create postgres --resource-group
                              [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                              [--connection]
                              [--customized-keys]
                              [--database]
                              [--location]
                              [--no-wait]
                              [--secret]
                              [--server]
                              [--service-principal]
                              [--target-id]
                              [--target-resource-group]
                              [--user-account]
                              [--yes]

Examples

Create a connection from local to postgres interactively

az connection create postgres -g resourceGroup

Create a connection from local to postgres with resource name

az connection create postgres -g resourceGroup --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to postgres with resource id

az connection create postgres -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/servers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of postgres database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of postgres server. Required if '--target-id' is not specified.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the postgres service. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

--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 create postgres-flexible

Create a Service Connector local connection to postgres-flexible.

az connection create postgres-flexible --resource-group
                                       [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                       [--connection]
                                       [--customized-keys]
                                       [--database]
                                       [--location]
                                       [--no-wait]
                                       [--secret]
                                       [--server]
                                       [--target-id]
                                       [--target-resource-group]
                                       [--user-account]

Examples

Create a connection from local to postgres-flexible interactively

az connection create postgres-flexible -g resourceGroup

Create a connection from local to postgres-flexible with resource name

az connection create postgres-flexible -g resourceGroup --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to postgres-flexible with resource id

az connection create postgres-flexible -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of postgres flexible database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of postgres flexible server. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the flexible postgres service. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create postgres-flexible (serviceconnector-passwordless extension)

Create a Service Connector local connection to postgres-flexible.

az connection create postgres-flexible --resource-group
                                       [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                                       [--connection]
                                       [--customized-keys]
                                       [--database]
                                       [--location]
                                       [--no-wait]
                                       [--secret]
                                       [--server]
                                       [--service-principal]
                                       [--target-id]
                                       [--target-resource-group]
                                       [--user-account]
                                       [--yes]

Examples

Create a connection from local to postgres-flexible interactively

az connection create postgres-flexible -g resourceGroup

Create a connection from local to postgres-flexible with resource name

az connection create postgres-flexible -g resourceGroup --tg PostgresRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to postgres-flexible with resource id

az connection create postgres-flexible -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of postgres flexible database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of postgres flexible server. Required if '--target-id' is not specified.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the flexible postgres service. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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

Create a Service Connector local connection to redis.

az connection create redis --resource-group
                           [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                           [--connection]
                           [--customized-keys]
                           [--database]
                           [--location]
                           [--no-wait]
                           [--secret]
                           [--server]
                           [--target-id]
                           [--target-resource-group]

Examples

Create a connection from local to redis interactively

az connection create redis -g resourceGroup

Create a connection from local to redis with resource name

az connection create redis -g resourceGroup --tg RedisRG --server MyServer --database MyDB --secret

Create a connection from local to redis with resource id

az connection create redis -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redis/{server}/databases/{database} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the redis database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret.

--server

Name of the redis server. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the redis server. Required if '--target-id' is not specified.

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 create redis-enterprise

Create a Service Connector local connection to redis-enterprise.

az connection create redis-enterprise --resource-group
                                      [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                      [--connection]
                                      [--customized-keys]
                                      [--database]
                                      [--location]
                                      [--no-wait]
                                      [--secret]
                                      [--server]
                                      [--target-id]
                                      [--target-resource-group]

Examples

Create a connection from local to redis-enterprise interactively

az connection create redis-enterprise -g resourceGroup

Create a connection from local to redis-enterprise with resource name

az connection create redis-enterprise -g resourceGroup --tg RedisRG --server MyServer --database MyDB --secret

Create a connection from local to redis-enterprise with resource id

az connection create redis-enterprise -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Cache/redisEnterprise/{server}/databases/{database} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the redis enterprise database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret.

--server

Name of the redis enterprise server. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the redis server. Required if '--target-id' is not specified.

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

Create a Service Connector local connection to servicebus.

az connection create servicebus --resource-group
                                [--client-type {dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot}]
                                [--connection]
                                [--customized-keys]
                                [--location]
                                [--namespace]
                                [--no-wait]
                                [--secret]
                                [--service-principal]
                                [--target-id]
                                [--target-resource-group]
                                [--user-account]

Examples

Create a connection from local to servicebus interactively

az connection create servicebus -g resourceGroup

Create a connection from local to servicebus with resource name

az connection create servicebus -g resourceGroup --tg ServicebusRG --namespace MyNamespace --secret

Create a connection from local to servicebus with resource id

az connection create servicebus -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.ServiceBus/namespaces/{namespace} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--location -l

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

--namespace

Name of the servicebus namespace. Required if '--target-id' is not specified.

--no-wait

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

default value: False

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--namespace'] are not specified.

--target-resource-group --tg

The resource group which contains the servicebus. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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

Create a Service Connector local connection to signalr.

az connection create signalr --resource-group
                             [--client-type {dotnet, dotnet-internal, none}]
                             [--connection]
                             [--customized-keys]
                             [--location]
                             [--no-wait]
                             [--secret]
                             [--service-principal]
                             [--signalr]
                             [--target-id]
                             [--target-resource-group]
                             [--user-account]

Examples

Create a connection from local to signalr interactively

az connection create signalr -g resourceGroup

Create a connection from local to signalr with resource name

az connection create signalr -g resourceGroup --tg SignalrRG --signalr MySignalR --secret

Create a connection from local to signalr with resource id

az connection create signalr -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/SignalR/{signalr} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, none

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--signalr

Name of the signalr service. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--signalr'] are not specified.

--target-resource-group --tg

The resource group which contains the signalr. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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

Create a Service Connector local connection to sql.

az connection create sql --resource-group
                         [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                         [--connection]
                         [--customized-keys]
                         [--database]
                         [--location]
                         [--no-wait]
                         [--secret]
                         [--server]
                         [--target-id]
                         [--target-resource-group]
                         [--user-account]

Examples

Create a connection from local to sql interactively

az connection create sql -g resourceGroup

Create a connection from local to sql with resource name

az connection create sql -g resourceGroup --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to sql with resource id

az connection create sql -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the sql database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of the sql server. Required if '--target-id' is not specified.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the sql server. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create sql (serviceconnector-passwordless extension)

Create a Service Connector local connection to sql.

az connection create sql --resource-group
                         [--client-type {django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot}]
                         [--connection]
                         [--customized-keys]
                         [--database]
                         [--location]
                         [--no-wait]
                         [--secret]
                         [--server]
                         [--service-principal]
                         [--target-id]
                         [--target-resource-group]
                         [--user-account]
                         [--yes]

Examples

Create a connection from local to sql interactively

az connection create sql -g resourceGroup

Create a connection from local to sql with resource name

az connection create sql -g resourceGroup --tg SqlRG --server MyServer --database MyDB --secret name=XX secret=XX

Create a connection from local to sql with resource id

az connection create sql -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Sql/servers/{server}/databases/{database} --secret name=XX secret=XX

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

--database

Name of the sql database. Required if '--target-id' is not specified.

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

--secret

The secret auth info.

Usage: --secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name : Required. Username or account name for secret auth. secret : Required. Password or account key for secret auth.

--server

Name of the sql server. Required if '--target-id' is not specified.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--server', '--database'] are not specified.

--target-resource-group --tg

The resource group which contains the sql server. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

--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 create storage-blob

Create a Service Connector local connection to storage-blob.

az connection create storage-blob --resource-group
                                  [--account]
                                  [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                  [--connection]
                                  [--customized-keys]
                                  [--location]
                                  [--no-wait]
                                  [--secret]
                                  [--service-principal]
                                  [--target-id]
                                  [--target-resource-group]
                                  [--user-account]

Examples

Create a connection from local to storage-blob interactively

az connection create storage-blob -g resourceGroup

Create a connection from local to storage-blob with resource name

az connection create storage-blob -g resourceGroup --tg StorageRG --account MyAccount --secret

Create a connection from local to storage-blob with resource id

az connection create storage-blob -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/blobServices/default --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the storage account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the storage account. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create storage-file

Create a Service Connector local connection to storage-file.

az connection create storage-file --resource-group
                                  [--account]
                                  [--client-type {dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot}]
                                  [--connection]
                                  [--customized-keys]
                                  [--location]
                                  [--no-wait]
                                  [--secret]
                                  [--target-id]
                                  [--target-resource-group]

Examples

Create a connection from local to storage-file interactively

az connection create storage-file -g resourceGroup

Create a connection from local to storage-file with resource name

az connection create storage-file -g resourceGroup --tg StorageRG --account MyAccount --secret

Create a connection from local to storage-file with resource id

az connection create storage-file -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/fileServices/default --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the storage account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the storage account. Required if '--target-id' is not specified.

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 create storage-queue

Create a Service Connector local connection to storage-queue.

az connection create storage-queue --resource-group
                                   [--account]
                                   [--client-type {dotnet, dotnet-internal, java, nodejs, none, python, springBoot}]
                                   [--connection]
                                   [--customized-keys]
                                   [--location]
                                   [--no-wait]
                                   [--secret]
                                   [--service-principal]
                                   [--target-id]
                                   [--target-resource-group]
                                   [--user-account]

Examples

Create a connection from local to storage-queue interactively

az connection create storage-queue -g resourceGroup

Create a connection from local to storage-queue with resource name

az connection create storage-queue -g resourceGroup --tg StorageRG --account MyAccount --secret

Create a connection from local to storage-queue with resource id

az connection create storage-queue -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/queueServices/default --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the storage account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the storage account. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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 create storage-table

Create a Service Connector local connection to storage-table.

az connection create storage-table --resource-group
                                   [--account]
                                   [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                                   [--connection]
                                   [--customized-keys]
                                   [--location]
                                   [--no-wait]
                                   [--secret]
                                   [--service-principal]
                                   [--target-id]
                                   [--target-resource-group]
                                   [--user-account]

Examples

Create a connection from local to storage-table interactively

az connection create storage-table -g resourceGroup

Create a connection from local to storage-table with resource name

az connection create storage-table -g resourceGroup --tg StorageRG --account MyAccount --secret

Create a connection from local to storage-table with resource id

az connection create storage-table -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.Storage/storageAccounts/{account}/tableServices/default --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--account

Name of the storage account. Required if '--target-id' is not specified.

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--account'] are not specified.

--target-resource-group --tg

The resource group which contains the storage account. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

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

Create a Service Connector local connection to webpubsub.

az connection create webpubsub --resource-group
                               [--client-type {dotnet, dotnet-internal, java, nodejs, none, python}]
                               [--connection]
                               [--customized-keys]
                               [--location]
                               [--no-wait]
                               [--secret]
                               [--service-principal]
                               [--target-id]
                               [--target-resource-group]
                               [--user-account]
                               [--webpubsub]

Examples

Create a connection from local to webpubsub interactively

az connection create webpubsub -g resourceGroup

Create a connection from local to webpubsub with resource name

az connection create webpubsub -g resourceGroup --tg WebpubsubRG --webpubsub MyWebPubSub --secret

Create a connection from local to webpubsub with resource id

az connection create webpubsub -g resourceGroup --target-id /subscriptions/{subscription}/resourceGroups/{target_resource_group}/providers/Microsoft.SignalRService/WebPubSub/{webpubsub} --secret

Required Parameters

--resource-group -g

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

Optional Parameters

--client-type

The client type used on the connection.

accepted values: dotnet, dotnet-internal, java, nodejs, none, python

--connection

Name of the connection.

--customized-keys

The customized keys used to change default configuration names. Key is the original name, value is the customized name.

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

--secret

The secret auth info.

Usage: --secret.

--service-principal

The service principal auth info.

Usage: --service-principal client-id=XX secret=XX

client-id : Required. Client id of the service principal. object-id : Optional. Object id of the service principal (Enterprise Application). secret : Required. Secret of the service principal.

--target-id

The resource id of target service. Required if ['--target-resource-group', '--webpubsub'] are not specified.

--target-resource-group --tg

The resource group which contains the webpubsub. Required if '--target-id' is not specified.

--user-account

The user account auth info.

Usage: --user-account object-id=XX

object-id : Optional. Object id of current login user. It will be set automatically if not provided.

--webpubsub

Name of the webpubsub service. Required if '--target-id' is not specified.

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.