Batch Account - Update

Updates the properties of an existing Batch account.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}?api-version=2023-05-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The name of the Batch account.

Regex pattern: ^[a-zA-Z0-9]+$

resourceGroupName
path True

string

The name of the resource group that contains the Batch account.

subscriptionId
path True

string

The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

api-version
query True

string

The API version to be used with the HTTP request.

Request Body

Name Type Description
identity

BatchAccountIdentity

The identity of the Batch account.

properties.allowedAuthenticationModes

AuthenticationMode[]

List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.

properties.autoStorage

AutoStorageBaseProperties

The properties related to the auto-storage account.

properties.encryption

EncryptionProperties

The encryption configuration for the Batch account.
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.

properties.networkProfile

NetworkProfile

Network profile for Batch account, which contains network rule settings for each endpoint.
The network profile only takes effect when publicNetworkAccess is enabled.

properties.publicNetworkAccess

PublicNetworkAccessType

The network access type for accessing Azure Batch account.
If not specified, the default value is 'enabled'.

tags

object

The user-specified tags associated with the account.

Responses

Name Type Description
200 OK

BatchAccount

The operation was successful. The response contains the Batch account entity.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

BatchAccountUpdate

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2023-05-01

{
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  }
}

Sample Response

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

Definitions

Name Description
AuthenticationMode

The authentication mode for the Batch account.

AutoStorageAuthenticationMode

The authentication mode which the Batch service will use to manage the auto-storage account.

AutoStorageBaseProperties

The properties related to the auto-storage account.

AutoStorageProperties

Contains information about the auto-storage account associated with a Batch account.

BatchAccount

Contains information about an Azure Batch account.

BatchAccountIdentity

The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when ManagedIdentity is selected as the auto-storage authentication mode.

BatchAccountUpdateParameters

Parameters for updating an Azure Batch account.

CloudError

An error response from the Batch service.

CloudErrorBody

An error response from the Batch service.

ComputeNodeIdentityReference

The reference to a user assigned identity associated with the Batch pool which a compute node will use.

EncryptionProperties

Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.

EndpointAccessDefaultAction

The default action when there is no IPRule matched.

EndpointAccessProfile

Network access profile for Batch endpoint.

IPRule

Rule to filter client IP address.

IPRuleAction

Action when client IP address is matched.

KeySource

Type of the key source.

KeyVaultProperties

KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.

KeyVaultReference

Identifies the Azure key vault associated with a Batch account.

NetworkProfile

Network profile for Batch account, which contains network rule settings for each endpoint.

PoolAllocationMode

The allocation mode for creating pools in the Batch account.

PrivateEndpoint

The private endpoint of the private endpoint connection.

PrivateEndpointConnection

Contains information about a private link resource.

PrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection.

PrivateLinkServiceConnectionState

The private link service connection state of the private endpoint connection

PrivateLinkServiceConnectionStatus

The status of the Batch private endpoint connection

ProvisioningState

The provisioned state of the resource

PublicNetworkAccessType

The network access type for operating on the resources in the Batch account.

ResourceIdentityType

The type of identity used for the Batch account.

UserAssignedIdentities

The list of associated user identities.

VirtualMachineFamilyCoreQuota

A VM Family and its associated core quota for the Batch account.

AuthenticationMode

The authentication mode for the Batch account.

Name Type Description
AAD

string

The authentication mode using Azure Active Directory.

SharedKey

string

The authentication mode using shared keys.

TaskAuthenticationToken

string

The authentication mode using task authentication tokens.

AutoStorageAuthenticationMode

The authentication mode which the Batch service will use to manage the auto-storage account.

Name Type Description
BatchAccountManagedIdentity

string

The Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account.

StorageKeys

string

The Batch service will authenticate requests to auto-storage using storage account keys.

AutoStorageBaseProperties

The properties related to the auto-storage account.

Name Type Default Value Description
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

The authentication mode which the Batch service will use to manage the auto-storage account.

nodeIdentityReference

ComputeNodeIdentityReference

The reference to the user assigned identity which compute nodes will use to access auto-storage.
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.

storageAccountId

string

The resource ID of the storage account to be used for auto-storage account.

AutoStorageProperties

Contains information about the auto-storage account associated with a Batch account.

Name Type Default Value Description
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

The authentication mode which the Batch service will use to manage the auto-storage account.

lastKeySync

string

The UTC time at which storage keys were last synchronized with the Batch account.

nodeIdentityReference

