PowerShell を使用して、単一の書き込みリージョンで構成された Azure Cosmos DB アカウントのフェールオーバー優先度を変更する、またはフェールオーバーをトリガーする
適用対象: 
NoSQL MongoDB Cassandra Gremlin Table
Note
Azure を操作するには、Azure Az PowerShell モジュールを使用することをお勧めします。 作業を開始するには、Azure PowerShell のインストールに関する記事を参照してください。 Az PowerShell モジュールに移行する方法については、「AzureRM から Az への Azure PowerShell の移行」を参照してください。
このサンプルには、Azure PowerShell Az 5.4.0 以降が必要です。 Get-Module -ListAvailable Az を実行して、インストールされているバージョンを確認します。
インストールする必要がある場合は、Azure PowerShell モジュールのインストールに関するページを参照してください。
Connect-AzAccount を実行して Azure にサインインします。
サンプル スクリプト
注意
手動フェールオーバーは、failoverPriority=0 のリージョンを変更した場合にトリガーされ、また、手動フェールオーバー用に構成されたアカウントに対してのみ実行できます。 それ以外は、どのリージョンを変更しても、Azure Cosmos DB アカウントのフェールオーバー優先度が変更されるだけです。
注意
このサンプルでは、NoSQL 用 API アカウントの使用方法を紹介しています。 このサンプルを他の API で使用する場合は、関連するプロパティをコピーし、お使いの API 固有のスクリプトに適用してください。
# Reference: Az.CosmosDB | https://docs.microsoft.com/powershell/module/az.cosmosdb
# --------------------------------------------------
# Purpose
# Update Cosmos DB account: Change region failover priority.
# Note: updating location at priority 0 triggers a failover to the new location
# --------------------------------------------------
# Variables - ***** SUBSTITUTE YOUR VALUES *****
$resourceGroupName = "myResourceGroup" # Resource Group must already exist
$accountName = "myaccount" # Must be all lower case
$locations = @("West US", "East US") # Regions ordered by UPDATED failover priority
# --------------------------------------------------
# Get existing Cosmos DB account
$account = Get-AzCosmosDBAccount -ResourceGroupName $resourceGroupName -Name $accountName
# Update account failover priority
Update-AzCosmosDBAccountFailoverPriority -InputObject $account -FailoverPolicy $locations
デプロイのクリーンアップ
スクリプト サンプルの実行後は、次のコマンドを使用してリソース グループとすべての関連リソースを削除することができます。
Remove-AzResourceGroup -ResourceGroupName "myResourceGroup"
スクリプトの説明
このスクリプトでは、次のコマンドを使用します。 表内の各コマンドは、それぞれのドキュメントにリンクされています。
| コマンド | Notes |
|---|---|
| Azure Cosmos DB | |
| Get-AzCosmosDBAccount | Azure Cosmos DB アカウントを一覧表示します。または、指定された Azure Cosmos DB アカウントを取得します。 |
| Update-AzCosmosDBAccountFailoverPriority | Azure Cosmos DB アカウントのリージョンに対するフェールオーバーの優先順位を更新します。 |
| Azure リソース グループ | |
| Remove-AzResourceGroup | 入れ子になったリソースすべてを含むリソース グループを削除します。 |
次のステップ
Azure PowerShell の詳細については、Azure PowerShell のドキュメントを参照してください。