Database Accounts - List Read Only Keys

指定した Azure Cosmos DB データベース アカウントの読み取り専用アクセス キーを一覧表示します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys?api-version=2021-11-15-preview

URI パラメーター

Name In Required Type Description
accountName
path True
  • string

DB データベース アカウント名をCosmosします。

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True
  • string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True
  • string

ターゲット サブスクリプションの ID。

api-version
query True
  • string

この操作に使用する API バージョン。

応答

Name Type Description
200 OK

操作は正常に完了しました。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントの借用

CosmosDBDatabaseAccountListReadOnlyKeys

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/readonlykeys?api-version=2021-11-15-preview

Sample Response

{
  "primaryReadonlyMasterKey": "primaryReadonlyMasterKey",
  "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey"
}

定義

DatabaseAccountListReadOnlyKeysResult

特定のデータベース アカウントの読み取り専用アクセス キー。

Name Type Description
primaryReadonlyMasterKey
  • string

プライマリ読み取り専用キーの Base 64 でエンコードされた値。

secondaryReadonlyMasterKey
  • string

セカンダリ読み取り専用キーの Base 64 でエンコードされた値。