az connection create

Note

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展，使其受益于其扩展功能。 Learn more about extensions.

创建从本地到目标资源的连接。

命令

名称	说明	类型	Status
az connection create app-insights	创建到 app-insights 的服务连接器本地连接。	Core	GA
az connection create appconfig	创建到 appconfig 的服务连接器本地连接。	Core	GA
az connection create confluent-cloud	创建与 confluent-cloud 的本地连接。	Core	GA
az connection create cosmos-cassandra	创建到 cosmos-cassandra 的服务连接器本地连接。	Core	GA
az connection create cosmos-gremlin	创建到 cosmos-gremlin 的服务连接器本地连接。	Core	GA
az connection create cosmos-mongo	创建到 cosmos-mongo 的服务连接器本地连接。	Core	GA
az connection create cosmos-sql	创建到 cosmos-sql 的服务连接器本地连接。	Core	GA
az connection create cosmos-table	创建到 cosmos-table 的服务连接器本地连接。	Core	GA
az connection create eventhub	创建到 eventhub 的服务连接器本地连接。	Core	GA
az connection create keyvault	创建到 keyvault 的服务连接器本地连接。	Core	GA
az connection create mysql	创建到 mysql 的服务连接器本地连接。	Core	GA
az connection create mysql-flexible	创建与 mysql 灵活连接的服务连接器本地连接。	Core	GA
az connection create mysql-flexible (serviceconnector-passwordless 扩展)	创建与 mysql 灵活连接的服务连接器本地连接。	Extension	GA
az connection create postgres	创建到 postgres 的服务连接器本地连接。	Core	GA
az connection create postgres-flexible	创建与 postgres 灵活连接的服务连接器本地连接。	Core	GA
az connection create postgres-flexible (serviceconnector-passwordless 扩展)	创建与 postgres 灵活连接的服务连接器本地连接。	Extension	GA
az connection create redis	创建与 redis 的服务连接器本地连接。	Core	GA
az connection create redis-enterprise	创建与 redis-enterprise 的服务连接器本地连接。	Core	GA
az connection create servicebus	创建到 servicebus 的服务连接器本地连接。	Core	GA
az connection create signalr	创建与信号器的服务连接器本地连接。	Core	GA
az connection create sql	创建到 sql 的服务连接器本地连接。	Core	GA
az connection create sql (serviceconnector-passwordless 扩展)	创建到 sql 的服务连接器本地连接。	Extension	GA
az connection create storage-blob	创建到 storage-blob 的服务连接器本地连接。	Core	GA
az connection create storage-file	创建与存储文件的服务连接器本地连接。	Core	GA
az connection create storage-queue	创建到存储队列的服务连接器本地连接。	Core	GA
az connection create storage-table	创建到存储表的服务连接器本地连接。	Core	GA
az connection create webpubsub	创建到 Webpubsub 的服务连接器本地连接。	Core	GA

az connection create app-insights

创建到 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 --tg]

示例

以交互方式创建从本地到应用见解的连接

az connection create app-insights -g resourceGroup

使用资源名称从本地到应用见解创建连接

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

使用资源 ID 从本地到应用见解创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--app-insights

应用见解的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, go, java, nodejs, none, python

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--app-insights']，则为必需。

--target-resource-group --tg

包含应用见解的资源组。 如果未指定“--target-id”，则为必需。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create appconfig

创建到 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 --tg]
                               [--user-account]

示例

以交互方式创建从本地到 appconfig 的连接

az connection create appconfig -g resourceGroup

使用资源名称从本地到 appconfig 创建连接

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

使用资源 ID 从本地到 appconfig 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--app-config

应用配置的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, python

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--app-config']，则为必需。

--target-resource-group --tg

包含应用配置的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create confluent-cloud

创建与 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]

示例

创建本地到 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

必需参数

--bootstrap-server

Kafka bootstrap 服务器 URL。

--kafka-key

Kafka API-Key（密钥）。

--kafka-secret

