Batch Account - Get Keys

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

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

URI 参数

名称 必需 类型 说明
accountName
path True

string

minLength: 3
maxLength: 24
pattern: ^[a-zA-Z0-9]+$

Batch 帐户的名称。

resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

要用于 HTTP 请求的 API 版本。

响应

名称 类型 说明
200 OK

BatchAccountKeys

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

Other Status Codes

CloudError

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

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

BatchAccountGetKeys

示例请求

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

示例响应

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

定义

名称 说明
BatchAccountKeys

一组 Azure Batch 帐户密钥。

CloudError

Batch 服务的错误响应。

CloudErrorBody

Batch 服务的错误响应。

BatchAccountKeys

一组 Azure Batch 帐户密钥。

名称 类型 说明
accountName

string

Batch 帐户名称。

primary

string

与帐户关联的主键。

secondary

string

与帐户关联的辅助密钥。

CloudError

Batch 服务的错误响应。

名称 类型 说明
error

CloudErrorBody

错误响应的正文。

CloudErrorBody

Batch 服务的错误响应。

名称 类型 说明
code

string

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

details

CloudErrorBody[]

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

message

string

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

target

string

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