az batch account

  • Reference

Manage Azure Batch accounts.

Commands

Name Description Type Status
az batch account autostorage-keys

Manage the access keys for the auto storage account configured for a Batch account.

 Core GA
az batch account autostorage-keys sync

Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.

 Core GA
az batch account create

Create a Batch account with the specified parameters.

 Core GA
az batch account delete

Deletes the specified Batch account.

 Core GA
az batch account identity

Manage identities of a batch account.

 Core GA
az batch account identity assign

Add managed identities to an existing batch account.

 Core GA
az batch account identity remove

Remove managed identities from an existing batch account.

 Core GA
az batch account identity show

Display managed identities of a batch account.

 Core GA
az batch account keys

Manage Batch account keys.

 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.

 Core GA
az batch account keys renew

Renew keys for a Batch account.

 Core GA
az batch account list

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

 Core GA
az batch account login

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

 Core GA
az batch account network-profile

Manage Batch account Network profiles.

 Core GA
az batch account network-profile network-rule

Manage Batch account Network rules in Network Profile.

 Core GA
az batch account network-profile network-rule add

Add a Network rule from a Network Profile.

 Core GA
az batch account network-profile network-rule delete

Delete a Network rule from a Network Profile.

 Core GA
az batch account network-profile network-rule list

List the Network rules from a Network Profile.

 Core GA
az batch account network-profile set

Set the Network profile for Batch account.

 Core GA
az batch account network-profile show

Get information about the Network profile for Batch account.

 Core GA
az batch account outbound-endpoints

List an account's outbound network dependencies.

 Core GA
az batch account set

Update properties for a Batch account.

 Core GA
az batch account show

Get a specified Batch account or the currently set account.

 Core GA

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}]
                        [--keyvault]
                        [--mi-system-assigned]
                        [--mi-user-assigned]
                        [--no-wait]
                        [--public-network-access {Disabled, Enabled}]
                        [--storage-account]
                        [--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
--keyvault

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

--mi-system-assigned

Set the system managed identity on the batch services account.

--mi-user-assigned

Resource ID of the user assigned identity for the batch services account.

--no-wait

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

default value: False
--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.

--tags

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 delete

Edit

Deletes the specified Batch account.

az batch account delete --name
                        --resource-group
                        [--no-wait]
                        [--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.

default value: False
--yes -y

Do not prompt for confirmation.

default value: False
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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 list

Edit

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

az batch account list [--resource-group]

Optional Parameters

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

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 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]

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.

default value: False
--show

Display the credential information for the Batch account.

default value: False
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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 outbound-endpoints

Edit

List an account's outbound network dependencies.

List the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/azure/batch/batch-virtual-network.".

az batch account outbound-endpoints --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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 set

Edit

Update properties for a Batch account.

az batch account set --name
                     --resource-group
                     [--encryption-key-identifier]
                     [--encryption-key-source]
                     [--public-network-access {Disabled, Enabled}]
                     [--storage-account]
                     [--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.

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 show

Edit

Get a specified Batch account or the currently set account.

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

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.

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

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.