Kafka API-Key（机密）。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--schema-key

架构注册表 API 密钥（密钥）。

--schema-registry

架构注册表 URL。

--schema-secret

架构注册表 API 密钥（机密）。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, go, java, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create cosmos-cassandra

创建到 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 --tg]
                                      [--user-account]

示例

以交互方式创建从本地到 cosmos-cassandra 的连接

az connection create cosmos-cassandra -g resourceGroup

使用资源名称从本地到 cosmos-cassandra 创建连接

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

使用资源 ID 从本地到 cosmos-cassandra 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

cosmos 数据库帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--key-space

密钥空间的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、 '--account'、 '--key-space'，则为必需。

--target-resource-group --tg

包含 cosmos 数据库帐户的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create cosmos-gremlin

创建到 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 --tg]
                                    [--user-account]

示例

以交互方式创建从本地到 cosmos-gremlin 的连接

az connection create cosmos-gremlin -g resourceGroup

使用资源名称从本地到 cosmos-gremlin 创建连接

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

使用资源 ID 从本地到 cosmos-gremlin 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

cosmos 数据库帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, php, python

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

数据库的名称。 如果未指定“--target-id”，则为必需。

--graph

图的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--account'， '--database'， '--graph'] ，则是必需的。

--target-resource-group --tg

包含 cosmos 数据库帐户的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create cosmos-mongo

创建到 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 --tg]
                                  [--user-account]

示例

以交互方式创建从本地到 cosmos-mongo 的连接

az connection create cosmos-mongo -g resourceGroup

使用资源名称从本地到 cosmos-mongo 创建连接

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

使用资源 ID 从本地到 cosmos-mongo 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

cosmos 数据库帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, go, java, nodejs, none, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、 '--account'、 '--database'，则为必需。

--target-resource-group --tg

包含 cosmos 数据库帐户的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create cosmos-sql

创建到 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 --tg]
                                [--user-account]

示例

以交互方式创建从本地到 cosmos-sql 的连接

az connection create cosmos-sql -g resourceGroup

使用资源名称从本地到 cosmos-sql 创建连接

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

使用资源 ID 从本地到 cosmos-sql 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

cosmos 数据库帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、 '--account'、 '--database'，则为必需。

--target-resource-group --tg

包含 cosmos 数据库帐户的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create cosmos-table

创建到 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 --tg]
                                  [--user-account]

示例

以交互方式创建从本地到 cosmos-table 的连接

az connection create cosmos-table -g resourceGroup

使用资源名称从本地到 cosmos-table 创建连接

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

使用资源 ID 从本地到 cosmos-table 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

cosmos 数据库帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--table

表的名称。 如果未指定“--target-id”，则为必需。

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、 '--account'、 '--table'，则为必需。

--target-resource-group --tg

包含 cosmos 数据库帐户的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create eventhub

创建到 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 --tg]
                              [--user-account]

示例

以交互方式创建从本地到 eventhub 的连接

az connection create eventhub -g resourceGroup

使用资源名称从本地到事件中心创建连接

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

使用资源 ID 从本地到事件中心创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, go, java, kafka-springBoot, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--namespace

事件中心命名空间的名称。 如果未指定“--target-id”，则为必需。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--namespace'] ，则为必需。

--target-resource-group --tg

包含 eventhub 的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create keyvault

创建到 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 --tg]
                              [--user-account]
                              [--vault]

示例

以交互方式创建从本地到 keyvault 的连接

az connection create keyvault -g resourceGroup

使用资源名称从本地到 keyvault 创建连接

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

使用资源 ID 从本地到 keyvault 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--vault'] ，则为必需。

--target-resource-group --tg

包含 keyvault 的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

--vault

keyvault 的名称。 如果未指定“--target-id”，则为必需。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create mysql

创建到 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 --tg]

示例

以交互方式创建从本地到 mysql 的连接

az connection create mysql -g resourceGroup

使用资源名称从本地到 mysql 创建连接

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

