Batch Account - Get Keys
Gets the account keys for the specified Batch account.
This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys?api-version=2024-07-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
account
|
path | True |
string minLength: 3maxLength: 24 pattern: ^[a-zA-Z0-9]+$ |
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
|
subscription
|
path | True |
string (uuid) |
The ID of the target subscription. The value must be an UUID. |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Azure operation completed successfully. |
|
| Other Status Codes |
An unexpected error response. |
Security
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 | impersonate your user account |
Examples
BatchAccountGetKeys
Sample request
Sample response
{
"accountName": "sampleacct",
"primary": "AAAA==",
"secondary": "BBBB=="
}
Definitions
| Name | Description |
|---|---|
|
Batch |
A set of Azure Batch account keys. |
|
Cloud |
An error response from the Batch service. |
|
Cloud |
An error response from the Batch service. |
BatchAccountKeys
A set of Azure Batch account keys.
| Name | Type | Description |
|---|---|---|
| accountName |
string |
The Batch account name. |
| primary |
string |
The primary key associated with the account. |
| secondary |
string |
The secondary key associated with the account. |
CloudError
An error response from the Batch service.
| Name | Type | Description |
|---|---|---|
| error |
The body of the error response. |
CloudErrorBody
An error response from the Batch service.
| Name | Type | Description |
|---|---|---|
| code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
| details |
A list of additional details about the error. |
|
| message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
| target |
string |
The target of the particular error. For example, the name of the property in error. |