Batch Account - Get Keys

Gets the account keys for the specified Batch account.
This operation applies only to Batch accounts created with a poolAllocationMode of 'BatchService'. If the Batch account was created with a poolAllocationMode of 'UserSubscription', clients cannot use access to keys to authenticate, and must use Azure Active Directory 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=2019-08-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

resourceGroupName
path True
  • string

The name of the resource group that contains the Batch account.

accountName
path True
  • string

The name of the Batch account.

Regex pattern: ^[-\w\._]+$

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

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

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

Sample Response

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

Definitions

BatchAccountKeys

A set of Azure Batch account keys.

CloudError

An error response from the Batch service.

CloudErrorBody

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

An error response from the Batch service.

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.