Pool - Add

Adds a Pool to the specified Account.
When naming Pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

POST {batchUrl}/pools?api-version=2023-11-01.18.0
POST {batchUrl}/pools?timeout={timeout}&api-version=2023-11-01.18.0

URI Parameters

Name In Required Type Description
batchUrl
path True

string

The base URL for all Azure Batch service requests.

api-version
query True

string

Client API Version.

timeout
query

integer

int32

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Request Header

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
client-request-id

string

uuid

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Whether the server should return the client-request-id in the response.

ocp-date

string

date-time-rfc1123

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Request Body

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
id True

string

A string that uniquely identifies the Pool within the Account.
The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case).

vmSize True

string

The size of virtual machines in the Pool. All virtual machines in a Pool are the same size.
For information about available sizes of virtual machines for Cloud Services Pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for Pools using Images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

applicationLicenses

string[]

The list of application licenses the Batch service will make available on each Compute Node in the Pool.
The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail.

applicationPackageReferences

ApplicationPackageReference[]

The list of Packages to be installed on each Compute Node in the Pool.
When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new 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 Package references on any given Pool.

autoScaleEvaluationInterval

string

The time interval at which to automatically adjust the Pool size according to the autoscale formula.
The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

autoScaleFormula

string

A formula for the desired number of Compute Nodes in the Pool.
This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

certificateReferences

CertificateReference[]

The list of Certificates to be installed on each Compute Node in the Pool.
For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.

Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

cloudServiceConfiguration

CloudServiceConfiguration

The cloud service configuration for the Pool.
This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'.

displayName

string

The display name for the Pool.
The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

enableAutoScale

boolean

Whether the Pool size should automatically adjust over time.
If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false.

enableInterNodeCommunication

boolean

Whether the Pool permits direct communication between Compute Nodes.
Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.

metadata

MetadataItem[]

A list of name-value pairs associated with the Pool as metadata.
The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

mountConfiguration

MountConfiguration[]

Mount storage using specified file system for the entire lifetime of the pool.
Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.

networkConfiguration

NetworkConfiguration

The network configuration for the Pool.
The network configuration for a Pool.

resizeTimeout

string

The timeout for allocation of Compute Nodes to the Pool.
This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. 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).

resourceTags

object

The user-specified tags associated with the pool.
The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.

startTask

StartTask

A Task specified to run on each Compute Node as it joins the Pool.
The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted.

targetDedicatedNodes

integer

The desired number of dedicated Compute Nodes in the Pool.
This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

targetLowPriorityNodes

integer

The desired number of Spot/Low-priority Compute Nodes in the Pool.
This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

targetNodeCommunicationMode

NodeCommunicationMode

The desired node communication mode for the pool.
If omitted, the default value is Default.

taskSchedulingPolicy

TaskSchedulingPolicy

How Tasks are distributed across Compute Nodes in a Pool.
If not specified, the default is spread.

taskSlotsPerNode

integer

The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.
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.

userAccounts

UserAccount[]

The list of user Accounts to be created on each Compute Node in the Pool.

virtualMachineConfiguration

VirtualMachineConfiguration

The virtual machine configuration for the Pool.
This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

Responses

Name Type Description
201 Created

The request to the Batch service was successful.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

The error from the Batch service.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

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

Scopes

Name Description
user_impersonation Impersonate your user account

Authorization

Type: apiKey
In: header

Examples

Add a CloudServiceConfiguration pool
Add a pool with accelerated networking
Add a pool with mount drive specified
Add a pool with SecurityProfile
Add a simple pool with resourceTags
Add a VirtualMachineConfiguration pool
Add a VirtualMachineConfiguration pool with containers
Add a VirtualMachineConfiguration pool with extensions
Add a VirtualMachineConfiguration pool with OS disk
Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Add a CloudServiceConfiguration pool

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "poolId",
  "vmSize": "small",
  "cloudServiceConfiguration": {
    "osFamily": "4"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Add a pool with accelerated networking

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "mypool01",
  "vmSize": "Standard_D1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "networkConfiguration": {
    "enableAcceleratedNetworking": true
  }
}

