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

Batch Account - Regenerate Key

重新生成 Batch 帐户的指定帐户密钥。
此操作仅适用于包含“SharedKey”的 allowedAuthenticationModes 的 Batch 帐户。 如果 Batch 帐户在其 allowedAuthenticationMode 中不包含“SharedKey”,则客户端无法使用共享密钥进行身份验证,并且必须改用其他 allowedAuthenticationModes。 在这种情况下,重新生成密钥将失败。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys?api-version=2024-02-01

URI 参数

名称 必需 类型 说明
accountName
path True

string

Batch 帐户的名称。

Regex pattern: ^[a-zA-Z0-9]+$

resourceGroupName
path True

string

包含 Batch 帐户的资源组的名称。

subscriptionId
path True

string

Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000)

api-version
query True

string

要与 HTTP 请求一起使用的 API 版本。

请求正文

名称 必需 类型 说明
keyName True

AccountKeyType

要重新生成的帐户密钥的类型。

响应

名称 类型 说明
200 OK

BatchAccountKeys

操作成功。 响应包含 Batch 帐户密钥。

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

BatchAccountRegenerateKey

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/regenerateKeys?api-version=2024-02-01

{
  "keyName": "Primary"
}

Sample Response

{
  "accountName": "sampleacct",
  "primary": "AAAA==",
  "secondary": "BBBB=="
}

定义

名称 说明
AccountKeyType

要重新生成的帐户密钥的类型。

BatchAccountKeys

一组Azure Batch帐户密钥。

BatchAccountRegenerateKeyParameters

提供给 RegenerateKey 操作的参数。

CloudError

Batch 服务的错误响应。

CloudErrorBody

Batch 服务的错误响应。

AccountKeyType

要重新生成的帐户密钥的类型。

名称 类型 说明
Primary

string

主帐户密钥。

Secondary

string

辅助帐户密钥。

BatchAccountKeys

一组Azure Batch帐户密钥。

名称 类型 说明
accountName

string

Batch 帐户名称。

primary

string

与帐户关联的主键。

secondary

string

与帐户关联的辅助密钥。

BatchAccountRegenerateKeyParameters

提供给 RegenerateKey 操作的参数。

名称 类型 说明
keyName

AccountKeyType

要重新生成的帐户密钥的类型。

CloudError

Batch 服务的错误响应。

名称 类型 说明
error

CloudErrorBody

错误响应的正文。

CloudErrorBody

Batch 服务的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,该消息适用于在用户界面中显示。

target

string

特定错误的目标。 例如,属性的名称出错。