使用资源 ID 从本地到 mysql 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

mysql 数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

用法：--secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name ：必需。 机密身份验证的用户名或帐户名称。机密：必需。 用于机密身份验证的密码或帐户密钥。

属性	值
Parameter group:	AuthType Arguments

--server

mysql 服务器的名称。 如果未指定“--target-id”，则为必需。

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含 mysql 服务器的资源组。 如果未指定“--target-id”，则为必需。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create mysql-flexible

创建与 mysql 灵活连接的服务连接器本地连接。

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 --tg]
                                    [--user-account]

示例

以交互方式创建从本地到 mysql 灵活的连接

az connection create mysql-flexible -g resourceGroup

使用资源名称从本地到 mysql 灵活创建连接

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

使用资源 ID 从本地到 mysql 灵活创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

mysql 灵活数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

用法：--secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name ：必需。 机密身份验证的用户名或帐户名称。机密：必需。 用于机密身份验证的密码或帐户密钥。

属性	值
Parameter group:	AuthType Arguments

--server

mysql 灵活服务器的名称。 如果未指定“--target-id”，则为必需。

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含 mysql 灵活服务器的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account mysql-identity-id=xx object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。 mysql-identity-id ：可选。 用于 MySQL 灵活服务器 AAD 身份验证的标识 ID。 如果你是服务器 AAD 管理员，请将其忽略。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create mysql-flexible (serviceconnector-passwordless 扩展)

创建与 mysql 灵活连接的服务连接器本地连接。

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]
                                    [--new]
                                    [--no-wait]
                                    [--secret]
                                    [--server]
                                    [--service-principal]
                                    [--target-id]
                                    [--target-resource-group --tg]
                                    [--user-account]
                                    [--yes]

示例

以交互方式创建从本地到 mysql 灵活的连接

az connection create mysql-flexible -g resourceGroup

使用资源名称从本地到 mysql 灵活创建连接

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

使用资源 ID 从本地到 mysql 灵活创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

mysql 灵活数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--new

在数据库中创建新用户之前删除具有相同名称的现有用户。

属性	值
默认值:	False

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

用法：--secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name ：必需。 机密身份验证的用户名或帐户名称。机密：必需。 用于机密身份验证的密码或帐户密钥。

属性	值
Parameter group:	AuthType Arguments

--server

mysql 灵活服务器的名称。 如果未指定“--target-id”，则为必需。

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含 mysql 灵活服务器的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account mysql-identity-id=xx object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。 mysql-identity-id ：可选。 用于 MySQL 灵活服务器Microsoft Entra 身份验证的标识 ID。 如果你是服务器Microsoft Entra 管理员，请将其忽略。

属性	值
Parameter group:	AuthType Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create postgres

创建到 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 --tg]
                              [--user-account]

示例

以交互方式创建从本地到 postgres 的连接

az connection create postgres -g resourceGroup

使用资源名称从本地到 postgres 创建连接

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

使用资源 ID 从本地到 postgres 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

postgres 数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

用法：--secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name ：必需。 机密身份验证的用户名或帐户名称。机密：必需。 用于机密身份验证的密码或帐户密钥。

属性	值
Parameter group:	AuthType Arguments

--server

postgres 服务器的名称。 如果未指定“--target-id”，则为必需。

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含 postgres 服务的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create postgres-flexible

创建与 postgres 灵活连接的服务连接器本地连接。

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 --tg]
                                       [--user-account]

示例

以交互方式创建从本地到 postgres 灵活的连接

az connection create postgres-flexible -g resourceGroup

使用资源名称从本地到 postgres 灵活创建连接

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

使用资源 ID 从本地到 postgres 灵活创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

postgres 灵活数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

用法：--secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name ：必需。 机密身份验证的用户名或帐户名称。机密：必需。 用于机密身份验证的密码或帐户密钥。

属性	值
Parameter group:	AuthType Arguments

--server

