使用 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 來登入 Azure。

範例指令碼

注意

此範例示範如何使用 API for NoSQL 帳戶。 若要針對其他 API 使用此範例，請複製相關的屬性，並套用至您的 API 專屬指令碼

# Reference: Az.CosmosDB | https://docs.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"

指令碼說明

此指令碼會使用下列命令。 下表中的每個命令都會連結至命令特定的文件。

Command	注意
Azure Cosmos DB
Get-AzCosmosDBAccountKey	取得 Azure Cosmos DB 帳戶的連接字串或金鑰 (讀寫或唯讀)。
New-AzCosmosDBAccountKey	針對 Azure Cosmos DB 帳戶重新產生指定的金鑰。
Azure 資源群組
Remove-AzResourceGroup	刪除資源群組，包括所有的巢狀資源。

下一步

如需有關 Azure PowerShell 的詳細資訊，請參閱 Azure PowerShell 文件。