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-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 形式の文字列 (例: 000000000-0000-0000-0000-0000-000000000000000000000000000000) です。

api-version
query True

string

HTTP 要求で使用される API バージョン。

応答

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

BatchAccountGetKeys

Sample Request

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

Sample Response

{
  "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

特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。