Sample Response

Add a pool with mount drive specified

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0


{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Sample Response

Add a pool with SecurityProfile

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04",
    "securityProfile": {
      "securityType": "trustedLaunch",
      "encryptionAtHost": true,
      "uefiSettings": {
        "secureBootEnabled": false
      }
    }
  },
  "targetDedicatedNodes": 1
}

Sample Response

Add a simple pool with resourceTags

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04"
  },
  "targetDedicatedNodes": 1,
  "resourceTags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  }
}

Sample Response

Add a VirtualMachineConfiguration pool

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Add a VirtualMachineConfiguration pool with containers

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "120_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Sample Response

Add a VirtualMachineConfiguration pool with extensions

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "KeyVaultForLinux",
        "publisher": "Microsoft.Azure.KeyVault",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true,
        "settings": "{\"secretsManagementSettingsKey\":\"secretsManagementSettingsValue\",\"authenticationSettingsKey\":\"authenticationSettingsValue\"}"
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ],
  "targetNodeCommunicationMode": "simplified"
}

Sample Response

Add a VirtualMachineConfiguration pool with OS disk

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "mypool001",
  "vmSize": "standard_d2s_v3",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "osDisk": {
      "diskSizeGB": 100,
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "caching": "readwrite",
      "ephemeralOSDiskSettings": {
        "placement": "CacheDisk"
      }
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 1,
  "enableAutoScale": false
}

Sample Response

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Sample Request

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "mypool002",
  "vmSize": "Standard_A1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2
}

Sample Response

Definitions

Name Description
ApplicationPackageReference

A reference to an Package to be deployed to Compute Nodes.

AutoUserScope

The scope for the auto user

AutoUserSpecification

Specifies the parameters for the auto user that runs a Task on the Batch service.

AzureBlobFileSystemConfiguration

Information used to connect to an Azure Storage Container using Blobfuse.

AzureFileShareConfiguration

Information used to connect to an Azure Fileshare.

BatchError

An error response received from the Azure Batch service.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

CachingType

The type of caching to enable for the disk.

CertificateReference

A reference to a Certificate to be installed on Compute Nodes in a Pool.

CertificateStoreLocation

The location of the Certificate store on the Compute Node into which to install the Certificate.

CertificateVisibility

Which user Accounts on the Compute Node should have access to the private data of the Certificate.

CIFSMountConfiguration

Information used to connect to a CIFS file system.

CloudServiceConfiguration

The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.

ComputeNodeFillType

How Tasks are distributed across Compute Nodes in a Pool.

ComputeNodeIdentityReference

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

ContainerConfiguration

The configuration for container-enabled Pools.

ContainerRegistry

A private container registry.

ContainerType

The container technology to be used.

ContainerWorkingDirectory

The location of the container Task working directory.

DataDisk

Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool.

DiffDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).

DiskEncryptionConfiguration

The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute Gallery Image.

DiskEncryptionTarget

The list of disk targets Batch Service will encrypt on the compute node.

DynamicVNetAssignmentScope

The scope of dynamic vnet assignment.

ElevationLevel

The elevation level of the user.

EnvironmentSetting

An environment variable to be set on a Task process.

ErrorMessage

An error message received in an Azure Batch error response.

ImageReference

A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation.

InboundEndpointProtocol

The protocol of the endpoint.

InboundNATPool

A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.

IPAddressProvisioningType

The provisioning type for Public IP Addresses for the Pool.

LinuxUserConfiguration

Properties used to create a user Account on a Linux Compute Node.

LoginMode

The login mode for the user

ManagedDisk
MetadataItem

A name-value pair associated with a Batch service resource.

MountConfiguration

The file system to mount on each node.

NetworkConfiguration

