Microsoft.Batch batchAccounts/pools 2019-04-01

The batchAccounts/pools resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Batch/batchAccounts/pools resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Batch/batchAccounts/pools@2019-04-01' = {
  name: 'string'
  properties: {
    applicationLicenses: [ 'string' ]
    applicationPackages: [
      {
        id: 'string'
        version: 'string'
      }
    ]
    certificates: [
      {
        id: 'string'
        storeLocation: 'string'
        storeName: 'string'
        visibility: [ 'string' ]
      }
    ]
    deploymentConfiguration: {
      cloudServiceConfiguration: {
        osFamily: 'string'
        osVersion: 'string'
      }
      virtualMachineConfiguration: {
        containerConfiguration: {
          containerImageNames: [ 'string' ]
          containerRegistries: [
            {
              password: 'string'
              registryServer: 'string'
              username: 'string'
            }
          ]
          type: 'DockerCompatible'
        }
        dataDisks: [
          {
            diskSizeGB: int
            lun: int
            storageAccountType: 'string'
          }
        ]
        imageReference: {
          id: 'string'
          offer: 'string'
          publisher: 'string'
          sku: 'string'
          version: 'string'
        }
        licenseType: 'string'
        nodeAgentSkuId: 'string'
        windowsConfiguration: {
          enableAutomaticUpdates: bool
        }
      }
    }
    displayName: 'string'
    interNodeCommunication: 'string'
    maxTasksPerNode: int
    metadata: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    networkConfiguration: {
      endpointConfiguration: {
        inboundNatPools: [
          {
            backendPort: int
            frontendPortRangeEnd: int
            frontendPortRangeStart: int
            name: 'string'
            networkSecurityGroupRules: [
              {
                access: 'string'
                priority: int
                sourceAddressPrefix: 'string'
              }
            ]
            protocol: 'string'
          }
        ]
      }
      subnetId: 'string'
    }
    scaleSettings: {
      autoScale: {
        evaluationInterval: 'string'
        formula: 'string'
      }
      fixedScale: {
        nodeDeallocationOption: 'string'
        resizeTimeout: 'string'
        targetDedicatedNodes: int
        targetLowPriorityNodes: int
      }
    }
    startTask: {
      commandLine: 'string'
      containerSettings: {
        containerRunOptions: 'string'
        imageName: 'string'
        registry: {
          password: 'string'
          registryServer: 'string'
          username: 'string'
        }
      }
      environmentSettings: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      maxTaskRetryCount: int
      resourceFiles: [
        {
          autoStorageContainerName: 'string'
          blobPrefix: 'string'
          fileMode: 'string'
          filePath: 'string'
          httpUrl: 'string'
          storageContainerUrl: 'string'
        }
      ]
      userIdentity: {
        autoUser: {
          elevationLevel: 'string'
          scope: 'string'
        }
        userName: 'string'
      }
      waitForSuccess: bool
    }
    taskSchedulingPolicy: {
      nodeFillType: 'string'
    }
    userAccounts: [
      {
        elevationLevel: 'string'
        linuxUserConfiguration: {
          gid: int
          sshPrivateKey: 'string'
          uid: int
        }
        name: 'string'
        password: 'string'
        windowsUserConfiguration: {
          loginMode: 'string'
        }
      }
    ]
    vmSize: 'string'
  }
}

Property values

batchAccounts/pools

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Batch/batchAccounts/pools'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2019-04-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Pool properties. PoolProperties

PoolProperties

Name Description Value
applicationLicenses 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. string[]
applicationPackages 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. ApplicationPackageReference[]
certificates For Windows compute 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. CertificateReference[]
deploymentConfiguration Deployment configuration properties. DeploymentConfiguration
displayName The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. string
interNodeCommunication 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'. 'Disabled'
'Enabled'
maxTasksPerNode 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. int
metadata The Batch service does not assign any meaning to metadata; it is solely for the use of user code. MetadataItem[]
networkConfiguration The network configuration for a pool. NetworkConfiguration
scaleSettings 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. ScaleSettings
startTask In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. StartTask
taskSchedulingPolicy Specifies how tasks should be distributed across compute nodes. TaskSchedulingPolicy
userAccounts The list of user accounts to be created on each node in the pool. UserAccount[]
vmSize 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. 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). string

ApplicationPackageReference

Name Description Value
id The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. string (required)
version 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. string

CertificateReference

Name Description Value
id The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. string (required)
storeLocation The default value is currentUser. This property is applicable only for pools configured with Windows 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. 'CurrentUser'
'LocalMachine'
storeName This property is applicable only for pools configured with Windows 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. string
visibility Which user accounts on the compute node should have access to the private data of the certificate. String array containing any of:
'RemoteUser'
'StartTask'
'Task'

DeploymentConfiguration

Name Description Value
cloudServiceConfiguration The configuration for nodes in a pool based on the Azure Cloud Services platform. CloudServiceConfiguration
virtualMachineConfiguration The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. VirtualMachineConfiguration

CloudServiceConfiguration

Name Description Value
osFamily 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). string (required)
osVersion The default value is * which specifies the latest operating system version for the specified OS family. string

VirtualMachineConfiguration

