Azure CLI を使って Azure Cosmos DB アカウントのアカウントキーと接続文字列を操作する

[アーティクル]
04/13/2023

適用対象: NoSQL MongoDB Cassandra Gremlin Table

この記事のスクリプトでは、4 つの操作を示します。

すべてのアカウントキーを一覧表示する
読み取り専用アカウントキーを一覧表示する
接続文字列の一覧表示
アカウントキーを再生成する

このスクリプトでは NoSQL 用 API アカウントが使われていますが、これらの操作は Azure Cosmos DB のすべてのデータベース API で同一です。

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 を実行します。

この記事では、Azure CLI のバージョン 2.9.1 以降が必要です。 Azure Cloud Shell を使用している場合は、最新バージョンが既にインストールされています。

サンプルスクリプト

Azure Cloud Shell を起動する

Azure Cloud Shell は無料のインタラクティブシェルです。この記事の手順は、Azure Cloud Shell を使って実行することができます。一般的な Azure ツールが事前にインストールされており、アカウントで使用できるように構成されています。

Cloud Shell を開くには、コードブロックの右上隅にある [使ってみる] を選択します。 https://shell.azure.com に移動して、別のブラウザータブで Cloud Shell を起動することもできます。

Cloud Shell が開いたら、お使いの環境に対して Bash が選択されていることを確認します。後続のセッションでは、Bash 環境で Azure CLI を使用します。[コピー] を選択してコードのブロックをコピーし、Cloud Shell に貼り付けます。その後、Enter キーを押してそれを実行します。

Cloud Shell は、サインインした最初のアカウントで自動的に認証されます。別のサブスクリプションを使用してサインインするには、次のスクリプトを使用し、<Subscription ID> をご使用の Azure サブスクリプション ID に置き換えます。 Azure サブスクリプションをお持ちでない場合は、開始する前に Azure 無料アカウントを作成してください。

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="East US"
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

サンプルリファレンス

このスクリプトでは、次のコマンドを使用します。表内の各コマンドは、それぞれのドキュメントにリンクされています。

コマンド	メモ
az group create	すべてのリソースを格納するリソースグループを作成します。
az cosmosdb create	Azure Cosmos DB アカウントを作成します。
az cosmosdb keys list	Azure Cosmos DB アカウントのキーを一覧表示します。
az cosmosdb list-read-only-keys	Azure Cosmos DB アカウントの読み取り専用キーを一覧表示します。
az cosmosdb list-connection-strings	Azure Cosmos DB アカウントの接続文字列を一覧表示します。
az cosmosdb regenerate-key	Azure Cosmos DB アカウントのキーを再生成します。
az group delete	入れ子になったリソースすべてを含むリソースグループを削除します。

次のステップ

Azure Cosmos DB CLI の詳細については、Azure Cosmos DB CLI のドキュメントを参照してください。

具体的な API の Azure CLI サンプルについては、以下を参照してください。

Azure CLI を使って Azure Cosmos DB アカウントのアカウント キーと接続文字列を操作する

前提条件

サンプル スクリプト