The network configuration for a Pool.

NetworkSecurityGroupRule

A network security group rule to apply to an inbound endpoint.

NetworkSecurityGroupRuleAccess

The action that should be taken for a specified IP address, subnet range or tag.

NFSMountConfiguration

Information used to connect to an NFS file system.

NodeCommunicationMode

Determines how a pool communicates with the Batch service.

NodePlacementConfiguration

Node placement configuration for a pool.

NodePlacementPolicyType

The placement policy for allocating nodes in the pool.

OSDisk

Settings for the operating system disk of the compute node (VM).

PoolAddParameter

A Pool in the Azure Batch service to add.

PoolEndpointConfiguration

The endpoint configuration for a Pool.

PublicIPAddressConfiguration

The public IP Address configuration of the networking configuration of a Pool.

ResourceFile

A single file or multiple files to be downloaded to a Compute Node.

SecurityProfile

Specifies the security profile settings for the virtual machine or virtual machine scale set.

SecurityTypes

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

ServiceArtifactReference

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.

StartTask

A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged.

StorageAccountType

The storage Account type for use in creating data disks or OS disk.

TaskContainerSettings

The container settings for a Task.

TaskSchedulingPolicy

Specifies how Tasks should be distributed across Compute Nodes.

UefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

UserAccount

Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.

UserIdentity

The definition of the user identity under which the Task is run.

VirtualMachineConfiguration

The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.

VMExtension

The configuration for virtual machine extensions.

WindowsConfiguration

Windows operating system settings to apply to the virtual machine.

WindowsUserConfiguration

Properties used to create a user Account on a Windows Compute Node.

ApplicationPackageReference

A reference to an Package to be deployed to Compute Nodes.

Name Type Description
applicationId

string

The ID of the application to deploy.
When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

The version of the application to deploy. If omitted, the default version is deployed.
If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error.

AutoUserScope

The scope for the auto user

Name Type Description
pool

string

Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool.

task

string

Specifies that the service should create a new user for the Task.

AutoUserSpecification

Specifies the parameters for the auto user that runs a Task on the Batch service.

Name Type Description
elevationLevel

ElevationLevel

The elevation level of the auto user.
The default value is nonAdmin.

scope

AutoUserScope

The scope for the auto user
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, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks.

AzureBlobFileSystemConfiguration

Information used to connect to an Azure Storage Container using Blobfuse.

Name Type Description
accountKey

string

The Azure Storage Account key.
This property is mutually exclusive with both sasKey and identity; exactly one must be specified.

accountName

string

The Azure Storage Account name.

blobfuseOptions

string

Additional command line options to pass to the mount command.
These are 'net use' options in Windows and 'mount' options in Linux.

containerName

string

The Azure Blob Storage Container name.

identityReference

ComputeNodeIdentityReference

The reference to the user assigned identity to use to access containerName
This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.

relativeMountPath

string

The relative path on the compute node where the file system will be mounted
All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

sasKey

string

The Azure Storage SAS token.
This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

AzureFileShareConfiguration

Information used to connect to an Azure Fileshare.

Name Type Description
accountKey

string

The Azure Storage account key.

accountName

string

The Azure Storage account name.

azureFileUrl

string

The Azure Files URL.
This is of the form 'https://{account}.file.core.windows.net/'.

mountOptions

string

Additional command line options to pass to the mount command.
These are 'net use' options in Windows and 'mount' options in Linux.

relativeMountPath

string

The relative path on the compute node where the file system will be mounted
All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

BatchError

An error response received from the Azure Batch service.

Name Type Description
code

string

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

message

ErrorMessage

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

values

BatchErrorDetail[]

A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

Name Type Description
key

string

An identifier specifying the meaning of the Value property.

value

string

The additional information included with the error response.

CachingType

The type of caching to enable for the disk.

Name Type Description
none

string

The caching mode for the disk is not enabled.

readonly

string

