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 |
The name of the Batch account. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group that contains the Batch account. |
subscription
|
path | True |
string |
The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) |
api-version
|
query | True |
string |
The API version to be used with the HTTP request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The operation was successful. The response contains the keys of the Batch account. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Microsoft Entra OAuth 2.0 auth code 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. |