Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az batch account keys

Manage Batch account keys.

Commands

Name Description Type Status
az batch account keys list

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.

 Core GA
az batch account keys renew

Renew keys for a Batch account.

 Core GA

az batch account keys list

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.

[WARNING] The output includes secrets that you must protect. Be sure that you do not include these secrets in your source control. Also verify that no secrets are present in the logs of your command or script. For additional information, see http://aka.ms/clisecrets.

az batch account keys list --name
 --resource-group

Required Parameters

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

az batch account keys renew

Renew keys for a Batch account.

[WARNING] The output includes secrets that you must protect. Be sure that you do not include these secrets in your source control. Also verify that no secrets are present in the logs of your command or script. For additional information, see http://aka.ms/clisecrets.

az batch account keys renew [--acquire-policy-token]
 [--change-reference]
 [--key-name {Primary, Secondary}]
 [--name]
 [--resource-group]

Examples

Renew keys for a Batch account.

az batch account keys renew --name MyBatchAccount --resource-group MyResourceGroup --key-name primary

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--key-name

Name of the batch account key.

Property Value
Accepted values: Primary, Secondary
--name -n

Name of the batch account to show. If not specified will display currently set account.

--resource-group -g

Name of the resource group. If not specified will display currently set account.

Feedback

Was this page helpful?