ComputeNodeIdentityReference

The reference to the user assigned identity which compute nodes will use to access auto-storage.
The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.

storageAccountId

string

The resource ID of the storage account to be used for auto-storage account.

BatchAccount

Contains information about an Azure Batch account.

Name Type Default Value Description
id

string

The ID of the resource.

identity

BatchAccountIdentity

The identity of the Batch account.

location

string

The location of the resource.

name

string

The name of the resource.

properties.accountEndpoint

string

The account endpoint used to interact with the Batch service.

properties.activeJobAndJobScheduleQuota

integer

The active job and job schedule quota for the Batch account.

properties.allowedAuthenticationModes

AuthenticationMode[]

List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.

properties.autoStorage

AutoStorageProperties

The properties and status of any auto-storage account associated with the Batch account.
Contains information about the auto-storage account associated with a Batch account.

properties.dedicatedCoreQuota

integer

The dedicated core quota for the Batch account.
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

properties.dedicatedCoreQuotaPerVMFamily

VirtualMachineFamilyCoreQuota[]

A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

properties.dedicatedCoreQuotaPerVMFamilyEnforced

boolean

A value indicating whether core quotas per Virtual Machine family are enforced for this account
If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.

properties.encryption

EncryptionProperties

The encryption configuration for the Batch account.
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.

properties.keyVaultReference

KeyVaultReference

A reference to the Azure key vault associated with the Batch account.
Identifies the Azure key vault associated with a Batch account.

properties.lowPriorityCoreQuota

integer

The Spot/low-priority core quota for the Batch account.
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

properties.networkProfile

NetworkProfile

Network profile for Batch account, which contains network rule settings for each endpoint.
The network profile only takes effect when publicNetworkAccess is enabled.

properties.nodeManagementEndpoint

string

The endpoint used by compute node to connect to the Batch node management service.

properties.poolAllocationMode

PoolAllocationMode

The allocation mode to use for creating pools in the Batch account.
The allocation mode for creating pools in the Batch account.

properties.poolQuota

integer

The pool quota for the Batch account.

properties.privateEndpointConnections

PrivateEndpointConnection[]

List of private endpoint connections associated with the Batch account

properties.provisioningState

ProvisioningState

The provisioned state of the resource

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

The network interface type for accessing Azure Batch service and Batch account operations.
If not specified, the default value is 'enabled'.

tags

object

The tags of the resource.

type

string

The type of the resource.

BatchAccountIdentity

The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when ManagedIdentity is selected as the auto-storage authentication mode.

Name Type Description
principalId

string

The principal id of the Batch account. This property will only be provided for a system assigned identity.

tenantId

string

The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.

type

ResourceIdentityType

The type of identity used for the Batch account.

userAssignedIdentities

<string,  UserAssignedIdentities>

The list of user identities associated with the Batch account.

BatchAccountUpdateParameters

Parameters for updating an Azure Batch account.

Name Type Default Value Description
identity

BatchAccountIdentity

The identity of the Batch account.

properties.allowedAuthenticationModes

AuthenticationMode[]

List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.

properties.autoStorage

AutoStorageBaseProperties

The properties related to the auto-storage account.

properties.encryption

EncryptionProperties

The encryption configuration for the Batch account.
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.

properties.networkProfile

NetworkProfile

Network profile for Batch account, which contains network rule settings for each endpoint.
The network profile only takes effect when publicNetworkAccess is enabled.

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

The network access type for accessing Azure Batch account.
If not specified, the default value is 'enabled'.

tags

object

The user-specified tags associated with the account.

CloudError

An error response from the Batch service.

Name Type Description
error

CloudErrorBody

The body of the error response.

CloudErrorBody

An error response from the Batch service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ComputeNodeIdentityReference

The reference to a user assigned identity associated with the Batch pool which a compute node will use.

Name Type Description
resourceId

string

The ARM resource id of the user assigned identity.

EncryptionProperties

Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.

Name Type Description
keySource

KeySource

Type of the key source.

keyVaultProperties

KeyVaultProperties

Additional details when using Microsoft.KeyVault

EndpointAccessDefaultAction

The default action when there is no IPRule matched.

Name Type Description
Allow

string

Allow client access.

Deny

string

Deny client access.

EndpointAccessProfile

Network access profile for Batch endpoint.

Name Type Description
defaultAction

EndpointAccessDefaultAction

The default action when there is no IPRule matched.
Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.

ipRules

IPRule[]

Array of IP ranges to filter client IP address.