postgres 灵活服务器的名称。 如果未指定“--target-id”，则为必需。

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含灵活 postgres 服务的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create postgres-flexible (serviceconnector-passwordless 扩展)

创建与 postgres 灵活连接的服务连接器本地连接。

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]
                                       [--new]
                                       [--no-wait]
                                       [--secret]
                                       [--server]
                                       [--service-principal]
                                       [--target-id]
                                       [--target-resource-group --tg]
                                       [--user-account]
                                       [--yes]

示例

以交互方式创建从本地到 postgres 灵活的连接

az connection create postgres-flexible -g resourceGroup

使用资源名称从本地到 postgres 灵活创建连接

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

使用资源 ID 从本地到 postgres 灵活创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

postgres 灵活数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--new

在数据库中创建新用户之前删除具有相同名称的现有用户。

属性	值
默认值:	False

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

用法：--secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name ：必需。 机密身份验证的用户名或帐户名称。机密：必需。 用于机密身份验证的密码或帐户密钥。

属性	值
Parameter group:	AuthType Arguments

--server

postgres 灵活服务器的名称。 如果未指定“--target-id”，则为必需。

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含灵活 postgres 服务的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create redis

创建与 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]
                           [--service-principal]
                           [--target-id]
                           [--target-resource-group --tg]
                           [--user-account]

示例

以交互方式创建从本地到 redis 的连接

az connection create redis -g resourceGroup

使用资源名称从本地到 redis 创建连接

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

使用资源 ID 从本地到 redis 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

redis 数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--server

redis 服务器的名称。 如果未指定“--target-id”，则为必需。

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含 redis 服务器的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create redis-enterprise

创建与 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 --tg]

示例

以交互方式创建从本地到 redis-enterprise 的连接

az connection create redis-enterprise -g resourceGroup

使用资源名称从本地到 redis-enterprise 创建连接

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

使用资源 ID 从本地到 redis-enterprise 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

redis 企业数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--server

redis 企业服务器的名称。 如果未指定“--target-id”，则为必需。

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含 redis 服务器的资源组。 如果未指定“--target-id”，则为必需。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create servicebus

创建到 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 --tg]
                                [--user-account]

示例

以交互方式创建从本地到 Servicebus 的连接

az connection create servicebus -g resourceGroup

使用资源名称创建从本地到 servicebus 的连接

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

使用资源 ID 从本地到 Servicebus 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, go, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--namespace

servicebus 命名空间的名称。 如果未指定“--target-id”，则为必需。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--namespace'] ，则为必需。

--target-resource-group --tg

包含 servicebus 的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create 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 --tg]
                             [--user-account]

示例

以交互方式从本地到信号器创建连接

az connection create signalr -g resourceGroup

使用资源名称从本地到信号器创建连接

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

使用资源 ID 从本地到信号器创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, none

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--signalr

信号器服务的名称。 如果未指定“--target-id”，则为必需。

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--signalr'] ，则为必需。

--target-resource-group --tg

包含信号器的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create sql

创建到 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 --tg]
                         [--user-account]

示例

以交互方式创建从本地到 sql 的连接

az connection create sql -g resourceGroup

使用资源名称从本地到 sql 创建连接

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

使用资源 ID 从本地到 sql 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

sql 数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

用法：--secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name ：必需。 机密身份验证的用户名或帐户名称。机密：必需。 用于机密身份验证的密码或帐户密钥。

属性	值
Parameter group:	AuthType Arguments

--server

SQL Server 的名称。 如果未指定“--target-id”，则为必需。

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含 sql Server 的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create sql (serviceconnector-passwordless 扩展)

创建到 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]
                         [--new]
                         [--no-wait]
                         [--secret]
                         [--server]
                         [--service-principal]
                         [--target-id]
                         [--target-resource-group --tg]
                         [--user-account]
                         [--yes]

示例

以交互方式创建从本地到 sql 的连接

az connection create sql -g resourceGroup

