你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az cosmosdb keys

  • 参考

管理 Azure Cosmos DB 密钥。

命令

名称 说明 类型 状态
az cosmosdb keys list

列出 Azure Cosmos DB 数据库帐户的访问密钥或连接字符串。

 核心 GA
az cosmosdb keys regenerate

重新生成 Azure Cosmos DB 数据库帐户的访问密钥。

 核心 GA

az cosmosdb keys list

编辑

列出 Azure Cosmos DB 数据库帐户的访问密钥或连接字符串。

az cosmosdb keys list --name
                      --resource-group
                      [--type {connection-strings, keys, read-only-keys}]

示例

列出 Azure Cosmos DB 数据库帐户的访问密钥或连接字符串。 （自动生成）

az cosmosdb keys list --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription --type keys

必需参数

--name -n

Cosmosdb 帐户名称。

--resource-group -g

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

可选参数

--type

帐户密钥的类型。

接受的值: connection-strings, keys, read-only-keys
默认值: keys
全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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

az cosmosdb keys regenerate

编辑

重新生成 Azure Cosmos DB 数据库帐户的访问密钥。

az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

示例

重新生成 Azure Cosmos DB 数据库帐户的 primaryReadonly 访问密钥。

az cosmosdb keys regenerate --key-kind primaryReadonly --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

必需参数

--key-kind

要重新生成的访问密钥。

接受的值: primary, primaryReadonly, secondary, secondaryReadonly

可选参数

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

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

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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