The caching mode for the disk is read only.

readwrite

string

The caching mode for the disk is read and write.

CertificateReference

A reference to a Certificate to be installed on Compute Nodes in a Pool.

Name Type Description
storeLocation

CertificateStoreLocation

The location of the Certificate store on the Compute Node into which to install the Certificate.
The default value is currentuser. This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.

storeName

string

The name of the Certificate store on the Compute Node into which to install the Certificate.
This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

thumbprint

string

The thumbprint of the Certificate.

thumbprintAlgorithm

string

The algorithm with which the thumbprint is associated. This must be sha1.

visibility

CertificateVisibility[]

Which user Accounts on the Compute Node should have access to the private data of the Certificate.
You can specify more than one visibility in this collection. The default is all Accounts.

CertificateStoreLocation

The location of the Certificate store on the Compute Node into which to install the Certificate.

Name Type Description
currentuser

string

Certificates should be installed to the CurrentUser Certificate store.

localmachine

string

Certificates should be installed to the LocalMachine Certificate store.

CertificateVisibility

Which user Accounts on the Compute Node should have access to the private data of the Certificate.

Name Type Description
remoteuser

string

The Certificate should be visible to the user accounts under which users remotely access the Compute Node.

starttask

string

The Certificate should be visible to the user account under which the StartTask is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well.

task

string

The Certificate should be visible to the user accounts under which Job Tasks are run.

CIFSMountConfiguration

Information used to connect to a CIFS file system.

Name Type Description
mountOptions

string

Additional command line options to pass to the mount command.
These are 'net use' options in Windows and 'mount' options in Linux.

password

string

The password to use for authentication against the CIFS file system.

relativeMountPath

string

The relative path on the compute node where the file system will be mounted
All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source

string

The URI of the file system to mount.

username

string

The user to use for authentication against the CIFS file system.

CloudServiceConfiguration

The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.

Name Type Description
osFamily

string

The Azure Guest OS family to be installed on the virtual machines in the Pool.
Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

osVersion

string

The Azure Guest OS version to be installed on the virtual machines in the Pool.
The default value is * which specifies the latest operating system version for the specified OS family.

ComputeNodeFillType

How Tasks are distributed across Compute Nodes in a Pool.

Name Type Description
pack

string

As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool.

spread

string

Tasks should be assigned evenly across all Compute Nodes in the Pool.

ComputeNodeIdentityReference

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

Name Type Description
resourceId

string

The ARM resource id of the user assigned identity.

ContainerConfiguration

The configuration for container-enabled Pools.

Name Type Description
containerImageNames

string[]

The collection of container Image names.
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.

containerRegistries

ContainerRegistry[]

Additional private registries from which containers can be pulled.
If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

type

ContainerType

The container technology to be used.

ContainerRegistry

A private container registry.

Name Type Description
identityReference

ComputeNodeIdentityReference

The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.
The reference to a user assigned identity associated with the Batch pool which a compute node will use.

password

string

The password to log into the registry server.

registryServer

string

The registry URL.
If omitted, the default is "docker.io".

username

string

The user name to log into the registry server.

ContainerType

The container technology to be used.

Name Type Description
criCompatible

string

A CRI based technology will be used to launch the containers.

dockerCompatible

string

A Docker compatible container technology will be used to launch the containers.

ContainerWorkingDirectory

The location of the container Task working directory.

Name Type Description
containerImageDefault

string

Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch.

taskWorkingDirectory

string

Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch.

DataDisk

Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.

Name Type Description
caching

CachingType

The type of caching to be enabled for the data disks.
The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

The initial disk size in gigabytes.

lun

integer

The logical unit number.
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.

storageAccountType

StorageAccountType

The storage Account type to be used for the data disk.
If omitted, the default is "standard_lrs".

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool.

Name Type Description
CacheDisk

string

The Ephemeral OS Disk is stored on the VM cache.

DiffDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).