Name Description Value
containerConfiguration The configuration for container-enabled pools. ContainerConfiguration
dataDisks This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. DataDisk[]
imageReference A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. ImageReference (required)
licenseType 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.
string
nodeAgentSkuId 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. string (required)
windowsConfiguration Windows operating system settings to apply to the virtual machine. WindowsConfiguration

ContainerConfiguration

Name Description Value
containerImageNames 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. string[]
containerRegistries If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ContainerRegistry[]
type The container technology to be used. 'DockerCompatible'

ContainerRegistry

Name Description Value
password The password to log into the registry server. string (required)
registryServer If omitted, the default is "docker.io". string
username The user name to log into the registry server. string (required)

DataDisk

Name Description Value
diskSizeGB The initial disk size in GB when creating new data disk. int (required)
lun The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. int (required)
storageAccountType The storage account type for use in creating data disks. 'Premium_LRS'
'Standard_LRS'

ImageReference

Name Description Value
id This property is mutually exclusive with other properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For information about the firewall settings for Batch node agent to communicate with Batch service see /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration . string
offer For example, UbuntuServer or WindowsServer. string
publisher For example, Canonical or MicrosoftWindowsServer. string
sku For example, 14.04.0-LTS or 2012-R2-Datacenter. string
version A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. string

WindowsConfiguration

Name Description Value
enableAutomaticUpdates If omitted, the default value is true. bool

MetadataItem

Name Description Value
name The name of the metadata item. string (required)
value The value of the metadata item. string (required)

NetworkConfiguration

Name Description Value
endpointConfiguration The endpoint configuration for a pool. PoolEndpointConfiguration
subnetId 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. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet. 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: /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration string

PoolEndpointConfiguration

Name Description Value
inboundNatPools 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. InboundNatPool[] (required)

InboundNatPool

Name Description Value
backendPort 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. int (required)
frontendPortRangeEnd 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. int (required)
frontendPortRangeStart 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. int (required)
name 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. string (required)
networkSecurityGroupRules 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. NetworkSecurityGroupRule[]
protocol The protocol of the endpoint. 'TCP'
'UDP'

NetworkSecurityGroupRule

Name Description Value
access The action that should be taken for a specified IP address, subnet range or tag. 'Allow'
'Deny'
priority 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 3500. If any reserved or duplicate values are provided the request fails with HTTP status code 400. int (required)
sourceAddressPrefix 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. string (required)

ScaleSettings

Name Description Value
autoScale AutoScale settings for the pool. AutoScaleSettings
fixedScale Fixed scale settings for the pool. FixedScaleSettings

AutoScaleSettings

Name Description Value
evaluationInterval If omitted, the default value is 15 minutes (PT15M). string
formula A formula for the desired number of compute nodes in the pool. string (required)

FixedScaleSettings

Name Description Value
nodeDeallocationOption Determines what to do with a node and its running task(s) after it has been selected for deallocation. 'Requeue'
'RetainedData'
'TaskCompletion'
'Terminate'
resizeTimeout 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). string
targetDedicatedNodes At least one of targetDedicatedNodes, targetLowPriority nodes must be set. int
targetLowPriorityNodes At least one of targetDedicatedNodes, targetLowPriority nodes must be set. int

StartTask

Name Description Value
commandLine 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. string
containerSettings The container settings for a task. TaskContainerSettings
environmentSettings A list of environment variable settings for the start task. EnvironmentSetting[]
maxTaskRetryCount 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. int
resourceFiles A list of files that the Batch service will download to the compute node before running the command line. ResourceFile[]
userIdentity Specify either the userName or autoUser property, but not both. UserIdentity
waitForSuccess 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 false. bool

TaskContainerSettings

Name Description Value
containerRunOptions These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. string
imageName 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. string (required)
registry A private container registry. ContainerRegistry

EnvironmentSetting

Name Description Value
name The name of the environment variable. string (required)
value The value of the environment variable. string

ResourceFile

Name Description Value
autoStorageContainerName The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. string
blobPrefix 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. string
fileMode 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. string
filePath 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 '..'). string
httpUrl The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access. string
storageContainerUrl The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access. string

UserIdentity

Name Description Value
autoUser Specifies the parameters for the auto user that runs a task on the Batch service. AutoUserSpecification
userName The userName and autoUser properties are mutually exclusive; you must specify one but not both. string

AutoUserSpecification

Name Description Value
elevationLevel The elevation level of the user. 'Admin'
'NonAdmin'
scope The default value is task. 'Pool'
'Task'

TaskSchedulingPolicy

Name Description Value
nodeFillType How tasks should be distributed across compute nodes. 'Pack'
'Spread'

UserAccount

Name Description Value
elevationLevel The elevation level of the user. 'Admin'
'NonAdmin'
linuxUserConfiguration Properties used to create a user account on a Linux node. LinuxUserConfiguration
name The name of the user account. string (required)
password The password for the user account. string (required)
windowsUserConfiguration Properties used to create a user account on a Windows node. WindowsUserConfiguration

LinuxUserConfiguration

Name Description Value
gid The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. int
sshPrivateKey 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). string
uid The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. int

WindowsUserConfiguration

Name Description Value
loginMode Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. 'Batch'
'Interactive'