Microsoft.Batch (stable:2025-06-01)

2026/01/06 • 42 new methods

BatchAccount_Create (new)
Description :  Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for account creation. ,
Required: True ,
}
{
location:
{
Description: The region in which to create the account. ,
Required: True ,
}
string ,
tags:
{
Description: The user-specified tags associated with the account. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the Batch account. ,
Required: False ,
}
{
autoStorage:
{
Description: The properties related to the auto-storage account. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to be used for auto-storage account. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationMode:
{
Description: The authentication mode which the Batch service will use to manage the auto-storage account. ,
Enum:
{
StorageKeys: The Batch service will authenticate requests to auto-storage using storage account keys. ,
BatchAccountManagedIdentity: The Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account. ,
}
,
Required: False ,
}
enum ,
nodeIdentityReference:
{
Description: The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
poolAllocationMode:
{
Description: The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService. ,
Enum:
{
BatchService: Pools will be allocated in subscriptions owned by the Batch service. ,
UserSubscription: Pools will be allocated in a subscription owned by the user. ,
}
,
Required: False ,
}
enum ,
keyVaultReference:
{
Description: A reference to the Azure key vault associated with the Batch account. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the Azure key vault associated with the Batch account. ,
Format: arm-id ,
Required: True ,
}
string ,
url:
{
Description: The URL of the Azure key vault associated with the Batch account. ,
Required: True ,
}
string ,
}
,
publicNetworkAccess:
{
Description: If not specified, the default value is 'enabled'. ,
Enum:
{
Enabled: Enables connectivity to Azure Batch through public DNS. ,
Disabled: Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource. ,
SecuredByPerimeter: Secures connectivity to Azure Batch through NSP configuration. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile only takes effect when publicNetworkAccess is enabled. ,
Required: False ,
}
{
accountAccess:
{
Description: Network access profile for batchAccount endpoint (Batch account data plane API). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
nodeManagementAccess:
{
Description: Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
encryption:
{
Description: 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. ,
Required: False ,
}
{
keySource:
{
Description: Type of the key source. ,
Enum:
{
Microsoft.Batch: Batch creates and manages the encryption keys used to protect the account data. ,
Microsoft.KeyVault: 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. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Additional details when using Microsoft.KeyVault ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
}
,
allowedAuthenticationModes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The identity of the Batch account. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the Batch account. ,
Enum:
{
SystemAssigned: Batch account has a system assigned identity with it. ,
UserAssigned: Batch account has user assigned identities with it. ,
None: Batch account has no identity associated with it. Setting `None` in update account will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the account. ,
Required: False ,
}
{
accountEndpoint:
{
Description: The account endpoint used to interact with the Batch service. ,
Required: False ,
}
string ,
nodeManagementEndpoint:
{
Description: The endpoint used by compute node to connect to the Batch node management service. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Invalid: The account is in an invalid state. ,
Creating: The account is being created. ,
Deleting: The account is being deleted. ,
Succeeded: The account has been created and is ready for use. ,
Failed: The last operation for the account is failed. ,
Cancelled: The last operation for the account is cancelled. ,
}
,
Required: False ,
}
enum ,
poolAllocationMode:
{
Description: The allocation mode for creating pools in the Batch account. ,
Enum:
{
BatchService: Pools will be allocated in subscriptions owned by the Batch service. ,
UserSubscription: Pools will be allocated in a subscription owned by the user. ,
}
,
Required: False ,
}
enum ,
keyVaultReference:
{
Description: Identifies the Azure key vault associated with a Batch account. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the Azure key vault associated with the Batch account. ,
Format: arm-id ,
Required: True ,
}
string ,
url:
{
Description: The URL of the Azure key vault associated with the Batch account. ,
Required: True ,
}
string ,
}
,
publicNetworkAccess:
{
Description: If not specified, the default value is 'enabled'. ,
Enum:
{
Enabled: Enables connectivity to Azure Batch through public DNS. ,
Disabled: Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource. ,
SecuredByPerimeter: Secures connectivity to Azure Batch through NSP configuration. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile only takes effect when publicNetworkAccess is enabled. ,
Required: False ,
}
{
accountAccess:
{
Description: Network access profile for batchAccount endpoint (Batch account data plane API). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
nodeManagementAccess:
{
Description: Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the Batch account ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
autoStorage:
{
Description: Contains information about the auto-storage account associated with a Batch account. ,
Required: False ,
}
{
lastKeySync:
{
Description: The UTC time at which storage keys were last synchronized with the Batch account. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
encryption:
{
Description: 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. ,
Required: False ,
}
{
keySource:
{
Description: Type of the key source. ,
Enum:
{
Microsoft.Batch: Batch creates and manages the encryption keys used to protect the account data. ,
Microsoft.KeyVault: 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. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Additional details when using Microsoft.KeyVault ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
}
,
dedicatedCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
lowPriorityCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
dedicatedCoreQuotaPerVMFamily:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The Virtual Machine family name. ,
Required: False ,
}
string ,
coreQuota:
{
Description: The core quota for the VM family for the Batch account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dedicatedCoreQuotaPerVMFamilyEnforced:
{
Description: 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. ,
Required: False ,
}
boolean ,
poolQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
activeJobAndJobScheduleQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
allowedAuthenticationModes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The identity of the Batch account. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the Batch account. ,
Enum:
{
SystemAssigned: Batch account has a system assigned identity with it. ,
UserAssigned: Batch account has user assigned identities with it. ,
None: Batch account has no identity associated with it. Setting `None` in update account will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_Update (new)
Description :  Updates the properties of an existing Batch account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for account update. ,
Required: True ,
}
{
tags:
{
Description: The user-specified tags associated with the account. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the account. ,
Required: False ,
}
{
autoStorage:
{
Description: The properties related to the auto-storage account. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to be used for auto-storage account. ,
Format: arm-id ,
Required: True ,
}
string ,
authenticationMode:
{
Description: The authentication mode which the Batch service will use to manage the auto-storage account. ,
Enum:
{
StorageKeys: The Batch service will authenticate requests to auto-storage using storage account keys. ,
BatchAccountManagedIdentity: The Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account. ,
}
,
Required: False ,
}
enum ,
nodeIdentityReference:
{
Description: The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
encryption:
{
Description: 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. ,
Required: False ,
}
{
keySource:
{
Description: Type of the key source. ,
Enum:
{
Microsoft.Batch: Batch creates and manages the encryption keys used to protect the account data. ,
Microsoft.KeyVault: 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. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Additional details when using Microsoft.KeyVault ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
}
,
allowedAuthenticationModes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
publicNetworkAccess:
{
Description: If not specified, the default value is 'enabled'. ,
Enum:
{
Enabled: Enables connectivity to Azure Batch through public DNS. ,
Disabled: Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource. ,
SecuredByPerimeter: Secures connectivity to Azure Batch through NSP configuration. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile only takes effect when publicNetworkAccess is enabled. ,
Required: False ,
}
{
accountAccess:
{
Description: Network access profile for batchAccount endpoint (Batch account data plane API). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
nodeManagementAccess:
{
Description: Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
identity:
{
Description: The identity of the Batch account. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the Batch account. ,
Enum:
{
SystemAssigned: Batch account has a system assigned identity with it. ,
UserAssigned: Batch account has user assigned identities with it. ,
None: Batch account has no identity associated with it. Setting `None` in update account will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the account. ,
Required: False ,
}
{
accountEndpoint:
{
Description: The account endpoint used to interact with the Batch service. ,
Required: False ,
}
string ,
nodeManagementEndpoint:
{
Description: The endpoint used by compute node to connect to the Batch node management service. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Invalid: The account is in an invalid state. ,
Creating: The account is being created. ,
Deleting: The account is being deleted. ,
Succeeded: The account has been created and is ready for use. ,
Failed: The last operation for the account is failed. ,
Cancelled: The last operation for the account is cancelled. ,
}
,
Required: False ,
}
enum ,
poolAllocationMode:
{
Description: The allocation mode for creating pools in the Batch account. ,
Enum:
{
BatchService: Pools will be allocated in subscriptions owned by the Batch service. ,
UserSubscription: Pools will be allocated in a subscription owned by the user. ,
}
,
Required: False ,
}
enum ,
keyVaultReference:
{
Description: Identifies the Azure key vault associated with a Batch account. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the Azure key vault associated with the Batch account. ,
Format: arm-id ,
Required: True ,
}
string ,
url:
{
Description: The URL of the Azure key vault associated with the Batch account. ,
Required: True ,
}
string ,
}
,
publicNetworkAccess:
{
Description: If not specified, the default value is 'enabled'. ,
Enum:
{
Enabled: Enables connectivity to Azure Batch through public DNS. ,
Disabled: Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource. ,
SecuredByPerimeter: Secures connectivity to Azure Batch through NSP configuration. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile only takes effect when publicNetworkAccess is enabled. ,
Required: False ,
}
{
accountAccess:
{
Description: Network access profile for batchAccount endpoint (Batch account data plane API). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
nodeManagementAccess:
{
Description: Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the Batch account ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
autoStorage:
{
Description: Contains information about the auto-storage account associated with a Batch account. ,
Required: False ,
}
{
lastKeySync:
{
Description: The UTC time at which storage keys were last synchronized with the Batch account. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
encryption:
{
Description: 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. ,
Required: False ,
}
{
keySource:
{
Description: Type of the key source. ,
Enum:
{
Microsoft.Batch: Batch creates and manages the encryption keys used to protect the account data. ,
Microsoft.KeyVault: 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. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Additional details when using Microsoft.KeyVault ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
}
,
dedicatedCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
lowPriorityCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
dedicatedCoreQuotaPerVMFamily:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The Virtual Machine family name. ,
Required: False ,
}
string ,
coreQuota:
{
Description: The core quota for the VM family for the Batch account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dedicatedCoreQuotaPerVMFamilyEnforced:
{
Description: 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. ,
Required: False ,
}
boolean ,
poolQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
activeJobAndJobScheduleQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
allowedAuthenticationModes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The identity of the Batch account. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the Batch account. ,
Enum:
{
SystemAssigned: Batch account has a system assigned identity with it. ,
UserAssigned: Batch account has user assigned identities with it. ,
None: Batch account has no identity associated with it. Setting `None` in update account will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_Delete (new)
Description :  Deletes the specified Batch account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_Get (new)
Description :  Gets information about the specified Batch account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the account. ,
Required: False ,
}
{
accountEndpoint:
{
Description: The account endpoint used to interact with the Batch service. ,
Required: False ,
}
string ,
nodeManagementEndpoint:
{
Description: The endpoint used by compute node to connect to the Batch node management service. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Invalid: The account is in an invalid state. ,
Creating: The account is being created. ,
Deleting: The account is being deleted. ,
Succeeded: The account has been created and is ready for use. ,
Failed: The last operation for the account is failed. ,
Cancelled: The last operation for the account is cancelled. ,
}
,
Required: False ,
}
enum ,
poolAllocationMode:
{
Description: The allocation mode for creating pools in the Batch account. ,
Enum:
{
BatchService: Pools will be allocated in subscriptions owned by the Batch service. ,
UserSubscription: Pools will be allocated in a subscription owned by the user. ,
}
,
Required: False ,
}
enum ,
keyVaultReference:
{
Description: Identifies the Azure key vault associated with a Batch account. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the Azure key vault associated with the Batch account. ,
Format: arm-id ,
Required: True ,
}
string ,
url:
{
Description: The URL of the Azure key vault associated with the Batch account. ,
Required: True ,
}
string ,
}
,
publicNetworkAccess:
{
Description: If not specified, the default value is 'enabled'. ,
Enum:
{
Enabled: Enables connectivity to Azure Batch through public DNS. ,
Disabled: Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource. ,
SecuredByPerimeter: Secures connectivity to Azure Batch through NSP configuration. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile only takes effect when publicNetworkAccess is enabled. ,
Required: False ,
}
{
accountAccess:
{
Description: Network access profile for batchAccount endpoint (Batch account data plane API). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
nodeManagementAccess:
{
Description: Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the Batch account ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
autoStorage:
{
Description: Contains information about the auto-storage account associated with a Batch account. ,
Required: False ,
}
{
lastKeySync:
{
Description: The UTC time at which storage keys were last synchronized with the Batch account. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
encryption:
{
Description: 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. ,
Required: False ,
}
{
keySource:
{
Description: Type of the key source. ,
Enum:
{
Microsoft.Batch: Batch creates and manages the encryption keys used to protect the account data. ,
Microsoft.KeyVault: 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. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Additional details when using Microsoft.KeyVault ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
}
,
dedicatedCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
lowPriorityCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
dedicatedCoreQuotaPerVMFamily:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The Virtual Machine family name. ,
Required: False ,
}
string ,
coreQuota:
{
Description: The core quota for the VM family for the Batch account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dedicatedCoreQuotaPerVMFamilyEnforced:
{
Description: 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. ,
Required: False ,
}
boolean ,
poolQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
activeJobAndJobScheduleQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
allowedAuthenticationModes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The identity of the Batch account. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the Batch account. ,
Enum:
{
SystemAssigned: Batch account has a system assigned identity with it. ,
UserAssigned: Batch account has user assigned identities with it. ,
None: Batch account has no identity associated with it. Setting `None` in update account will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_List (new)
Description :  Gets information about the Batch accounts associated with the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of Batch accounts returned by the listing operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the account. ,
Required: False ,
}
{
accountEndpoint:
{
Description: The account endpoint used to interact with the Batch service. ,
Required: False ,
}
string ,
nodeManagementEndpoint:
{
Description: The endpoint used by compute node to connect to the Batch node management service. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Invalid: The account is in an invalid state. ,
Creating: The account is being created. ,
Deleting: The account is being deleted. ,
Succeeded: The account has been created and is ready for use. ,
Failed: The last operation for the account is failed. ,
Cancelled: The last operation for the account is cancelled. ,
}
,
Required: False ,
}
enum ,
poolAllocationMode:
{
Description: The allocation mode for creating pools in the Batch account. ,
Enum:
{
BatchService: Pools will be allocated in subscriptions owned by the Batch service. ,
UserSubscription: Pools will be allocated in a subscription owned by the user. ,
}
,
Required: False ,
}
enum ,
keyVaultReference:
{
Description: Identifies the Azure key vault associated with a Batch account. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the Azure key vault associated with the Batch account. ,
Format: arm-id ,
Required: True ,
}
string ,
url:
{
Description: The URL of the Azure key vault associated with the Batch account. ,
Required: True ,
}
string ,
}
,
publicNetworkAccess:
{
Description: If not specified, the default value is 'enabled'. ,
Enum:
{
Enabled: Enables connectivity to Azure Batch through public DNS. ,
Disabled: Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource. ,
SecuredByPerimeter: Secures connectivity to Azure Batch through NSP configuration. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile only takes effect when publicNetworkAccess is enabled. ,
Required: False ,
}
{
accountAccess:
{
Description: Network access profile for batchAccount endpoint (Batch account data plane API). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
nodeManagementAccess:
{
Description: Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the Batch account ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
autoStorage:
{
Description: Contains information about the auto-storage account associated with a Batch account. ,
Required: False ,
}
{
lastKeySync:
{
Description: The UTC time at which storage keys were last synchronized with the Batch account. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
encryption:
{
Description: 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. ,
Required: False ,
}
{
keySource:
{
Description: Type of the key source. ,
Enum:
{
Microsoft.Batch: Batch creates and manages the encryption keys used to protect the account data. ,
Microsoft.KeyVault: 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. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Additional details when using Microsoft.KeyVault ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
}
,
dedicatedCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
lowPriorityCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
dedicatedCoreQuotaPerVMFamily:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The Virtual Machine family name. ,
Required: False ,
}
string ,
coreQuota:
{
Description: The core quota for the VM family for the Batch account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dedicatedCoreQuotaPerVMFamilyEnforced:
{
Description: 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. ,
Required: False ,
}
boolean ,
poolQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
activeJobAndJobScheduleQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
allowedAuthenticationModes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The identity of the Batch account. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the Batch account. ,
Enum:
{
SystemAssigned: Batch account has a system assigned identity with it. ,
UserAssigned: Batch account has user assigned identities with it. ,
None: Batch account has no identity associated with it. Setting `None` in update account will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_ListByResourceGroup (new)
Description :  Gets information about the Batch accounts associated with the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of Batch accounts returned by the listing operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the account. ,
Required: False ,
}
{
accountEndpoint:
{
Description: The account endpoint used to interact with the Batch service. ,
Required: False ,
}
string ,
nodeManagementEndpoint:
{
Description: The endpoint used by compute node to connect to the Batch node management service. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Invalid: The account is in an invalid state. ,
Creating: The account is being created. ,
Deleting: The account is being deleted. ,
Succeeded: The account has been created and is ready for use. ,
Failed: The last operation for the account is failed. ,
Cancelled: The last operation for the account is cancelled. ,
}
,
Required: False ,
}
enum ,
poolAllocationMode:
{
Description: The allocation mode for creating pools in the Batch account. ,
Enum:
{
BatchService: Pools will be allocated in subscriptions owned by the Batch service. ,
UserSubscription: Pools will be allocated in a subscription owned by the user. ,
}
,
Required: False ,
}
enum ,
keyVaultReference:
{
Description: Identifies the Azure key vault associated with a Batch account. ,
Required: False ,
}
{
id:
{
Description: The resource ID of the Azure key vault associated with the Batch account. ,
Format: arm-id ,
Required: True ,
}
string ,
url:
{
Description: The URL of the Azure key vault associated with the Batch account. ,
Required: True ,
}
string ,
}
,
publicNetworkAccess:
{
Description: If not specified, the default value is 'enabled'. ,
Enum:
{
Enabled: Enables connectivity to Azure Batch through public DNS. ,
Disabled: Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource. ,
SecuredByPerimeter: Secures connectivity to Azure Batch through NSP configuration. ,
}
,
Required: False ,
}
enum ,
networkProfile:
{
Description: The network profile only takes effect when publicNetworkAccess is enabled. ,
Required: False ,
}
{
accountAccess:
{
Description: Network access profile for batchAccount endpoint (Batch account data plane API). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
nodeManagementAccess:
{
Description: Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). ,
Required: False ,
}
{
defaultAction:
{
Description: Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. ,
Enum:
{
Allow: Allow client access. ,
Deny: Deny client access. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: Array of IP ranges to filter client IP address. ,
Required: False ,
}
[
{
action:
{
Description: Action when client IP address is matched. ,
Enum:
{
Allow: Allow access for the matched client IP address. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: IPv4 address, or IPv4 address range in CIDR format. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the Batch account ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
autoStorage:
{
Description: Contains information about the auto-storage account associated with a Batch account. ,
Required: False ,
}
{
lastKeySync:
{
Description: The UTC time at which storage keys were last synchronized with the Batch account. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
encryption:
{
Description: 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. ,
Required: False ,
}
{
keySource:
{
Description: Type of the key source. ,
Enum:
{
Microsoft.Batch: Batch creates and manages the encryption keys used to protect the account data. ,
Microsoft.KeyVault: 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. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Additional details when using Microsoft.KeyVault ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
}
,
dedicatedCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
lowPriorityCoreQuota:
{
Description: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. ,
Format: int32 ,
Required: False ,
}
integer ,
dedicatedCoreQuotaPerVMFamily:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The Virtual Machine family name. ,
Required: False ,
}
string ,
coreQuota:
{
Description: The core quota for the VM family for the Batch account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dedicatedCoreQuotaPerVMFamilyEnforced:
{
Description: 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. ,
Required: False ,
}
boolean ,
poolQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
activeJobAndJobScheduleQuota:
{
Format: int32 ,
Required: False ,
}
integer ,
allowedAuthenticationModes:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The identity of the Batch account. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the Batch account. ,
Enum:
{
SystemAssigned: Batch account has a system assigned identity with it. ,
UserAssigned: Batch account has user assigned identities with it. ,
None: Batch account has no identity associated with it. Setting `None` in update account will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_SynchronizeAutoStorageKeys (new)
Description :  Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_RegenerateKey (new)
Description :  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, regenerating the keys will fail.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
parameters:
{
Description: The type of key to regenerate. ,
Required: True ,
}
{
keyName:
{
Description: The type of account key to regenerate. ,
Enum:
{
Primary: The primary account key. ,
Secondary: The secondary account key. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
accountName:
{
Description: The Batch account name. ,
Required: False ,
}
string ,
primary:
{
Description: The primary key associated with the account. ,
Required: False ,
}
string ,
secondary:
{
Description: The secondary key associated with the account. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_GetKeys (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
accountName:
{
Description: The Batch account name. ,
Required: False ,
}
string ,
primary:
{
Description: The primary key associated with the account. ,
Required: False ,
}
string ,
secondary:
{
Description: The secondary key associated with the account. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ApplicationPackage_Activate (new)
Description :  Activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
versionName:
{
Description: The version of the application. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the request. ,
Required: True ,
}
{
format:
{
Description: The format of the application package binary file. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the Application Package. ,
Required: False ,
}
{
state:
{
Description: The current state of the application package. ,
Enum:
{
Pending: The application package has been created but has not yet been activated. ,
Active: The application package is ready for use. ,
}
,
Required: False ,
}
enum ,
format:
{
Description: The format of the application package, if the package is active. ,
Required: False ,
}
string ,
storageUrl:
{
Description: The URL for the application package in Azure Storage. ,
Required: False ,
}
string ,
storageUrlExpiry:
{
Description: The UTC time at which the Azure Storage URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
lastActivationTime:
{
Description: The time at which the package was last activated, if the package is active. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Application_Create (new)
Description :  Adds an application to the specified Batch account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the request. ,
Required: False ,
}
{
properties:
{
Description: The properties associated with the Application. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the application. ,
Required: False ,
}
string ,
allowUpdates:
{
Description: A value indicating whether packages within the application may be overwritten using the same version string. ,
Required: False ,
}
boolean ,
defaultVersion:
{
Description: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the Application. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the application. ,
Required: False ,
}
string ,
allowUpdates:
{
Description: A value indicating whether packages within the application may be overwritten using the same version string. ,
Required: False ,
}
boolean ,
defaultVersion:
{
Description: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Application_Delete (new)
Description :  Deletes an application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Application_Get (new)
Description :  Gets information about the specified application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the Application. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the application. ,
Required: False ,
}
string ,
allowUpdates:
{
Description: A value indicating whether packages within the application may be overwritten using the same version string. ,
Required: False ,
}
boolean ,
defaultVersion:
{
Description: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Application_Update (new)
Description :  Updates settings for the specified application.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the request. ,
Required: True ,
}
{
properties:
{
Description: The properties associated with the Application. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the application. ,
Required: False ,
}
string ,
allowUpdates:
{
Description: A value indicating whether packages within the application may be overwritten using the same version string. ,
Required: False ,
}
boolean ,
defaultVersion:
{
Description: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the Application. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the application. ,
Required: False ,
}
string ,
allowUpdates:
{
Description: A value indicating whether packages within the application may be overwritten using the same version string. ,
Required: False ,
}
boolean ,
defaultVersion:
{
Description: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ApplicationPackage_Create (new)
Description :  Creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
versionName:
{
Description: The version of the application. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for the request. ,
Required: False ,
}
{
properties:
{
Description: The properties associated with the Application Package. ,
Required: False ,
}
{
state:
{
Description: The current state of the application package. ,
Enum:
{
Pending: The application package has been created but has not yet been activated. ,
Active: The application package is ready for use. ,
}
,
Required: False ,
}
enum ,
format:
{
Description: The format of the application package, if the package is active. ,
Required: False ,
}
string ,
storageUrl:
{
Description: The URL for the application package in Azure Storage. ,
Required: False ,
}
string ,
storageUrlExpiry:
{
Description: The UTC time at which the Azure Storage URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
lastActivationTime:
{
Description: The time at which the package was last activated, if the package is active. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the Application Package. ,
Required: False ,
}
{
state:
{
Description: The current state of the application package. ,
Enum:
{
Pending: The application package has been created but has not yet been activated. ,
Active: The application package is ready for use. ,
}
,
Required: False ,
}
enum ,
format:
{
Description: The format of the application package, if the package is active. ,
Required: False ,
}
string ,
storageUrl:
{
Description: The URL for the application package in Azure Storage. ,
Required: False ,
}
string ,
storageUrlExpiry:
{
Description: The UTC time at which the Azure Storage URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
lastActivationTime:
{
Description: The time at which the package was last activated, if the package is active. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ApplicationPackage_Delete (new)
Description :  Deletes an application package record and its associated binary file.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
versionName:
{
Description: The version of the application. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ApplicationPackage_Get (new)
Description :  Gets information about the specified application package.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
versionName:
{
Description: The version of the application. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the Application Package. ,
Required: False ,
}
{
state:
{
Description: The current state of the application package. ,
Enum:
{
Pending: The application package has been created but has not yet been activated. ,
Active: The application package is ready for use. ,
}
,
Required: False ,
}
enum ,
format:
{
Description: The format of the application package, if the package is active. ,
Required: False ,
}
string ,
storageUrl:
{
Description: The URL for the application package in Azure Storage. ,
Required: False ,
}
string ,
storageUrlExpiry:
{
Description: The UTC time at which the Azure Storage URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
lastActivationTime:
{
Description: The time at which the package was last activated, if the package is active. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Application_List (new)
Description :  Lists all of the applications in the specified account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of applications. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the Application. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the application. ,
Required: False ,
}
string ,
allowUpdates:
{
Description: A value indicating whether packages within the application may be overwritten using the same version string. ,
Required: False ,
}
boolean ,
defaultVersion:
{
Description: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ApplicationPackage_List (new)
Description :  Lists all of the application packages in the specified application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application. This must be unique within the account. ,
Required: True ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of application packages. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the Application Package. ,
Required: False ,
}
{
state:
{
Description: The current state of the application package. ,
Enum:
{
Pending: The application package has been created but has not yet been activated. ,
Active: The application package is ready for use. ,
}
,
Required: False ,
}
enum ,
format:
{
Description: The format of the application package, if the package is active. ,
Required: False ,
}
string ,
storageUrl:
{
Description: The URL for the application package in Azure Storage. ,
Required: False ,
}
string ,
storageUrlExpiry:
{
Description: The UTC time at which the Azure Storage URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
lastActivationTime:
{
Description: The time at which the package was last activated, if the package is active. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_GetQuotas (new)
Description :  Gets the Batch service quotas for the specified subscription at the given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas
{
locationName:
{
Description: The region for which to retrieve Batch service quotas. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
accountQuota:
{
Description: The number of Batch accounts that may be created under the subscription in the specified region. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_ListSupportedVirtualMachineSkus (new)
Description :  Gets the list of Batch supported Virtual Machine VM sizes available at the given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus
{
locationName:
{
Description: The region for which to retrieve Batch service supported SKUs. ,
Required: True ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are "familyName". ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of SKUs available for the Batch service in the location. ,
Required: True ,
}
[
{
name:
{
Description: The name of the SKU. ,
Required: False ,
}
string ,
familyName:
{
Description: The family name of the SKU. ,
Required: False ,
}
string ,
capabilities:
{
Description: A collection of capabilities which this SKU supports. ,
Required: False ,
}
[
{
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the feature. ,
Required: False ,
}
string ,
}
,
]
,
batchSupportEndOfLife:
{
Description: The time when Azure Batch service will retire this SKU. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Lists available operations for the Microsoft.Batch provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Batch/operations
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Description: This is of the format {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
operation:
{
Description: For example: read, write, delete, or listKeys/action ,
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
origin:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Location_CheckNameAvailability (new)
Description :  Checks whether the Batch account name is available in the specified region.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability
{
locationName:
{
Description: The desired region for the name check. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
parameters:
{
Description: Properties needed to check the availability of a name. ,
Required: True ,
}
{
name:
{
Description: The name to check for availability ,
Required: True ,
}
string ,
type:
{
Description: The resource type. ,
Enum:
{
Microsoft.Batch/batchAccounts: The Batch account resource type. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used. ,
Required: False ,
}
boolean ,
reason:
{
Description: Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false. ,
Enum:
{
Invalid: The requested name is invalid. ,
AlreadyExists: The requested name is already in use. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Gets an error message explaining the Reason value in more detail. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_ListDetectors (new)
Description :  Gets information about the detectors available for a given Batch account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of Batch account detectors returned by the listing operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the detector. ,
Required: False ,
}
{
value:
{
Description: A base64 encoded string that represents the content of a detector. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_GetDetector (new)
Description :  Gets information about the given detector for a given Batch account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors/{detectorId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
detectorId:
{
Description: The name of the detector. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the detector. ,
Required: False ,
}
{
value:
{
Description: A base64 encoded string that represents the content of a detector. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateLinkResource_ListByBatchAccount (new)
Description :  Lists all of the private link resources in the specified account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection of returned private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the private link resource. ,
Required: False ,
}
{
groupId:
{
Description: The group id is used to establish the private link connection. ,
Required: False ,
}
string ,
requiredMembers:
{
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateLinkResource_Get (new)
Description :  Gets information about the specified private link resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Description: The private link resource name. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the private link resource. ,
Required: False ,
}
{
groupId:
{
Description: The group id is used to establish the private link connection. ,
Required: False ,
}
string ,
requiredMembers:
{
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnection_ListByBatchAccount (new)
Description :  Lists all of the private endpoint connections in the specified account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection of returned private endpoint connection. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnection_Get (new)
Description :  Gets information about the specified private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnection_Update (new)
Description :  Updates the properties of an existing private endpoint connection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged. ,
Required: True ,
}
{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}
,
If-Match:
{
Description: The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to "*" to apply the operation unconditionally. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Enum:
{
Creating: The connection is creating. ,
Updating: 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. ,
Deleting: The connection is deleting. ,
Succeeded: The connection status is final and is ready for use if Status is Approved. ,
Failed: The user requested that the connection be updated and it failed. You may retry the update operation. ,
Cancelled: The user has cancelled the connection creation. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint of the private endpoint connection. ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
groupIds:
{
Description: The value has one and only one group id. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: The private link service connection state of the private endpoint connection ,
Required: False ,
}
{
status:
{
Enum:
{
Approved: The private endpoint connection is approved and can be used to access Batch account ,
Pending: The private endpoint connection is pending and cannot be used to access Batch account ,
Rejected: The private endpoint connection is rejected and cannot be used to access Batch account ,
Disconnected: The private endpoint connection is disconnected and cannot be used to access Batch account ,
}
,
Required: True ,
}
enum ,
description:
{
Required: False ,
}
string ,
actionsRequired:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PrivateEndpointConnection_Delete (new)
Description :  Deletes the specified private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pool_ListByBatchAccount (new)
Description :  Lists all of the pools in the specified account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. ,
Format: int32 ,
Required: False ,
}
integer ,
$select:
{
Description: Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. ,
Required: False ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are: name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of returned pools. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
lastModified:
{
Description: This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Enum:
{
Succeeded: The pool is available to run tasks subject to the availability of compute nodes. ,
Deleting: The user has requested that the pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
provisioningStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Enum:
{
Steady: The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. ,
Resizing: The pool is resizing; that is, compute nodes are being added to or removed from the pool. ,
Stopping: The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Required: False ,
}
{
virtualMachineConfiguration:
{
Required: False ,
}
{
imageReference:
{
Required: True ,
}
{
publisher:
{
Description: For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: For example, 18.04-LTS or 2022-datacenter. ,
Required: False ,
}
string ,
version:
{
Description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
id:
{
Description: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSkuId:
{
Description: The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: This property must not be specified if the imageReference specifies a Linux OS image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. ,
Required: False ,
}
[
{
lun:
{
Description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. ,
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
licenseType:
{
Description: This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. ,
Required: False ,
}
{
type:
{
Enum:
{
DockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
CriCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. ,
Required: False ,
}
[
string ,
]
,
customerManagedKey:
{
Description: Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. ,
Required: False ,
}
{
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. ,
Required: False ,
}
boolean ,
identityReference:
{
Description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
nodePlacementConfiguration:
{
Description: This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
Regional: All nodes in the pool will be allocated in the same region. ,
Zonal: Nodes in the pool will be spread across different zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
publisher:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
typeHandlerVersion:
{
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Contains configuration for ephemeral OSDisk settings. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Required: False ,
}
{
placement:
{
Description: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
CacheDisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskSizeGB:
{
Format: int32 ,
Required: False ,
}
integer ,
writeAcceleratorEnabled:
{
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
securityType:
{
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: False ,
}
enum ,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. ,
Required: False ,
}
{
enabled:
{
Required: False ,
}
boolean ,
imds:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
wireServer:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
}
,
}
,
serviceArtifactReference:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
}
,
currentDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
scaleSettings:
{
Description: Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. ,
Required: False ,
}
{
fixedScale:
{
Description: This property and autoScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
resizeTimeout:
{
Description: The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeDeallocationOption:
{
Description: If omitted, the default value is Requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
}
,
autoScale:
{
Description: This property and fixedScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
formula:
{
Required: True ,
}
string ,
evaluationInterval:
{
Description: If omitted, the default value is 15 minutes (PT15M). ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
autoScaleRun:
{
Description: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. ,
Required: False ,
}
{
evaluationTime:
{
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
interNodeCommunication:
{
Description: This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. ,
Enum:
{
Enabled: Enable network communication between virtual machines. ,
Disabled: Disable network communication between virtual machines. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for a pool. ,
Required: False ,
}
{
subnetId:
{
Description: The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVnetAssignmentScope:
{
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Required: False ,
}
{
inboundNatPools:
{
Description: The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Enum:
{
TCP: Use TCP for the endpoint. ,
UDP: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Enum:
{
Allow: Allow access. ,
Deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The public IP Address configuration of the networking configuration of a Pool. ,
Required: False ,
}
{
provision:
{
Description: The default value is BatchManaged ,
Enum:
{
BatchManaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
UserManaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
NoPublicIPAddresses: No public IP Address will be created for the Compute Nodes in the Pool. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
ipTags:
{
Required: False ,
}
[
{
ipTagType:
{
Description: Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
taskSlotsPerNode:
{
Description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: If not specified, the default is spread. ,
Required: False ,
}
{
jobDefaultOrder:
{
Description: If not specified, the default is none. ,
Enum:
{
None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. ,
CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. ,
}
,
Required: False ,
}
enum ,
nodeFillType:
{
Enum:
{
Spread: Tasks should be assigned evenly across all nodes in the pool. ,
Pack: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
password:
{
Required: True ,
}
string ,
elevationLevel:
{
Description: nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: Specifies login mode for the user. The default value is Interactive. ,
Enum:
{
Batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
Interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
startTask:
{
Description: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. ,
Required: False ,
}
string ,
resourceFiles:
{
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ,
Required: False ,
}
string ,
httpUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. ,
Required: False ,
}
string ,
filePath:
{
Description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: If omitted, the task runs as a non-administrative user unique to the task. ,
Required: False ,
}
{
userName:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
string ,
autoUser:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
Task: Specifies that the service should create a new user for the task. ,
Pool: Specifies that the task runs as the common auto user account which is created on every node in a pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. ,
Required: False ,
}
boolean ,
containerSettings:
{
Description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. ,
Required: False ,
}
{
containerRunOptions:
{
Description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. ,
Required: False ,
}
string ,
imageName:
{
Description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. ,
Required: True ,
}
string ,
registry:
{
Description: This setting can be omitted if was already provided at pool creation. ,
Required: False ,
}
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Enum:
{
TaskWorkingDirectory: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. ,
ContainerImageDefault: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. ,
Required: False ,
}
[
{
source:
{
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
applicationPackages:
{
Description: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. ,
Required: False ,
}
[
{
id:
{
Required: True ,
}
string ,
version:
{
Description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. ,
Required: False ,
}
string ,
}
,
]
,
resizeOperationStatus:
{
Description: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). ,
Required: False ,
}
{
targetDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
resizeTimeout:
{
Description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
nodeDeallocationOption:
{
Description: The default value is requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
mountConfiguration:
{
Description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
accountKey:
{
Description: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
sasKey:
{
Description: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
userName:
{
Required: True ,
}
string ,
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
azureFileUrl:
{
Description: This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
upgradePolicy:
{
Description: Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Enum:
{
automatic: All virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The type of identity used for the Batch Pool. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the Batch Pool. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch pool. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pool_Create (new)
Description :  Creates a new pool inside the specified account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
poolName:
{
Description: The pool name. This must be unique within the account. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for pool creation. ,
Required: True ,
}
{
properties:
{
Description: The properties associated with the pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
lastModified:
{
Description: This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Enum:
{
Succeeded: The pool is available to run tasks subject to the availability of compute nodes. ,
Deleting: The user has requested that the pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
provisioningStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Enum:
{
Steady: The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. ,
Resizing: The pool is resizing; that is, compute nodes are being added to or removed from the pool. ,
Stopping: The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Required: False ,
}
{
virtualMachineConfiguration:
{
Required: False ,
}
{
imageReference:
{
Required: True ,
}
{
publisher:
{
Description: For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: For example, 18.04-LTS or 2022-datacenter. ,
Required: False ,
}
string ,
version:
{
Description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
id:
{
Description: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSkuId:
{
Description: The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: This property must not be specified if the imageReference specifies a Linux OS image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. ,
Required: False ,
}
[
{
lun:
{
Description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. ,
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
licenseType:
{
Description: This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. ,
Required: False ,
}
{
type:
{
Enum:
{
DockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
CriCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. ,
Required: False ,
}
[
string ,
]
,
customerManagedKey:
{
Description: Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. ,
Required: False ,
}
{
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. ,
Required: False ,
}
boolean ,
identityReference:
{
Description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
nodePlacementConfiguration:
{
Description: This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
Regional: All nodes in the pool will be allocated in the same region. ,
Zonal: Nodes in the pool will be spread across different zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
publisher:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
typeHandlerVersion:
{
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Contains configuration for ephemeral OSDisk settings. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Required: False ,
}
{
placement:
{
Description: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
CacheDisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskSizeGB:
{
Format: int32 ,
Required: False ,
}
integer ,
writeAcceleratorEnabled:
{
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
securityType:
{
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: False ,
}
enum ,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. ,
Required: False ,
}
{
enabled:
{
Required: False ,
}
boolean ,
imds:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
wireServer:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
}
,
}
,
serviceArtifactReference:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
}
,
currentDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
scaleSettings:
{
Description: Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. ,
Required: False ,
}
{
fixedScale:
{
Description: This property and autoScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
resizeTimeout:
{
Description: The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeDeallocationOption:
{
Description: If omitted, the default value is Requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
}
,
autoScale:
{
Description: This property and fixedScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
formula:
{
Required: True ,
}
string ,
evaluationInterval:
{
Description: If omitted, the default value is 15 minutes (PT15M). ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
autoScaleRun:
{
Description: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. ,
Required: False ,
}
{
evaluationTime:
{
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
interNodeCommunication:
{
Description: This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. ,
Enum:
{
Enabled: Enable network communication between virtual machines. ,
Disabled: Disable network communication between virtual machines. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for a pool. ,
Required: False ,
}
{
subnetId:
{
Description: The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVnetAssignmentScope:
{
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Required: False ,
}
{
inboundNatPools:
{
Description: The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Enum:
{
TCP: Use TCP for the endpoint. ,
UDP: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Enum:
{
Allow: Allow access. ,
Deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The public IP Address configuration of the networking configuration of a Pool. ,
Required: False ,
}
{
provision:
{
Description: The default value is BatchManaged ,
Enum:
{
BatchManaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
UserManaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
NoPublicIPAddresses: No public IP Address will be created for the Compute Nodes in the Pool. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
ipTags:
{
Required: False ,
}
[
{
ipTagType:
{
Description: Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
taskSlotsPerNode:
{
Description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: If not specified, the default is spread. ,
Required: False ,
}
{
jobDefaultOrder:
{
Description: If not specified, the default is none. ,
Enum:
{
None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. ,
CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. ,
}
,
Required: False ,
}
enum ,
nodeFillType:
{
Enum:
{
Spread: Tasks should be assigned evenly across all nodes in the pool. ,
Pack: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
password:
{
Required: True ,
}
string ,
elevationLevel:
{
Description: nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: Specifies login mode for the user. The default value is Interactive. ,
Enum:
{
Batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
Interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
startTask:
{
Description: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. ,
Required: False ,
}
string ,
resourceFiles:
{
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ,
Required: False ,
}
string ,
httpUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. ,
Required: False ,
}
string ,
filePath:
{
Description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: If omitted, the task runs as a non-administrative user unique to the task. ,
Required: False ,
}
{
userName:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
string ,
autoUser:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
Task: Specifies that the service should create a new user for the task. ,
Pool: Specifies that the task runs as the common auto user account which is created on every node in a pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. ,
Required: False ,
}
boolean ,
containerSettings:
{
Description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. ,
Required: False ,
}
{
containerRunOptions:
{
Description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. ,
Required: False ,
}
string ,
imageName:
{
Description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. ,
Required: True ,
}
string ,
registry:
{
Description: This setting can be omitted if was already provided at pool creation. ,
Required: False ,
}
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Enum:
{
TaskWorkingDirectory: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. ,
ContainerImageDefault: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. ,
Required: False ,
}
[
{
source:
{
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
applicationPackages:
{
Description: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. ,
Required: False ,
}
[
{
id:
{
Required: True ,
}
string ,
version:
{
Description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. ,
Required: False ,
}
string ,
}
,
]
,
resizeOperationStatus:
{
Description: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). ,
Required: False ,
}
{
targetDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
resizeTimeout:
{
Description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
nodeDeallocationOption:
{
Description: The default value is requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
mountConfiguration:
{
Description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
accountKey:
{
Description: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
sasKey:
{
Description: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
userName:
{
Required: True ,
}
string ,
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
azureFileUrl:
{
Description: This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
upgradePolicy:
{
Description: Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Enum:
{
automatic: All virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The type of identity used for the Batch Pool. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the Batch Pool. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch pool. ,
Required: False ,
}
object ,
}
,
}
,
If-Match:
{
Description: The entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: Contains information about a pool. ,
}
{
properties:
{
Description: The properties associated with the pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
lastModified:
{
Description: This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Enum:
{
Succeeded: The pool is available to run tasks subject to the availability of compute nodes. ,
Deleting: The user has requested that the pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
provisioningStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Enum:
{
Steady: The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. ,
Resizing: The pool is resizing; that is, compute nodes are being added to or removed from the pool. ,
Stopping: The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Required: False ,
}
{
virtualMachineConfiguration:
{
Required: False ,
}
{
imageReference:
{
Required: True ,
}
{
publisher:
{
Description: For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: For example, 18.04-LTS or 2022-datacenter. ,
Required: False ,
}
string ,
version:
{
Description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
id:
{
Description: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSkuId:
{
Description: The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: This property must not be specified if the imageReference specifies a Linux OS image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. ,
Required: False ,
}
[
{
lun:
{
Description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. ,
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
licenseType:
{
Description: This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. ,
Required: False ,
}
{
type:
{
Enum:
{
DockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
CriCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. ,
Required: False ,
}
[
string ,
]
,
customerManagedKey:
{
Description: Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. ,
Required: False ,
}
{
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. ,
Required: False ,
}
boolean ,
identityReference:
{
Description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
nodePlacementConfiguration:
{
Description: This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
Regional: All nodes in the pool will be allocated in the same region. ,
Zonal: Nodes in the pool will be spread across different zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
publisher:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
typeHandlerVersion:
{
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Contains configuration for ephemeral OSDisk settings. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Required: False ,
}
{
placement:
{
Description: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
CacheDisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskSizeGB:
{
Format: int32 ,
Required: False ,
}
integer ,
writeAcceleratorEnabled:
{
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
securityType:
{
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: False ,
}
enum ,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. ,
Required: False ,
}
{
enabled:
{
Required: False ,
}
boolean ,
imds:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
wireServer:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
}
,
}
,
serviceArtifactReference:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
}
,
currentDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
scaleSettings:
{
Description: Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. ,
Required: False ,
}
{
fixedScale:
{
Description: This property and autoScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
resizeTimeout:
{
Description: The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeDeallocationOption:
{
Description: If omitted, the default value is Requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
}
,
autoScale:
{
Description: This property and fixedScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
formula:
{
Required: True ,
}
string ,
evaluationInterval:
{
Description: If omitted, the default value is 15 minutes (PT15M). ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
autoScaleRun:
{
Description: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. ,
Required: False ,
}
{
evaluationTime:
{
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
interNodeCommunication:
{
Description: This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. ,
Enum:
{
Enabled: Enable network communication between virtual machines. ,
Disabled: Disable network communication between virtual machines. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for a pool. ,
Required: False ,
}
{
subnetId:
{
Description: The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVnetAssignmentScope:
{
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Required: False ,
}
{
inboundNatPools:
{
Description: The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Enum:
{
TCP: Use TCP for the endpoint. ,
UDP: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Enum:
{
Allow: Allow access. ,
Deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The public IP Address configuration of the networking configuration of a Pool. ,
Required: False ,
}
{
provision:
{
Description: The default value is BatchManaged ,
Enum:
{
BatchManaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
UserManaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
NoPublicIPAddresses: No public IP Address will be created for the Compute Nodes in the Pool. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
ipTags:
{
Required: False ,
}
[
{
ipTagType:
{
Description: Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
taskSlotsPerNode:
{
Description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: If not specified, the default is spread. ,
Required: False ,
}
{
jobDefaultOrder:
{
Description: If not specified, the default is none. ,
Enum:
{
None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. ,
CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. ,
}
,
Required: False ,
}
enum ,
nodeFillType:
{
Enum:
{
Spread: Tasks should be assigned evenly across all nodes in the pool. ,
Pack: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
password:
{
Required: True ,
}
string ,
elevationLevel:
{
Description: nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: Specifies login mode for the user. The default value is Interactive. ,
Enum:
{
Batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
Interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
startTask:
{
Description: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. ,
Required: False ,
}
string ,
resourceFiles:
{
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ,
Required: False ,
}
string ,
httpUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. ,
Required: False ,
}
string ,
filePath:
{
Description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: If omitted, the task runs as a non-administrative user unique to the task. ,
Required: False ,
}
{
userName:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
string ,
autoUser:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
Task: Specifies that the service should create a new user for the task. ,
Pool: Specifies that the task runs as the common auto user account which is created on every node in a pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. ,
Required: False ,
}
boolean ,
containerSettings:
{
Description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. ,
Required: False ,
}
{
containerRunOptions:
{
Description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. ,
Required: False ,
}
string ,
imageName:
{
Description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. ,
Required: True ,
}
string ,
registry:
{
Description: This setting can be omitted if was already provided at pool creation. ,
Required: False ,
}
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Enum:
{
TaskWorkingDirectory: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. ,
ContainerImageDefault: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. ,
Required: False ,
}
[
{
source:
{
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
applicationPackages:
{
Description: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. ,
Required: False ,
}
[
{
id:
{
Required: True ,
}
string ,
version:
{
Description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. ,
Required: False ,
}
string ,
}
,
]
,
resizeOperationStatus:
{
Description: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). ,
Required: False ,
}
{
targetDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
resizeTimeout:
{
Description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
nodeDeallocationOption:
{
Description: The default value is requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
mountConfiguration:
{
Description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
accountKey:
{
Description: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
sasKey:
{
Description: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
userName:
{
Required: True ,
}
string ,
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
azureFileUrl:
{
Description: This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
upgradePolicy:
{
Description: Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Enum:
{
automatic: All virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The type of identity used for the Batch Pool. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the Batch Pool. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch pool. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pool_Update (new)
Description :  Updates the properties of an existing pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
poolName:
{
Description: The pool name. This must be unique within the account. ,
Required: True ,
}
string ,
parameters:
{
Description: Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged. ,
Required: True ,
}
{
properties:
{
Description: The properties associated with the pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
lastModified:
{
Description: This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Enum:
{
Succeeded: The pool is available to run tasks subject to the availability of compute nodes. ,
Deleting: The user has requested that the pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
provisioningStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Enum:
{
Steady: The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. ,
Resizing: The pool is resizing; that is, compute nodes are being added to or removed from the pool. ,
Stopping: The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Required: False ,
}
{
virtualMachineConfiguration:
{
Required: False ,
}
{
imageReference:
{
Required: True ,
}
{
publisher:
{
Description: For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: For example, 18.04-LTS or 2022-datacenter. ,
Required: False ,
}
string ,
version:
{
Description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
id:
{
Description: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSkuId:
{
Description: The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: This property must not be specified if the imageReference specifies a Linux OS image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. ,
Required: False ,
}
[
{
lun:
{
Description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. ,
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
licenseType:
{
Description: This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. ,
Required: False ,
}
{
type:
{
Enum:
{
DockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
CriCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. ,
Required: False ,
}
[
string ,
]
,
customerManagedKey:
{
Description: Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. ,
Required: False ,
}
{
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. ,
Required: False ,
}
boolean ,
identityReference:
{
Description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
nodePlacementConfiguration:
{
Description: This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
Regional: All nodes in the pool will be allocated in the same region. ,
Zonal: Nodes in the pool will be spread across different zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
publisher:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
typeHandlerVersion:
{
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Contains configuration for ephemeral OSDisk settings. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Required: False ,
}
{
placement:
{
Description: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
CacheDisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskSizeGB:
{
Format: int32 ,
Required: False ,
}
integer ,
writeAcceleratorEnabled:
{
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
securityType:
{
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: False ,
}
enum ,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. ,
Required: False ,
}
{
enabled:
{
Required: False ,
}
boolean ,
imds:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
wireServer:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
}
,
}
,
serviceArtifactReference:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
}
,
currentDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
scaleSettings:
{
Description: Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. ,
Required: False ,
}
{
fixedScale:
{
Description: This property and autoScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
resizeTimeout:
{
Description: The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeDeallocationOption:
{
Description: If omitted, the default value is Requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
}
,
autoScale:
{
Description: This property and fixedScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
formula:
{
Required: True ,
}
string ,
evaluationInterval:
{
Description: If omitted, the default value is 15 minutes (PT15M). ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
autoScaleRun:
{
Description: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. ,
Required: False ,
}
{
evaluationTime:
{
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
interNodeCommunication:
{
Description: This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. ,
Enum:
{
Enabled: Enable network communication between virtual machines. ,
Disabled: Disable network communication between virtual machines. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for a pool. ,
Required: False ,
}
{
subnetId:
{
Description: The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVnetAssignmentScope:
{
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Required: False ,
}
{
inboundNatPools:
{
Description: The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Enum:
{
TCP: Use TCP for the endpoint. ,
UDP: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Enum:
{
Allow: Allow access. ,
Deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The public IP Address configuration of the networking configuration of a Pool. ,
Required: False ,
}
{
provision:
{
Description: The default value is BatchManaged ,
Enum:
{
BatchManaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
UserManaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
NoPublicIPAddresses: No public IP Address will be created for the Compute Nodes in the Pool. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
ipTags:
{
Required: False ,
}
[
{
ipTagType:
{
Description: Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
taskSlotsPerNode:
{
Description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: If not specified, the default is spread. ,
Required: False ,
}
{
jobDefaultOrder:
{
Description: If not specified, the default is none. ,
Enum:
{
None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. ,
CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. ,
}
,
Required: False ,
}
enum ,
nodeFillType:
{
Enum:
{
Spread: Tasks should be assigned evenly across all nodes in the pool. ,
Pack: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
password:
{
Required: True ,
}
string ,
elevationLevel:
{
Description: nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: Specifies login mode for the user. The default value is Interactive. ,
Enum:
{
Batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
Interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
startTask:
{
Description: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. ,
Required: False ,
}
string ,
resourceFiles:
{
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ,
Required: False ,
}
string ,
httpUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. ,
Required: False ,
}
string ,
filePath:
{
Description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: If omitted, the task runs as a non-administrative user unique to the task. ,
Required: False ,
}
{
userName:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
string ,
autoUser:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
Task: Specifies that the service should create a new user for the task. ,
Pool: Specifies that the task runs as the common auto user account which is created on every node in a pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. ,
Required: False ,
}
boolean ,
containerSettings:
{
Description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. ,
Required: False ,
}
{
containerRunOptions:
{
Description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. ,
Required: False ,
}
string ,
imageName:
{
Description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. ,
Required: True ,
}
string ,
registry:
{
Description: This setting can be omitted if was already provided at pool creation. ,
Required: False ,
}
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Enum:
{
TaskWorkingDirectory: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. ,
ContainerImageDefault: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. ,
Required: False ,
}
[
{
source:
{
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
applicationPackages:
{
Description: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. ,
Required: False ,
}
[
{
id:
{
Required: True ,
}
string ,
version:
{
Description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. ,
Required: False ,
}
string ,
}
,
]
,
resizeOperationStatus:
{
Description: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). ,
Required: False ,
}
{
targetDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
resizeTimeout:
{
Description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
nodeDeallocationOption:
{
Description: The default value is requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
mountConfiguration:
{
Description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
accountKey:
{
Description: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
sasKey:
{
Description: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
userName:
{
Required: True ,
}
string ,
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
azureFileUrl:
{
Description: This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
upgradePolicy:
{
Description: Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Enum:
{
automatic: All virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The type of identity used for the Batch Pool. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the Batch Pool. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch pool. ,
Required: False ,
}
object ,
}
,
}
,
If-Match:
{
Description: The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: Contains information about a pool. ,
}
{
properties:
{
Description: The properties associated with the pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
lastModified:
{
Description: This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Enum:
{
Succeeded: The pool is available to run tasks subject to the availability of compute nodes. ,
Deleting: The user has requested that the pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
provisioningStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Enum:
{
Steady: The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. ,
Resizing: The pool is resizing; that is, compute nodes are being added to or removed from the pool. ,
Stopping: The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Required: False ,
}
{
virtualMachineConfiguration:
{
Required: False ,
}
{
imageReference:
{
Required: True ,
}
{
publisher:
{
Description: For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: For example, 18.04-LTS or 2022-datacenter. ,
Required: False ,
}
string ,
version:
{
Description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
id:
{
Description: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSkuId:
{
Description: The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: This property must not be specified if the imageReference specifies a Linux OS image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. ,
Required: False ,
}
[
{
lun:
{
Description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. ,
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
licenseType:
{
Description: This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. ,
Required: False ,
}
{
type:
{
Enum:
{
DockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
CriCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. ,
Required: False ,
}
[
string ,
]
,
customerManagedKey:
{
Description: Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. ,
Required: False ,
}
{
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. ,
Required: False ,
}
boolean ,
identityReference:
{
Description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
nodePlacementConfiguration:
{
Description: This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
Regional: All nodes in the pool will be allocated in the same region. ,
Zonal: Nodes in the pool will be spread across different zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
publisher:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
typeHandlerVersion:
{
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Contains configuration for ephemeral OSDisk settings. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Required: False ,
}
{
placement:
{
Description: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
CacheDisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskSizeGB:
{
Format: int32 ,
Required: False ,
}
integer ,
writeAcceleratorEnabled:
{
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
securityType:
{
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: False ,
}
enum ,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. ,
Required: False ,
}
{
enabled:
{
Required: False ,
}
boolean ,
imds:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
wireServer:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
}
,
}
,
serviceArtifactReference:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
}
,
currentDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
scaleSettings:
{
Description: Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. ,
Required: False ,
}
{
fixedScale:
{
Description: This property and autoScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
resizeTimeout:
{
Description: The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeDeallocationOption:
{
Description: If omitted, the default value is Requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
}
,
autoScale:
{
Description: This property and fixedScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
formula:
{
Required: True ,
}
string ,
evaluationInterval:
{
Description: If omitted, the default value is 15 minutes (PT15M). ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
autoScaleRun:
{
Description: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. ,
Required: False ,
}
{
evaluationTime:
{
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
interNodeCommunication:
{
Description: This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. ,
Enum:
{
Enabled: Enable network communication between virtual machines. ,
Disabled: Disable network communication between virtual machines. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for a pool. ,
Required: False ,
}
{
subnetId:
{
Description: The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVnetAssignmentScope:
{
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Required: False ,
}
{
inboundNatPools:
{
Description: The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Enum:
{
TCP: Use TCP for the endpoint. ,
UDP: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Enum:
{
Allow: Allow access. ,
Deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The public IP Address configuration of the networking configuration of a Pool. ,
Required: False ,
}
{
provision:
{
Description: The default value is BatchManaged ,
Enum:
{
BatchManaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
UserManaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
NoPublicIPAddresses: No public IP Address will be created for the Compute Nodes in the Pool. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
ipTags:
{
Required: False ,
}
[
{
ipTagType:
{
Description: Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
taskSlotsPerNode:
{
Description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: If not specified, the default is spread. ,
Required: False ,
}
{
jobDefaultOrder:
{
Description: If not specified, the default is none. ,
Enum:
{
None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. ,
CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. ,
}
,
Required: False ,
}
enum ,
nodeFillType:
{
Enum:
{
Spread: Tasks should be assigned evenly across all nodes in the pool. ,
Pack: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
password:
{
Required: True ,
}
string ,
elevationLevel:
{
Description: nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: Specifies login mode for the user. The default value is Interactive. ,
Enum:
{
Batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
Interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
startTask:
{
Description: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. ,
Required: False ,
}
string ,
resourceFiles:
{
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ,
Required: False ,
}
string ,
httpUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. ,
Required: False ,
}
string ,
filePath:
{
Description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: If omitted, the task runs as a non-administrative user unique to the task. ,
Required: False ,
}
{
userName:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
string ,
autoUser:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
Task: Specifies that the service should create a new user for the task. ,
Pool: Specifies that the task runs as the common auto user account which is created on every node in a pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. ,
Required: False ,
}
boolean ,
containerSettings:
{
Description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. ,
Required: False ,
}
{
containerRunOptions:
{
Description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. ,
Required: False ,
}
string ,
imageName:
{
Description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. ,
Required: True ,
}
string ,
registry:
{
Description: This setting can be omitted if was already provided at pool creation. ,
Required: False ,
}
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Enum:
{
TaskWorkingDirectory: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. ,
ContainerImageDefault: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. ,
Required: False ,
}
[
{
source:
{
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
applicationPackages:
{
Description: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. ,
Required: False ,
}
[
{
id:
{
Required: True ,
}
string ,
version:
{
Description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. ,
Required: False ,
}
string ,
}
,
]
,
resizeOperationStatus:
{
Description: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). ,
Required: False ,
}
{
targetDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
resizeTimeout:
{
Description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
nodeDeallocationOption:
{
Description: The default value is requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
mountConfiguration:
{
Description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
accountKey:
{
Description: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
sasKey:
{
Description: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
userName:
{
Required: True ,
}
string ,
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
azureFileUrl:
{
Description: This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
upgradePolicy:
{
Description: Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Enum:
{
automatic: All virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The type of identity used for the Batch Pool. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the Batch Pool. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch pool. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pool_Delete (new)
Description :  Deletes the specified pool.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
poolName:
{
Description: The pool name. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pool_Get (new)
Description :  Gets information about the specified pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
poolName:
{
Description: The pool name. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: Contains information about a pool. ,
}
{
properties:
{
Description: The properties associated with the pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
lastModified:
{
Description: This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Enum:
{
Succeeded: The pool is available to run tasks subject to the availability of compute nodes. ,
Deleting: The user has requested that the pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
provisioningStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Enum:
{
Steady: The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. ,
Resizing: The pool is resizing; that is, compute nodes are being added to or removed from the pool. ,
Stopping: The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Required: False ,
}
{
virtualMachineConfiguration:
{
Required: False ,
}
{
imageReference:
{
Required: True ,
}
{
publisher:
{
Description: For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: For example, 18.04-LTS or 2022-datacenter. ,
Required: False ,
}
string ,
version:
{
Description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
id:
{
Description: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSkuId:
{
Description: The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: This property must not be specified if the imageReference specifies a Linux OS image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. ,
Required: False ,
}
[
{
lun:
{
Description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. ,
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
licenseType:
{
Description: This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. ,
Required: False ,
}
{
type:
{
Enum:
{
DockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
CriCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. ,
Required: False ,
}
[
string ,
]
,
customerManagedKey:
{
Description: Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. ,
Required: False ,
}
{
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. ,
Required: False ,
}
boolean ,
identityReference:
{
Description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
nodePlacementConfiguration:
{
Description: This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
Regional: All nodes in the pool will be allocated in the same region. ,
Zonal: Nodes in the pool will be spread across different zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
publisher:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
typeHandlerVersion:
{
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Contains configuration for ephemeral OSDisk settings. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Required: False ,
}
{
placement:
{
Description: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
CacheDisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskSizeGB:
{
Format: int32 ,
Required: False ,
}
integer ,
writeAcceleratorEnabled:
{
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
securityType:
{
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: False ,
}
enum ,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. ,
Required: False ,
}
{
enabled:
{
Required: False ,
}
boolean ,
imds:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
wireServer:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
}
,
}
,
serviceArtifactReference:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
}
,
currentDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
scaleSettings:
{
Description: Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. ,
Required: False ,
}
{
fixedScale:
{
Description: This property and autoScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
resizeTimeout:
{
Description: The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeDeallocationOption:
{
Description: If omitted, the default value is Requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
}
,
autoScale:
{
Description: This property and fixedScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
formula:
{
Required: True ,
}
string ,
evaluationInterval:
{
Description: If omitted, the default value is 15 minutes (PT15M). ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
autoScaleRun:
{
Description: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. ,
Required: False ,
}
{
evaluationTime:
{
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
interNodeCommunication:
{
Description: This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. ,
Enum:
{
Enabled: Enable network communication between virtual machines. ,
Disabled: Disable network communication between virtual machines. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for a pool. ,
Required: False ,
}
{
subnetId:
{
Description: The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVnetAssignmentScope:
{
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Required: False ,
}
{
inboundNatPools:
{
Description: The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Enum:
{
TCP: Use TCP for the endpoint. ,
UDP: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Enum:
{
Allow: Allow access. ,
Deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The public IP Address configuration of the networking configuration of a Pool. ,
Required: False ,
}
{
provision:
{
Description: The default value is BatchManaged ,
Enum:
{
BatchManaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
UserManaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
NoPublicIPAddresses: No public IP Address will be created for the Compute Nodes in the Pool. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
ipTags:
{
Required: False ,
}
[
{
ipTagType:
{
Description: Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
taskSlotsPerNode:
{
Description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: If not specified, the default is spread. ,
Required: False ,
}
{
jobDefaultOrder:
{
Description: If not specified, the default is none. ,
Enum:
{
None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. ,
CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. ,
}
,
Required: False ,
}
enum ,
nodeFillType:
{
Enum:
{
Spread: Tasks should be assigned evenly across all nodes in the pool. ,
Pack: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
password:
{
Required: True ,
}
string ,
elevationLevel:
{
Description: nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: Specifies login mode for the user. The default value is Interactive. ,
Enum:
{
Batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
Interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
startTask:
{
Description: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. ,
Required: False ,
}
string ,
resourceFiles:
{
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ,
Required: False ,
}
string ,
httpUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. ,
Required: False ,
}
string ,
filePath:
{
Description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: If omitted, the task runs as a non-administrative user unique to the task. ,
Required: False ,
}
{
userName:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
string ,
autoUser:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
Task: Specifies that the service should create a new user for the task. ,
Pool: Specifies that the task runs as the common auto user account which is created on every node in a pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. ,
Required: False ,
}
boolean ,
containerSettings:
{
Description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. ,
Required: False ,
}
{
containerRunOptions:
{
Description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. ,
Required: False ,
}
string ,
imageName:
{
Description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. ,
Required: True ,
}
string ,
registry:
{
Description: This setting can be omitted if was already provided at pool creation. ,
Required: False ,
}
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Enum:
{
TaskWorkingDirectory: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. ,
ContainerImageDefault: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. ,
Required: False ,
}
[
{
source:
{
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
applicationPackages:
{
Description: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. ,
Required: False ,
}
[
{
id:
{
Required: True ,
}
string ,
version:
{
Description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. ,
Required: False ,
}
string ,
}
,
]
,
resizeOperationStatus:
{
Description: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). ,
Required: False ,
}
{
targetDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
resizeTimeout:
{
Description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
nodeDeallocationOption:
{
Description: The default value is requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
mountConfiguration:
{
Description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
accountKey:
{
Description: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
sasKey:
{
Description: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
userName:
{
Required: True ,
}
string ,
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
azureFileUrl:
{
Description: This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
upgradePolicy:
{
Description: Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Enum:
{
automatic: All virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The type of identity used for the Batch Pool. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the Batch Pool. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch pool. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pool_DisableAutoScale (new)
Description :  Disables automatic scaling for a pool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
poolName:
{
Description: The pool name. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: Contains information about a pool. ,
}
{
properties:
{
Description: The properties associated with the pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
lastModified:
{
Description: This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Enum:
{
Succeeded: The pool is available to run tasks subject to the availability of compute nodes. ,
Deleting: The user has requested that the pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
provisioningStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Enum:
{
Steady: The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. ,
Resizing: The pool is resizing; that is, compute nodes are being added to or removed from the pool. ,
Stopping: The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Required: False ,
}
{
virtualMachineConfiguration:
{
Required: False ,
}
{
imageReference:
{
Required: True ,
}
{
publisher:
{
Description: For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: For example, 18.04-LTS or 2022-datacenter. ,
Required: False ,
}
string ,
version:
{
Description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
id:
{
Description: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSkuId:
{
Description: The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: This property must not be specified if the imageReference specifies a Linux OS image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. ,
Required: False ,
}
[
{
lun:
{
Description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. ,
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
licenseType:
{
Description: This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. ,
Required: False ,
}
{
type:
{
Enum:
{
DockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
CriCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. ,
Required: False ,
}
[
string ,
]
,
customerManagedKey:
{
Description: Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. ,
Required: False ,
}
{
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. ,
Required: False ,
}
boolean ,
identityReference:
{
Description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
nodePlacementConfiguration:
{
Description: This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
Regional: All nodes in the pool will be allocated in the same region. ,
Zonal: Nodes in the pool will be spread across different zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
publisher:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
typeHandlerVersion:
{
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Contains configuration for ephemeral OSDisk settings. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Required: False ,
}
{
placement:
{
Description: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
CacheDisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskSizeGB:
{
Format: int32 ,
Required: False ,
}
integer ,
writeAcceleratorEnabled:
{
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
securityType:
{
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: False ,
}
enum ,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. ,
Required: False ,
}
{
enabled:
{
Required: False ,
}
boolean ,
imds:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
wireServer:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
}
,
}
,
serviceArtifactReference:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
}
,
currentDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
scaleSettings:
{
Description: Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. ,
Required: False ,
}
{
fixedScale:
{
Description: This property and autoScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
resizeTimeout:
{
Description: The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeDeallocationOption:
{
Description: If omitted, the default value is Requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
}
,
autoScale:
{
Description: This property and fixedScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
formula:
{
Required: True ,
}
string ,
evaluationInterval:
{
Description: If omitted, the default value is 15 minutes (PT15M). ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
autoScaleRun:
{
Description: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. ,
Required: False ,
}
{
evaluationTime:
{
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
interNodeCommunication:
{
Description: This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. ,
Enum:
{
Enabled: Enable network communication between virtual machines. ,
Disabled: Disable network communication between virtual machines. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for a pool. ,
Required: False ,
}
{
subnetId:
{
Description: The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVnetAssignmentScope:
{
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Required: False ,
}
{
inboundNatPools:
{
Description: The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Enum:
{
TCP: Use TCP for the endpoint. ,
UDP: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Enum:
{
Allow: Allow access. ,
Deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The public IP Address configuration of the networking configuration of a Pool. ,
Required: False ,
}
{
provision:
{
Description: The default value is BatchManaged ,
Enum:
{
BatchManaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
UserManaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
NoPublicIPAddresses: No public IP Address will be created for the Compute Nodes in the Pool. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
ipTags:
{
Required: False ,
}
[
{
ipTagType:
{
Description: Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
taskSlotsPerNode:
{
Description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: If not specified, the default is spread. ,
Required: False ,
}
{
jobDefaultOrder:
{
Description: If not specified, the default is none. ,
Enum:
{
None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. ,
CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. ,
}
,
Required: False ,
}
enum ,
nodeFillType:
{
Enum:
{
Spread: Tasks should be assigned evenly across all nodes in the pool. ,
Pack: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
password:
{
Required: True ,
}
string ,
elevationLevel:
{
Description: nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: Specifies login mode for the user. The default value is Interactive. ,
Enum:
{
Batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
Interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
startTask:
{
Description: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. ,
Required: False ,
}
string ,
resourceFiles:
{
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ,
Required: False ,
}
string ,
httpUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. ,
Required: False ,
}
string ,
filePath:
{
Description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: If omitted, the task runs as a non-administrative user unique to the task. ,
Required: False ,
}
{
userName:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
string ,
autoUser:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
Task: Specifies that the service should create a new user for the task. ,
Pool: Specifies that the task runs as the common auto user account which is created on every node in a pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. ,
Required: False ,
}
boolean ,
containerSettings:
{
Description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. ,
Required: False ,
}
{
containerRunOptions:
{
Description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. ,
Required: False ,
}
string ,
imageName:
{
Description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. ,
Required: True ,
}
string ,
registry:
{
Description: This setting can be omitted if was already provided at pool creation. ,
Required: False ,
}
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Enum:
{
TaskWorkingDirectory: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. ,
ContainerImageDefault: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. ,
Required: False ,
}
[
{
source:
{
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
applicationPackages:
{
Description: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. ,
Required: False ,
}
[
{
id:
{
Required: True ,
}
string ,
version:
{
Description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. ,
Required: False ,
}
string ,
}
,
]
,
resizeOperationStatus:
{
Description: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). ,
Required: False ,
}
{
targetDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
resizeTimeout:
{
Description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
nodeDeallocationOption:
{
Description: The default value is requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
mountConfiguration:
{
Description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
accountKey:
{
Description: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
sasKey:
{
Description: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
userName:
{
Required: True ,
}
string ,
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
azureFileUrl:
{
Description: This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
upgradePolicy:
{
Description: Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Enum:
{
automatic: All virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The type of identity used for the Batch Pool. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the Batch Pool. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch pool. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pool_StopResize (new)
Description :  This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
poolName:
{
Description: The pool name. This must be unique within the account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: Contains information about a pool. ,
}
{
properties:
{
Description: The properties associated with the pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
lastModified:
{
Description: This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Enum:
{
Succeeded: The pool is available to run tasks subject to the availability of compute nodes. ,
Deleting: The user has requested that the pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
provisioningStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Enum:
{
Steady: The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. ,
Resizing: The pool is resizing; that is, compute nodes are being added to or removed from the pool. ,
Stopping: The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Required: False ,
}
{
virtualMachineConfiguration:
{
Required: False ,
}
{
imageReference:
{
Required: True ,
}
{
publisher:
{
Description: For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: For example, 18.04-LTS or 2022-datacenter. ,
Required: False ,
}
string ,
version:
{
Description: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
id:
{
Description: This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSkuId:
{
Description: The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: This property must not be specified if the imageReference specifies a Linux OS image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. ,
Required: False ,
}
[
{
lun:
{
Description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. ,
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
licenseType:
{
Description: This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. ,
Required: False ,
}
{
type:
{
Enum:
{
DockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
CriCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. ,
Required: False ,
}
[
string ,
]
,
customerManagedKey:
{
Description: Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. ,
Required: False ,
}
{
keyUrl:
{
Description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. ,
Required: False ,
}
string ,
rotationToLatestKeyVersionEnabled:
{
Description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. ,
Required: False ,
}
boolean ,
identityReference:
{
Description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. ,
Required: False ,
}
string ,
}
,
}
,
}
,
nodePlacementConfiguration:
{
Description: This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
Regional: All nodes in the pool will be allocated in the same region. ,
Zonal: Nodes in the pool will be spread across different zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
publisher:
{
Required: True ,
}
string ,
type:
{
Required: True ,
}
string ,
typeHandlerVersion:
{
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Contains configuration for ephemeral OSDisk settings. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Required: False ,
}
{
placement:
{
Description: This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
CacheDisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Enum:
{
None: The caching mode for the disk is not enabled. ,
ReadOnly: The caching mode for the disk is read only. ,
ReadWrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
managedDisk:
{
Required: False ,
}
{
storageAccountType:
{
Enum:
{
Standard_LRS: The data disk / OS disk should use standard locally redundant storage. ,
Premium_LRS: The data disk / OS disk should use premium locally redundant storage. ,
StandardSSD_LRS: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. ,
Required: False ,
}
{
securityEncryptionType:
{
Enum:
{
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. ,
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. ,
VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskEncryptionSet:
{
Description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. ,
Required: False ,
}
{
id:
{
Description: The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. ,
Required: False ,
}
string ,
}
,
}
,
diskSizeGB:
{
Format: int32 ,
Required: False ,
}
integer ,
writeAcceleratorEnabled:
{
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
securityType:
{
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: False ,
}
enum ,
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. ,
Required: False ,
}
boolean ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
proxyAgentSettings:
{
Description: Specifies ProxyAgent settings while creating the virtual machine. ,
Required: False ,
}
{
enabled:
{
Required: False ,
}
boolean ,
imds:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
wireServer:
{
Required: False ,
}
{
mode:
{
Description: Specifies the access control policy execution mode. ,
Enum:
{
Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. ,
Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ,
}
,
Required: False ,
}
enum ,
inVMAccessControlProfileReferenceId:
{
Required: False ,
}
string ,
}
,
}
,
}
,
serviceArtifactReference:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
}
,
currentDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
scaleSettings:
{
Description: Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. ,
Required: False ,
}
{
fixedScale:
{
Description: This property and autoScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
resizeTimeout:
{
Description: The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeDeallocationOption:
{
Description: If omitted, the default value is Requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
}
,
autoScale:
{
Description: This property and fixedScale are mutually exclusive and one of the properties must be specified. ,
Required: False ,
}
{
formula:
{
Required: True ,
}
string ,
evaluationInterval:
{
Description: If omitted, the default value is 15 minutes (PT15M). ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
autoScaleRun:
{
Description: This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. ,
Required: False ,
}
{
evaluationTime:
{
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
interNodeCommunication:
{
Description: This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. ,
Enum:
{
Enabled: Enable network communication between virtual machines. ,
Disabled: Disable network communication between virtual machines. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for a pool. ,
Required: False ,
}
{
subnetId:
{
Description: The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVnetAssignmentScope:
{
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Required: False ,
}
{
inboundNatPools:
{
Description: The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Enum:
{
TCP: Use TCP for the endpoint. ,
UDP: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Enum:
{
Allow: Allow access. ,
Deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The public IP Address configuration of the networking configuration of a Pool. ,
Required: False ,
}
{
provision:
{
Description: The default value is BatchManaged ,
Enum:
{
BatchManaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
UserManaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
NoPublicIPAddresses: No public IP Address will be created for the Compute Nodes in the Pool. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
ipFamilies:
{
Description: IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. ,
Required: False ,
}
[
string ,
]
,
ipTags:
{
Required: False ,
}
[
{
ipTagType:
{
Description: Example: FirstPartyUsage. ,
Required: False ,
}
string ,
tag:
{
Description: Example: SQL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
taskSlotsPerNode:
{
Description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: If not specified, the default is spread. ,
Required: False ,
}
{
jobDefaultOrder:
{
Description: If not specified, the default is none. ,
Enum:
{
None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. ,
CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. ,
}
,
Required: False ,
}
enum ,
nodeFillType:
{
Enum:
{
Spread: Tasks should be assigned evenly across all nodes in the pool. ,
Pack: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
password:
{
Required: True ,
}
string ,
elevationLevel:
{
Description: nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: Specifies login mode for the user. The default value is Interactive. ,
Enum:
{
Batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
Interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: True ,
}
string ,
}
,
]
,
startTask:
{
Description: In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. ,
Required: False ,
}
string ,
resourceFiles:
{
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ,
Required: False ,
}
string ,
httpUrl:
{
Description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. ,
Required: False ,
}
string ,
filePath:
{
Description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Required: False ,
}
[
{
name:
{
Required: True ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: If omitted, the task runs as a non-administrative user unique to the task. ,
Required: False ,
}
{
userName:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
string ,
autoUser:
{
Description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
Task: Specifies that the service should create a new user for the task. ,
Pool: Specifies that the task runs as the common auto user account which is created on every node in a pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The default value is nonAdmin. ,
Enum:
{
NonAdmin: The user is a standard user without elevated access. ,
Admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. ,
Required: False ,
}
boolean ,
containerSettings:
{
Description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. ,
Required: False ,
}
{
containerRunOptions:
{
Description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. ,
Required: False ,
}
string ,
imageName:
{
Description: This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. ,
Required: True ,
}
string ,
registry:
{
Description: This setting can be omitted if was already provided at pool creation. ,
Required: False ,
}
{
username:
{
Required: False ,
}
string ,
password:
{
Required: False ,
}
string ,
registryServer:
{
Description: If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to a user assigned identity associated with the Batch pool which a compute node will use. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Enum:
{
TaskWorkingDirectory: Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. ,
ContainerImageDefault: Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. ,
Required: False ,
}
[
{
source:
{
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
applicationPackages:
{
Description: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. ,
Required: False ,
}
[
{
id:
{
Required: True ,
}
string ,
version:
{
Description: If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. ,
Required: False ,
}
string ,
}
,
]
,
resizeOperationStatus:
{
Description: Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). ,
Required: False ,
}
{
targetDedicatedNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Format: int32 ,
Required: False ,
}
integer ,
resizeTimeout:
{
Description: The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
nodeDeallocationOption:
{
Description: The default value is requeue. ,
Enum:
{
Requeue: Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. ,
Terminate: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated. ,
TaskCompletion: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. ,
RetainedData: Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: True ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
mountConfiguration:
{
Description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
accountKey:
{
Description: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
sasKey:
{
Description: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
userName:
{
Required: True ,
}
string ,
source:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Required: True ,
}
string ,
azureFileUrl:
{
Description: This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Required: True ,
}
string ,
relativeMountPath:
{
Description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
upgradePolicy:
{
Description: Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Enum:
{
automatic: All virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
identity:
{
Description: The type of identity used for the Batch Pool. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the Batch Pool. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch pool. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BatchAccount_ListOutboundNetworkDependenciesEndpoints (new)
Description :  Lists 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://learn.microsoft.com/azure/batch/batch-virtual-network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/outboundNetworkDependenciesEndpoints
{
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of outbound network dependency endpoints returned by the listing operation. ,
Required: False ,
}
[
{
category:
{
Description: The type of service that the Batch service connects to. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints for this service to which the Batch service makes outbound calls. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable supplemental information about the dependency and when it is applicable. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The list of connection details for this endpoint. ,
Required: False ,
}
[
{
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NetworkSecurityPerimeter_ListConfigurations (new)
Description :  Lists all of the NSP configurations in the specified account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/networkSecurityPerimeterConfigurations
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of network security perimeter results. ,
Required: False ,
}
[
{
properties:
{
Description: Network security configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a network security perimeter configuration that is being created or updated. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of provisioning issues, if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules ,
Required: False ,
}
{
issueType:
{
Description: Type of issue ,
Enum:
{
Unknown: Unknown issue type ,
ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration. ,
MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules. ,
MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the issue. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the network security profile (NSP) to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: Applies to inbound network traffic to the secured resources. ,
Outbound: Applies to outbound network traffic from the secured resources ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names (FQDN) for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about a network security perimeter (NSP) ,
Required: False ,
}
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode of the resource association ,
Enum:
{
Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked ,
Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked ,
Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Network security perimeter configuration profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int32 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: Applies to inbound network traffic to the secured resources. ,
Outbound: Applies to outbound network traffic from the secured resources ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names (FQDN) for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int32 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories that are enabled ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NetworkSecurityPerimeter_GetConfiguration (new)
Description :  Gets information about the specified NSP configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
networkSecurityPerimeterConfigurationName:
{
Description: The name for Network Security Perimeter configuration ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Network security configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a network security perimeter configuration that is being created or updated. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of provisioning issues, if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules ,
Required: False ,
}
{
issueType:
{
Description: Type of issue ,
Enum:
{
Unknown: Unknown issue type ,
ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration. ,
MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules. ,
MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the issue. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the network security profile (NSP) to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: Applies to inbound network traffic to the secured resources. ,
Outbound: Applies to outbound network traffic from the secured resources ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names (FQDN) for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about a network security perimeter (NSP) ,
Required: False ,
}
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode of the resource association ,
Enum:
{
Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked ,
Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked ,
Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Network security perimeter configuration profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int32 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: Applies to inbound network traffic to the secured resources. ,
Outbound: Applies to outbound network traffic from the secured resources ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names (FQDN) for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int32 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories that are enabled ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NetworkSecurityPerimeter_ReconcileConfiguration (new)
Description :  Reconciles the specified NSP configuration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Batch account. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Batch account. ,
Required: True ,
}
string ,
networkSecurityPerimeterConfigurationName:
{
Description: The name for Network Security Perimeter configuration ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}