Name Type Description
placement

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.
This property can be used by user in the request to choose the location 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://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute Gallery Image.

Name Type Description
targets

DiskEncryptionTarget[]

The list of disk targets Batch Service will encrypt on the compute node.
If omitted, no disks on the compute nodes in the pool will be encrypted. On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.

DiskEncryptionTarget

The list of disk targets Batch Service will encrypt on the compute node.

Name Type Description
osdisk

string

The OS Disk on the compute node is encrypted.

temporarydisk

string

The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time.

DynamicVNetAssignmentScope

The scope of dynamic vnet assignment.

Name Type Description
job

string

Dynamic VNet assignment is done per-job.

none

string

No dynamic VNet assignment is enabled.

ElevationLevel

The elevation level of the user.

Name Type Description
admin

string

The user is a user with elevated access and operates with full Administrator permissions.

nonadmin

string

The user is a standard user without elevated access.

EnvironmentSetting

An environment variable to be set on a Task process.

Name Type Description
name

string

The name of the environment variable.

value

string

The value of the environment variable.

ErrorMessage

An error message received in an Azure Batch error response.

Name Type Description
lang

string

The language code of the error message

value

string

The text of the message.

ImageReference

A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation.

Name Type Description
exactVersion

string

The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'.

offer

string

The offer type of the Azure Virtual Machines Marketplace Image.
For example, UbuntuServer or WindowsServer.

publisher

string

The publisher of the Azure Virtual Machines Marketplace Image.
For example, Canonical or MicrosoftWindowsServer.

sku

string

The SKU of the Azure Virtual Machines Marketplace Image.
For example, 18.04-LTS or 2019-Datacenter.

version

string

The version of the Azure Virtual Machines Marketplace Image.
A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'.

virtualMachineImageId

string

The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version.
This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

The protocol of the endpoint.

Name Type Description
tcp

string

Use TCP for the endpoint.

udp

string

Use UDP for the endpoint.

InboundNATPool

A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.

Name Type Description
backendPort

integer

The port number on the Compute Node.
This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

frontendPortRangeEnd

integer

The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes.
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. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

frontendPortRangeStart

integer

The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes.
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. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

name

string

The name of the endpoint.
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.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

A list of network security group rules that will be applied to the endpoint.
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.

protocol

InboundEndpointProtocol

The protocol of the endpoint.

IPAddressProvisioningType

The provisioning type for Public IP Addresses for the Pool.

Name Type Description
batchmanaged

string

A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool.

nopublicipaddresses

string

No public IP Address will be created.

usermanaged

string

Public IPs are provided by the user and will be used to provision the Compute Nodes.

LinuxUserConfiguration

Properties used to create a user Account on a Linux Compute Node.

Name Type Description
gid

integer

The group ID for the user Account.
The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

sshPrivateKey

string

