使用 Azure CLI 針對 Azure Cosmos DB 帳戶新增區域、變更容錯移轉優先順序、觸發容錯移轉

發行項
03/18/2024

適用於：NoSQL MongoDB Cassandra Gremlin Table

本文中的指令碼會示範三項作業。

將區域新增至現有的 Azure Cosmos DB 帳戶。
變更區域容錯移轉優先順序 (適用於使用服務管理容錯移轉的帳戶)
觸發從主要到次要區域的手動容錯移轉 (適用於採用手動容錯移轉的帳戶)

此指令碼會使用 API for NoSQL 帳戶，但這些作業在 Azure Cosmos DB 的所有資料庫 API 中都相同。

重要

變更其他屬性時，無法在 Azure Cosmos DB 帳戶上新增和移除區域作業。

如果您沒有 Azure 訂閱，請在開始之前，先建立 Azure 免費帳戶。

必要條件

在 Azure Cloud Shell 中使用 Bash 環境。如需詳細資訊，請參閱 Azure Cloud Shell 中的 Bash 快速入門。
若要在本地執行 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。

本文需要 2.9.1 版或更新版本的 Azure CLI。如果您是使用 Azure Cloud Shell，就已安裝最新版本。

範例指令碼

啟動 Azure Cloud Shell

Azure Cloud Shell 是免費的互動式 Shell，可讓您用來執行本文中的步驟。它具有預先安裝和設定的共用 Azure 工具，可與您的帳戶搭配使用。

若要開啟 Cloud Shell，只要選取程式碼區塊右上角的 [試試看] 即可。您也可以移至 https://shell.azure.com ，從另一個瀏覽器索引標籤啟動 Cloud Shell。

當開啟 Cloud Shell 時，請確認已為您的環境選取 Bash。後續的工作階段將會在 Bash 環境中使用 Azure CLI，請選取 [複製] 以複製程式碼區塊，並將其貼到 Cloud Shell 中，然後按 Enter 鍵加以執行。

系統會在登入的初始帳戶下自動驗證 Cloud Shell。使用下列指令碼透過不同的訂閱登入，並將 <Subscription ID> 取代為您的 Azure 訂用帳戶識別碼。如果您沒有 Azure 訂用帳戶，請在開始之前先建立 Azure 免費帳戶。

subscription="<subscriptionId>" # add subscription here

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

如需詳細資訊，請參閱設定使用中訂閱或以互動方式登入

執行指令碼

# Region replica operations for an Azure Cosmos account

# Note: Azure Comos accounts cannot include updates to regions with changes to other properties in the same operation

# Variable block
let "randomIdentifier=$RANDOM*$RANDOM"
location="East US"
failoverLocation1="South Central US"
failoverLocation2="North Central US"
resourceGroup="msdocs-cosmosdb-rg-$randomIdentifier"
tag="regions-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

# Specify region failover locations and priorities
echo "Adding $failoverLocation1 and $failoverLocation2"
az cosmosdb update --name $account --resource-group $resourceGroup --locations regionName="$location" failoverPriority=0 isZoneRedundant=False --locations regionName="$failoverLocation1" failoverPriority=1 isZoneRedundant=False --locations regionName="$failoverLocation2" failoverPriority=2 isZoneRedundant=False

# Make failoverLocation2 the next region to fail over to instead of failoverLocation1 
echo "Switching failover priority"
az cosmosdb failover-priority-change --name $account --resource-group $resourceGroup --failover-policies "$location=0" "$failoverLocation1=2" "$failoverLocation2=1"

# Initiate a manual failover and promote failoverLocation1 as primary write region
echo "Failing over to $failoverLocation1"
az cosmosdb failover-priority-change --name $account --resource-group $resourceGroup --failover-policies "$location=2" "$failoverLocation1=0" "$failoverLocation2=1"

清除資源

您可以使用下列命令來移除資源群組及所有與其相關聯的資源，除非您仍持續需要這些資源，否則請使用 az group delete 命令。某些資源可能需要一些時間才能建立或刪除。

az group delete --name $resourceGroup

範例參考

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

Command	注意
az group create	建立用來存放所有資源的資源群組。
az cosmosdb create	建立 Azure Cosmos DB 帳戶。
az cosmosdb update	更新 Azure Cosmos DB 帳戶 (新增或移除區域)。
az cosmosdb failover-priority-change	更新 Azure Cosmos DB 帳戶的容錯移轉優先順序或觸發容錯移轉。
az group delete	刪除資源群組，包括所有的巢狀資源。

下一步

如需 Azure Cosmos DB CLI 的詳細資訊，請參閱 Azure Cosmos DB CLI 文件。

如需特定 API 的 Azure CLI 範例，請參閱：