az batch account

Manage Azure Batch accounts.

Commands

az batch account autostorage-keys Manage the access keys for the auto storage account configured for a Batch account.
az batch account autostorage-keys sync Synchronizes access keys for the auto-storage account configured for the specified Batch account.
az batch account create Create a Batch account with the specified parameters.
az batch account delete Deletes the specified Batch account.
az batch account keys Manage Batch account keys.
az batch account keys list Gets the account keys for the specified Batch account.
az batch account keys renew Regenerates the specified account key for the Batch account.
az batch account list List the Batch accounts associated with a subscription or resource group.
az batch account login Log in to a Batch account through Azure Active Directory or Shared Key authentication.
az batch account set Update properties for a Batch account.
az batch account show Get a specified Batch account or the currently set account.

az batch account create

Create a Batch account with the specified parameters.

az batch account create --location
                        --name
                        --resource-group
                        [--keyvault]
                        [--no-wait]
                        [--storage-account]
                        [--subscription]
                        [--tags]

Required Parameters

--location -l

The region in which to create the account.

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

Optional Parameters

--keyvault

The KeyVault name or resource ID to be used for an account with a pool allocation mode of 'User Subscription'.

--no-wait

Do not wait for the long-running operation to finish.

--storage-account

The storage account name or resource ID to be used for auto storage.

--subscription

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

--tags

Space-separated tags in 'key[=value]' format.

az batch account delete

Deletes the specified Batch account.

az batch account delete --name
                        --resource-group
                        [--no-wait]
                        [--subscription]
                        [--yes]

Required Parameters

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--subscription

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

--yes -y

Do not prompt for confirmation.

az batch account list

List the Batch accounts associated with a subscription or resource group.

az batch account list [--resource-group]
                      [--subscription]

Optional Parameters

--resource-group -g

Name of the resource group.

--subscription

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

az batch account login

Log in to a Batch account through Azure Active Directory or Shared Key authentication.

az batch account login --name
                       --resource-group
                       [--shared-key-auth]
                       [--show]
                       [--subscription]

Required Parameters

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

Optional Parameters

--shared-key-auth

Using Shared Key authentication, if not specified, it will use Azure Active Directory authentication.

--show

Display the credential information for the Batch account.

--subscription

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

az batch account set

Update properties for a Batch account.

az batch account set --name
                     --resource-group
                     [--storage-account]
                     [--subscription]
                     [--tags]

Required Parameters

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

Optional Parameters

--storage-account

The storage account name or resource ID to be used for auto storage.

--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

az batch account show

Get a specified Batch account or the currently set account.

az batch account show [--name]
                      [--resource-group]
                      [--subscription]

Optional Parameters

--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.

--subscription

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