The SSH private key for the user Account.
The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute 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 Compute Nodes (no modification of the user's .ssh directory is done).

uid

integer

The user ID of the user Account.
The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

LoginMode

The login mode for the user

Name Type Description
batch

string

The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes.

interactive

string

The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege.

ManagedDisk

Name Type Description
storageAccountType

StorageAccountType

The storage account type for managed disk.

MetadataItem

A name-value pair associated with a Batch service resource.

Name Type Description
name

string

The name of the metadata item.

value

string

The value of the metadata item.

MountConfiguration

The file system to mount on each node.

Name Type Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

The Azure Storage Container to mount using blob FUSE on each node.
This property is mutually exclusive with all other properties.

azureFileShareConfiguration

AzureFileShareConfiguration

The Azure File Share to mount on each node.
This property is mutually exclusive with all other properties.

cifsMountConfiguration

CIFSMountConfiguration

The CIFS/SMB file system to mount on each node.
This property is mutually exclusive with all other properties.

nfsMountConfiguration

NFSMountConfiguration

The NFS file system to mount on each node.
This property is mutually exclusive with all other properties.

NetworkConfiguration

The network configuration for a Pool.

Name Type Description
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

The scope of dynamic vnet assignment.

enableAcceleratedNetworking

boolean

Whether this pool should enable accelerated networking.
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.

endpointConfiguration

PoolEndpointConfiguration

The configuration for endpoints on Compute Nodes in the Batch Pool.
Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property.

publicIPAddressConfiguration

PublicIPAddressConfiguration

The Public IPAddress configuration for Compute Nodes in the Batch Pool.
Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property.

subnetId

string

The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
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 Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate 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 Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For Pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For Pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

A network security group rule to apply to an inbound endpoint.

Name Type Description
access

NetworkSecurityGroupRuleAccess

The action that should be taken for a specified IP address, subnet range or tag.

priority

integer

The priority for this rule.
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.

sourceAddressPrefix

string

The source address prefix or tag to match for the rule.
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.

sourcePortRanges

string[]

The source port ranges to match for the rule.
Valid values are '' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is ''.

NetworkSecurityGroupRuleAccess

The action that should be taken for a specified IP address, subnet range or tag.

Name Type Description
allow

string

Allow access.

deny

string

Deny access.

NFSMountConfiguration

Information used to connect to an NFS file system.

Name Type Description
mountOptions

string

Additional command line options to pass to the mount command.
These are 'net use' options in Windows and 'mount' options in Linux.

relativeMountPath

string

The relative path on the compute node where the file system will be mounted
All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

source

string

The URI of the file system to mount.

NodeCommunicationMode

Determines how a pool communicates with the Batch service.

Name Type Description
classic

string

Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags.

default

string

The node communication mode is automatically set by the Batch service.

simplified

string

Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required.

NodePlacementConfiguration

Node placement configuration for a pool.

Name Type Description
policy

NodePlacementPolicyType

Node placement Policy type on Batch Pools.
Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

NodePlacementPolicyType

The placement policy for allocating nodes in the pool.

Name Type Description
regional

string

All nodes in the pool will be allocated in the same region.

zonal

string

Nodes in the pool will be spread across different availability zones with best effort balancing.

OSDisk

Settings for the operating system disk of the compute node (VM).

Name Type Description
caching

CachingType

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
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/.

diskSizeGB

integer

The initial disk size in GB when creating new OS disk.

ephemeralOSDiskSettings

DiffDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).

managedDisk

ManagedDisk

The managed disk parameters.

writeAcceleratorEnabled

boolean

Specifies whether writeAccelerator should be enabled or disabled on the disk.

PoolAddParameter

A Pool in the Azure Batch service to add.

Name Type Description
applicationLicenses

string[]

The list of application licenses the Batch service will make available on each Compute Node in the Pool.
The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail.

applicationPackageReferences

ApplicationPackageReference[]

The list of Packages to be installed on each Compute Node in the Pool.
When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new 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 Package references on any given Pool.

autoScaleEvaluationInterval

string

The time interval at which to automatically adjust the Pool size according to the autoscale formula.
The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

autoScaleFormula

string

A formula for the desired number of Compute Nodes in the Pool.
This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

certificateReferences

CertificateReference[]

The list of Certificates to be installed on each Compute Node in the Pool.
For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.

Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

cloudServiceConfiguration

CloudServiceConfiguration

The cloud service configuration for the Pool.
This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'.

displayName

string

The display name for the Pool.
The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

enableAutoScale

boolean

Whether the Pool size should automatically adjust over time.
If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false.

enableInterNodeCommunication

boolean

Whether the Pool permits direct communication between Compute Nodes.
Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.

id

string

A string that uniquely identifies the Pool within the Account.
The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case).

metadata

MetadataItem[]

A list of name-value pairs associated with the Pool as metadata.
The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

mountConfiguration

MountConfiguration[]

Mount storage using specified file system for the entire lifetime of the pool.
Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.

networkConfiguration

NetworkConfiguration