IPRule

Rule to filter client IP address.

Name Type Description
action

IPRuleAction

Action when client IP address is matched.

value

string

The IP address or IP address range to filter
IPv4 address, or IPv4 address range in CIDR format.

IPRuleAction

Action when client IP address is matched.

Name Type Description
Allow

string

Allow access for the matched client IP address.

KeySource

Type of the key source.

Name Type Description
Microsoft.Batch

string

Batch creates and manages the encryption keys used to protect the account data.

Microsoft.KeyVault

string

The encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to SystemAssigned and a valid Key Identifier must also be supplied under the keyVaultProperties.

KeyVaultProperties

KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.

Name Type Description
keyIdentifier

string

Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

KeyVaultReference

Identifies the Azure key vault associated with a Batch account.

Name Type Description
id

string

The resource ID of the Azure key vault associated with the Batch account.

url

string

The URL of the Azure key vault associated with the Batch account.

NetworkProfile

Network profile for Batch account, which contains network rule settings for each endpoint.

Name Type Description
accountAccess

EndpointAccessProfile

Network access profile for batchAccount endpoint (Batch account data plane API).

nodeManagementAccess

EndpointAccessProfile

Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).

PoolAllocationMode

The allocation mode for creating pools in the Batch account.

Name Type Description
BatchService

string

Pools will be allocated in subscriptions owned by the Batch service.

UserSubscription

string

Pools will be allocated in a subscription owned by the user.

PrivateEndpoint

The private endpoint of the private endpoint connection.

Name Type Description
id

string

The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Contains information about a private link resource.

Name Type Description
etag

string

The ETag of the resource, used for concurrency statements.

id

string

The ID of the resource.

name

string

The name of the resource.

properties.groupIds

string[]

The group id of the private endpoint connection.
The value has one and only one group id.

properties.privateEndpoint

PrivateEndpoint

The ARM resource identifier of the private endpoint.
The private endpoint of the private endpoint connection.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

The private link service connection state of the private endpoint connection.
The private link service connection state of the private endpoint connection

properties.provisioningState

PrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection.

type

string

The type of the resource.

PrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection.

Name Type Description
Cancelled

string

The user has cancelled the connection creation.

Creating

string

The connection is creating.

Deleting

string

The connection is deleting.

Failed

string

The user requested that the connection be updated and it failed. You may retry the update operation.

Succeeded

string

The connection status is final and is ready for use if Status is Approved.

Updating

string

The user has requested that the connection status be updated, but the update operation has not yet completed. You may not reference the connection when connecting the Batch account.

PrivateLinkServiceConnectionState

The private link service connection state of the private endpoint connection

Name Type Description
actionsRequired

string

Action required on the private connection state

description

string

Description of the private Connection state

status

PrivateLinkServiceConnectionStatus

The status for the private endpoint connection of Batch account

PrivateLinkServiceConnectionStatus

The status of the Batch private endpoint connection

Name Type Description
Approved

string

The private endpoint connection is approved and can be used to access Batch account

Disconnected

string

The private endpoint connection is disconnected and cannot be used to access Batch account

Pending

string

The private endpoint connection is pending and cannot be used to access Batch account

Rejected

string

The private endpoint connection is rejected and cannot be used to access Batch account

ProvisioningState

The provisioned state of the resource

Name Type Description
Cancelled

string

The last operation for the account is cancelled.

Creating

string

The account is being created.

Deleting

string

The account is being deleted.

Failed

string

The last operation for the account is failed.

Invalid

string

The account is in an invalid state.

Succeeded

string

The account has been created and is ready for use.

PublicNetworkAccessType

The network access type for operating on the resources in the Batch account.

Name Type Description
Disabled

string

Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource.

Enabled

string

Enables connectivity to Azure Batch through public DNS.

ResourceIdentityType

The type of identity used for the Batch account.

Name Type Description
None

string

Batch account has no identity associated with it. Setting None in update account will remove existing identities.

SystemAssigned

string

Batch account has a system assigned identity with it.

UserAssigned

string

Batch account has user assigned identities with it.

UserAssignedIdentities

The list of associated user identities.

Name Type Description
clientId

string

The client id of user assigned identity.

principalId

string

The principal id of user assigned identity.

VirtualMachineFamilyCoreQuota

A VM Family and its associated core quota for the Batch account.

Name Type Description
coreQuota

integer

The core quota for the VM family for the Batch account.

name

string

The Virtual Machine family name.