Azure Cosmos DB でプライマリ、セカンダリ、読み取り、または読み取り/書き込みキーを取得する

Azure portal を使用して、次の 4 つの組み込みキーのいずれかを取得します。

• プライマリ読み取り/書き込み
• プライマリ読み取り専用
• セカンダリ読み取り/書き込み
• セカンダリ読み取り専用

1. Azure portal (https://portal.azure.com) にサインインします。

2. 既存の Azure Cosmos DB アカウントに移動します。

3. アカウント リソース ウィンドウで、サービス メニューの [設定] セクションから [キー] を選択します。

4. [読み取り/書き込みキー] または [読み取り専用] セクションで、[主キー] フィールドまたは [セカンダリ キー] フィールドの値を見つけて記録します。

   ヒント

   値を記録する前に、キーの表示が必要になる場合があります。 既定では、キーは非表示になっています。

この Azure CLI スクリプトを使用して、Azure Cosmos DB アカウントからキーまたは接続文字列を取得します。

az cosmosdb keys list \
    --resource-group "<name-of-existing-resource-group>" \
    --name "<name-of-existing-account>" \
    --type "keys"

--type 引数のオプションは次のとおりです。

• connection-strings
• keys
• read-only-keys

詳細については、az cosmosdb keys listを参照してください。

この Azure PowerShell スクリプトを使用して、Azure Cosmos DB アカウントからキーまたは接続文字列を取得します。

$parameters = @{
    ResourceGroupName = "<name-of-existing-resource-group>"
    Name = "<name-of-existing-account>"
    Type = "Keys"
}
Get-AzCosmosDBAccountKey @parameters

Type パラメーター のオプションは次のとおりです。

• ConnectionStrings
• Keys
• ReadOnlyKeys

詳細については、Get-AzCosmosDBAccountKeyを参照してください。

この例の Bicep テンプレートは、既存の Azure Cosmos DB アカウントのすべての資格情報を出力します。

metadata description = 'Gets all keys and connection strings for an Azure Cosmos DB account.'

@description('The name of the Azure Cosmos DB account.')
param accountName string

resource account 'Microsoft.DocumentDB/databaseAccounts@2024-05-15' existing = {
  name: accountName
}

output endpoint string = account.properties.documentEndpoint

var keys = account.listKeys()

output keys object = {
  primary: {
    readWrite: keys.primaryMasterKey
    readOnly: keys.primaryReadonlyMasterKey
  }
  secondary: {
    readWrite: keys.secondaryMasterKey
    readOnly: keys.secondaryReadonlyMasterKey
  }
}

var connectionStrings = account.listConnectionStrings()

output connectionStrings object = {
  primary: {
    readWrite: connectionStrings.connectionStrings[0].connectionString
    readOnly: connectionStrings.connectionStrings[1].connectionString
  }
  secondary: {
    readWrite: connectionStrings.connectionStrings[2].connectionString
    readOnly: connectionStrings.connectionStrings[3].connectionString
  }
}