通过 Azure CLI 使用 Azure Cosmos DB 帐户的帐户密钥和连接字符串

适用对象： NoSQL MongoDB Cassandra Gremlin 表

本文中的脚本演示了四个操作。

• 列出所有帐户密钥
• 列出只读帐户密钥
• 列出连接字符串
• 重新生成帐户密钥

此脚本使用 NoSQL API 帐户，但这些操作在 Azure Cosmos DB 中的所有数据库 API 中都是相同的。

如果没有 Azure 试用版订阅，请在开始前创建一个试用版订阅。

先决条件

可以使用本地 Azure CLI。

• 如果需要，请安装 Azure CLI 来运行 CLI 参考命令。

• 本地 Azure CLI，请了解如何安装 Azure CLI。 如果在 Windows 或 macOS 上运行，请考虑在 Docker 容器中运行 Azure CLI。 有关详细信息，请参阅如何在 Docker 容器中运行 Azure CLI。

  • 通过使用 az login 命令登录到 Azure CLI。 若要完成身份验证过程，请遵循终端中显示的步骤。 有关其他登录选项，请参阅使用 Azure CLI 登录。

  • 出现提示时，请在首次使用时安装 Azure CLI 扩展。 有关扩展详细信息，请参阅使用 Azure CLI 的扩展。

  • 运行 az version 以查找安装的版本和依赖库。 若要升级到最新版本，请运行 az upgrade。

• 本文需要 Azure CLI 版本 2.9.1 或更高版本。

  注意

  在可以在由世纪互联运营的 Microsoft Azure 中使用 Azure CLI 之前，请先运行 az cloud set -n AzureChinaCloud 来更改云环境。 若要切换回 Azure 公有云，请再次运行 az cloud set -n AzureCloud。

示例脚本

登录 Azure

使用以下脚本通过其他订阅登录，将 <Subscription ID> 替换为 Azure 订阅 ID。 如果没有 Azure 试用版订阅，请在开始前创建一个试用版订阅。

az cloud set -n AzureChinaCloud
az login

subscription="<subscriptionId>" # add subscription here

az account set -s $subscription # ...or use 'az login'

有关详细信息，请参阅设置有效的订阅或登录。

运行脚本

# Account key operations for an Azure Cosmos account

Variable block
let "randomIdentifier=$RANDOM*$RANDOM"
location="chinaeast2"
resourceGroup="msdocs-cosmosdb-rg-$randomIdentifier"
tag="keys-cosmosdb"
account="msdocs-account-cosmos-$randomIdentifier" #needs to be lower case

# Create a resource group
echo "Creating $resourceGroup in $location..."
az group create --name $resourceGroup --location "$location" --tags $tag

# Create a Cosmos DB account with default values
# Use appropriate values for --kind or --capabilities for other APIs
echo "Creating $account for CosmosDB"
az cosmosdb create --name $account --resource-group $resourceGroup

# List all account keys
az cosmosdb keys list --name $account --resource-group $resourceGroup

# List read-only keys
az cosmosdb keys list --name $account --resource-group $resourceGroup --type read-only-keys

# List connection strings
az cosmosdb keys list --name $account --resource-group $resourceGroup --type connection-strings

# Regenerate secondary account keys
# key-kind values: primary, primaryReadonly, secondary, secondaryReadonly
az cosmosdb keys regenerate --name $account --resource-group $resourceGroup --key-kind secondary

清理资源

使用 az group delete 命令删除资源组以及与其关联的所有资源 - 除非你持续需要这些资源。 其中一些资源在创建和删除时可能要稍等片刻。

az group delete --name $resourceGroup

示例参考

此脚本使用以下命令。 表中的每条命令均链接到特定于命令的文档。

后续步骤

有关 Azure Cosmos DB CLI 的详细信息，请参阅 Azure Cosmos DB CLI 文档。

有关特定 API 的 Azure CLI 示例，请参见：

• 适用于 Cassandra 的 CLI 示例
• Gremlin 的 CLI 示例
• 的 CLI 示例
• SQL 的 CLI 示例
• 适用于表的 CLI 示例