Database Accounts - Regenerate Key

指定した Azure Cosmos DB データベース アカウントのアクセス キーを再生成します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey?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 Required Type Description
keyKind True

再生成するアクセス キー。

応答

Name Type Description
200 OK

[OK]

202 Accepted

受理されました。 再生成キー操作は非同期的に完了します。

セキュリティ

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 ユーザー アカウントの借用

CosmosDBDatabaseAccountRegenerateKey

Sample Request

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

{
  "keyKind": "primary"
}

Sample Response

定義

DatabaseAccountRegenerateKeyParameters

データベース アカウント内のキーを再生成するためのパラメーター。

KeyKind

再生成するアクセス キー。

DatabaseAccountRegenerateKeyParameters

データベース アカウント内のキーを再生成するためのパラメーター。

Name Type Description
keyKind

再生成するアクセス キー。

KeyKind

再生成するアクセス キー。

Name Type Description
primary
  • string
primaryReadonly
  • string
secondary
  • string
secondaryReadonly
  • string