使用资源名称从本地到 sql 创建连接

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

使用资源 ID 从本地到 sql 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	django, dotnet, dotnet-internal, go, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--database

sql 数据库的名称。 如果未指定“--target-id”，则为必需。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--new

在数据库中创建新用户之前删除具有相同名称的现有用户。

属性	值
默认值:	False

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

用法：--secret name=XX secret=XX --secret name=XX secret-uri=XX --secret name=XX secret-name=XX

name ：必需。 机密身份验证的用户名或帐户名称。机密：必需。 用于机密身份验证的密码或帐户密钥。

属性	值
Parameter group:	AuthType Arguments

--server

SQL Server 的名称。 如果未指定“--target-id”，则为必需。

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'、'--server'、'--database']，则为必需。

--target-resource-group --tg

包含 sql Server 的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create storage-blob

创建到 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 --tg]
                                  [--user-account]

示例

以交互方式创建从本地到存储 blob 的连接

az connection create storage-blob -g resourceGroup

使用资源名称创建从本地到存储 Blob 的连接

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

使用资源 ID 从本地到存储 Blob 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

存储帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--account'，则为必需。

--target-resource-group --tg

包含存储帐户的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create 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 --tg]

示例

以交互方式创建从本地到存储文件的连接

az connection create storage-file -g resourceGroup

使用资源名称从本地到存储文件创建连接

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

使用资源 ID 从本地到存储文件创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

存储帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, php, python, ruby, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--account'，则为必需。

--target-resource-group --tg

包含存储帐户的资源组。 如果未指定“--target-id”，则为必需。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create 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 --tg]
                                   [--user-account]

示例

以交互方式从本地到存储队列创建连接

az connection create storage-queue -g resourceGroup

使用资源名称从本地到存储队列创建连接

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

使用资源 ID 从本地到存储队列创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

存储帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, python, springBoot

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--account'，则为必需。

--target-resource-group --tg

包含存储帐户的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create 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 --tg]
                                   [--user-account]

示例

以交互方式创建从本地到存储表的连接

az connection create storage-table -g resourceGroup

使用资源名称从本地到存储表创建连接

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

使用资源 ID 从本地到存储表创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--account

存储帐户的名称。 如果未指定“--target-id”，则为必需。

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, python

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--account'，则为必需。

--target-resource-group --tg

包含存储帐户的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az connection create webpubsub

创建到 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 --tg]
                               [--user-account]
                               [--webpubsub]

示例

以交互方式创建从本地到 Webpubsub 的连接

az connection create webpubsub -g resourceGroup

使用资源名称从本地到 Webpubsub 创建连接

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

使用资源 ID 从本地到 Webpubsub 创建连接

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

--client-type

在连接上使用的客户端类型。

属性	值
接受的值:	dotnet, dotnet-internal, java, nodejs, none, python

--connection

连接的名称。

--customized-keys

用于更改默认配置名称的自定义密钥。 键是原始名称，值为自定义名称。

--location -l

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--secret

机密身份验证信息。

Usage: --secret.

属性	值
Parameter group:	AuthType Arguments

--service-principal

服务主体身份验证信息。

用法：--service-principal client-id=XX secret=XX

client-id ：必需。 服务主体的客户端 ID。 object-id ：可选。 服务主体的对象 ID（企业应用程序）。 secret ：必需。 服务主体的机密。

属性	值
Parameter group:	AuthType Arguments

--target-id

目标服务的资源 ID。 如果未指定 ['--target-resource-group'， '--webpubsub']，则为必需。

--target-resource-group --tg

包含 webpubsub 的资源组。 如果未指定“--target-id”，则为必需。

--user-account

用户帐户身份验证信息。

用法：--user-account object-id=XX

object-id ：可选。 当前登录用户的对象 ID。 如果未提供，将自动设置它。

属性	值
Parameter group:	AuthType Arguments

--webpubsub

Webpubsub 服务的名称。 如果未指定“--target-id”，则为必需。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False