The network configuration for the Pool.
The network configuration for a Pool.

resizeTimeout

string

The timeout for allocation of Compute Nodes to the Pool.
This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. 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).

resourceTags

object

The user-specified tags associated with the pool.
The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.

startTask

StartTask

A Task specified to run on each Compute Node as it joins the Pool.
The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted.

targetDedicatedNodes

integer

The desired number of dedicated Compute Nodes in the Pool.
This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

targetLowPriorityNodes

integer

The desired number of Spot/Low-priority Compute Nodes in the Pool.
This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

targetNodeCommunicationMode

NodeCommunicationMode

The desired node communication mode for the pool.
If omitted, the default value is Default.

taskSchedulingPolicy

TaskSchedulingPolicy

How Tasks are distributed across Compute Nodes in a Pool.
If not specified, the default is spread.

taskSlotsPerNode

integer

The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.
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.

userAccounts

UserAccount[]

The list of user Accounts to be created on each Compute Node in the Pool.

virtualMachineConfiguration

VirtualMachineConfiguration

The virtual machine configuration for the Pool.
This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

vmSize

string

The size of virtual machines in the Pool. All virtual machines in a Pool are the same size.
For information about available sizes of virtual machines for Cloud Services Pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for Pools using Images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

PoolEndpointConfiguration

The endpoint configuration for a Pool.

Name Type Description
inboundNATPools

InboundNATPool[]

A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally.
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.

PublicIPAddressConfiguration

The public IP Address configuration of the networking configuration of a Pool.

Name Type Description
ipAddressIds

string[]

The list of public IPs which the Batch service will use when provisioning Compute Nodes.
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}.

provision

IPAddressProvisioningType

The provisioning type for Public IP Addresses for the Pool.
The default value is BatchManaged.

ResourceFile

A single file or multiple files to be downloaded to a Compute Node.

Name Type Description
autoStorageContainerName

string

The storage container name in the auto storage Account.
The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

blobPrefix

string

The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.
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.

fileMode

string

The file permission mode attribute in octal format.
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 Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file.

filePath

string

The location on the Compute Node to which to download the file(s), relative to the Task's working directory.
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 '..').

httpUrl

string

The URL of the file to download.
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.

identityReference

ComputeNodeIdentityReference

The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl
The reference to a user assigned identity associated with the Batch pool which a compute node will use.

storageContainerUrl

string

The URL of the blob container within Azure Blob Storage.
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.

SecurityProfile

Specifies the security profile settings for the virtual machine or virtual machine scale set.

Name Type Description
encryptionAtHost

boolean

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.

securityType

SecurityTypes

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

uefiSettings

UefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

SecurityTypes

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

Name Type Description
trustedLaunch

string

Trusted launch protects against advanced and persistent attack techniques.

ServiceArtifactReference

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.

Name Type Description
id

string

The service artifact reference id of ServiceArtifactReference
The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged.

Name Type Description
commandLine

string

The command line of the StartTask.
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. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

The settings for the container under which the StartTask runs.
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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.

environmentSettings

EnvironmentSetting[]

A list of environment variable settings for the StartTask.

maxTaskRetryCount

integer

The maximum number of times the Task may be retried.
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, however this is not recommended for a start task or any task. The default value is 0 (no retries).

resourceFiles

ResourceFile[]

A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
Files listed under this element are located in the Task's working directory.

userIdentity

UserIdentity

The user identity under which the StartTask runs.
If omitted, the Task runs as a non-administrative user unique to the Task.

waitForSuccess

boolean

Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node.
If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true.

StorageAccountType

The storage Account type for use in creating data disks or OS disk.

Name Type Description
premium_lrs

string

The data disk / OS disk should use premium locally redundant storage.

standard_lrs

string

The data disk / OS disk should use standard locally redundant storage.

standardssd_lrs

string

The data disk / OS disk should use standard SSD locally redundant storage.

TaskContainerSettings

