az batch account

  • Reference

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

Edit

Create a Batch account with the specified parameters.

az batch account create --location
                        --name
                        --resource-group
                        [--encryption-key-identifier]
                        [--encryption-key-source {Microsoft.Batch, Microsoft.KeyVault}]
                        [--identity-type {None, SystemAssigned}]
                        [--keyvault]
                        [--no-wait]
                        [--public-network-access {Disabled, Enabled}]
                        [--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

--encryption-key-identifier

Part of the encryption configuration for the Batch account. Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053.

--encryption-key-source

Part of the encryption configuration for the Batch account. Type of the key source. Can be either Microsoft.Batch or Microsoft.KeyVault.

accepted values: Microsoft.Batch, Microsoft.KeyVault
--identity-type

The type of identity used for the Batch account.

accepted values: None, SystemAssigned
--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.

--public-network-access

The network access type for accessing Azure Batch account. Values can either be enabled or disabled.

accepted values: Disabled, Enabled
--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

Edit

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

Edit

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

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

Edit

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

Edit

Update properties for a Batch account.

az batch account set --name
                     --resource-group
                     [--encryption-key-identifier]
                     [--encryption-key-source]
                     [--identity-type {None, SystemAssigned}]
                     [--storage-account]
                     [--subscription]
                     [--tags]

Examples

Update properties for a Batch account. (autogenerated)

az batch account set --name MyBatchAccount --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the Batch account.

--resource-group -g

Name of the resource group.

Optional Parameters

--encryption-key-identifier

Part of the encryption configuration for the Batch account. Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053.

--encryption-key-source

Part of the encryption configuration for the Batch account. Type of the key source. Can be either Microsoft.Batch or Microsoft.KeyVault.

--identity-type

The type of identity used for the Batch account.

accepted values: None, SystemAssigned
--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: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az batch account show

Edit

Get a specified Batch account or the currently set account.

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

Examples

Get a specified Batch account or the currently set account. (autogenerated)

az batch account show --name MyBatchAccount --resource-group MyResourceGroup

Optional Parameters

--name -n

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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