使用 PowerShell 的 Azure Cosmos DB 帐户的连接字符串和帐户密钥操作

  • 项目

适用对象： NoSQL MongoDB Cassandra Gremlin 表

注意

建议使用 Azure Az PowerShell 模块与 Azure 交互。 请参阅安装 Azure PowerShell 以开始使用。 若要了解如何迁移到 Az PowerShell 模块，请参阅 将 Azure PowerShell 从 AzureRM 迁移到 Az。

此示例需要 Az PowerShell 模块 5.4.0 或更高版本。 运行 Get-Module -ListAvailable Az，查看已安装哪些版本。 如果需要安装，请参阅安装 Azure PowerShell 模块。

运行 Connect-AzAccount -Environment AzureChinaCloud 以登录到 Azure。

示例脚本

注意

此示例演示如何使用 NoSQL API 帐户。 若要将此示例用于其他 API，请复制相关属性，并将其应用于 API 特定的脚本

# Reference: Az.CosmosDB | https://learn.microsoft.com/powershell/module/az.cosmosdb
# --------------------------------------------------
# Purpose
# List an account's connection strings and keys; regenerate a key.
# --------------------------------------------------
# Variables - ***** SUBSTITUTE YOUR VALUES *****
$resourceGroupName = "myResourceGroup" # Resource Group must already exist
$accountName = "myaccount" # Must be all lower case
$keyKind = "primary" # Other key kinds: secondary, primaryReadOnly, secondaryReadOnly
# --------------------------------------------------

Write-Host "List connection strings"
Get-AzCosmosDBAccountKey -ResourceGroupName $resourceGroupName `
    -Name $accountName -Type "ConnectionStrings"

Write-Host "List keys"
Get-AzCosmosDBAccountKey -ResourceGroupName $resourceGroupName `
    -Name $accountName -Type "Keys"

Write-Host "Reset key"
New-AzCosmosDBAccountKey  -ResourceGroupName $resourceGroupName `
    -Name $accountName -KeyKind $keyKind

清理部署

运行脚本示例后，可以使用以下命令删除资源组以及与其关联的所有资源。

Remove-AzResourceGroup -ResourceGroupName "myResourceGroup"

脚本说明

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

命令 注释
Azure Cosmos DB
Get-AzCosmosDBAccountKey 获取 Azure Cosmos DB 帐户的连接字符串或密钥（读写或只读）。
New-AzCosmosDBAccountKey 为 Azure Cosmos DB 帐户重新生成指定的密钥。
Azure 资源组
Remove-AzResourceGroup 删除资源组，包括所有嵌套的资源。

后续步骤

有关 Azure PowerShell 的详细信息，请参阅 Azure PowerShell 文档。