The container settings for a Task.

Name Type Description
containerRunOptions

string

Additional options to the container create command.
These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

imageName

string

The Image to use to create the container in which the Task will run.
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.

registry

ContainerRegistry

The private registry which contains the container Image.
This setting can be omitted if was already provided at Pool creation.

workingDirectory

ContainerWorkingDirectory

The location of the container Task working directory.
The default is 'taskWorkingDirectory'.

TaskSchedulingPolicy

Specifies how Tasks should be distributed across Compute Nodes.

Name Type Description
nodeFillType

ComputeNodeFillType

How Tasks are distributed across Compute Nodes in a Pool.
If not specified, the default is spread.

UefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Name Type Description
secureBootEnabled

boolean

Specifies whether secure boot should be enabled on the virtual machine.

vTpmEnabled

boolean

Specifies whether vTPM should be enabled on the virtual machine.

UserAccount

Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.

Name Type Description
elevationLevel

ElevationLevel

The elevation level of the user Account.
The default value is nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

The Linux-specific user configuration for the user Account.
This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options.

name

string

The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20.

password

string

The password for the user Account.

windowsUserConfiguration

WindowsUserConfiguration

The Windows-specific user configuration for the user Account.
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.

UserIdentity

The definition of the user identity under which the Task is run.

Name Type Description
autoUser

AutoUserSpecification

The auto user under which the Task is run.
The userName and autoUser properties are mutually exclusive; you must specify one but not both.

username

string

The name of the user identity under which the Task is run.
The userName and autoUser properties are mutually exclusive; you must specify one but not both.

VirtualMachineConfiguration

The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.

Name Type Description
containerConfiguration

ContainerConfiguration

The container configuration for the Pool.
If specified, setup is performed on each Compute 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.

dataDisks

DataDisk[]

The configuration for data disks attached to the Compute Nodes in the Pool.
This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

The disk encryption configuration for the pool.
If specified, encryption is performed on each node in the pool during node provisioning.

extensions

VMExtension[]

The virtual machine extension for the pool.
If specified, the extensions mentioned in this configuration will be installed on each node.

imageReference

ImageReference

A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.

licenseType

string

The type of on-premises license to be used when deploying the operating system.
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 Compute 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.

nodeAgentSKUId

string

The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool.
The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation.

nodePlacementConfiguration

NodePlacementConfiguration

The node placement configuration for the pool.
This configuration will specify rules on how nodes in the pool will be physically allocated.

osDisk

OSDisk

Settings for the operating system disk of the Virtual Machine.

securityProfile

SecurityProfile

Specifies the security profile settings for the virtual machine or virtual machine scale set.
Specifies the security profile settings for the virtual machine or virtual machine scale set.

serviceArtifactReference

ServiceArtifactReference

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.
The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Windows operating system settings on the virtual machine.
This property must not be specified if the imageReference property specifies a Linux OS Image.

VMExtension

The configuration for virtual machine extensions.

Name Type Description
autoUpgradeMinorVersion

boolean

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.

enableAutomaticUpgrade

boolean

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

name

string

The name of the virtual machine extension.

protectedSettings

object

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

provisionAfterExtensions

string[]

The collection of extension names.
Collection of extension names after which this extension needs to be provisioned.

publisher

string

The name of the extension handler publisher.

settings

object

JSON formatted public settings for the extension.

type

string

The type of the extension.

typeHandlerVersion

string

The version of script handler.

WindowsConfiguration

Windows operating system settings to apply to the virtual machine.

Name Type Description
enableAutomaticUpdates

boolean

Whether automatic updates are enabled on the virtual machine.
If omitted, the default value is true.

WindowsUserConfiguration

Properties used to create a user Account on a Windows Compute Node.

Name Type Description
loginMode

LoginMode

The login mode for the user
The default value for VirtualMachineConfiguration Pools is 'batch' and for CloudServiceConfiguration Pools is 'interactive'.