你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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-07-01-preview

URI 参数

Name In Required Type Description
accountName
path True
  • string

Cosmos DB 数据库帐户名称。

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

Azure Active Directory OAuth2 Flow

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-07-01-preview

{
  "keyKind": "primary"
}

Sample Response

定义

DatabaseAccountRegenerateKeyParameters

用于在数据库帐户中重新生成密钥的参数。

KeyKind

要重新生成的访问密钥。

DatabaseAccountRegenerateKeyParameters

用于在数据库帐户中重新生成密钥的参数。

Name Type Description
keyKind

要重新生成的访问密钥。

KeyKind

要重新生成的访问密钥。

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