az batch account keys

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage Batch account keys.

Commands

az batch account keys list	Gets the account keys for the specified Batch account.
az batch account keys renew	Renew keys for a Batch account.

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.

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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az batch account keys renew

Renew keys for a Batch account.

az batch account keys renew [--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

--key-name

Name of the batch account key.

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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.