Pool - Create

Creates a new pool inside the specified account.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}?api-version=2021-06-01

URI Parameters

Name In Required Type Description
accountName
path True
  • string

The name of the Batch account.

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

poolName
path True
  • string

The pool name. This must be unique within the account.

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

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

The API version to be used with the HTTP request.

Request Header

Name Required Type Description
If-Match
  • string

The entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied.

If-None-Match
  • string

Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.

Request Body

Name Type Description
identity

The type of identity used for the Batch Pool.
The type of identity used for the Batch Pool.

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

properties.applicationPackages

The list of application packages to be installed on each compute node in the pool.
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.

properties.certificates

The list of certificates to be installed on each compute node in the pool.
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.

properties.deploymentConfiguration

This property describes how the pool nodes will be deployed - using Cloud Services or Virtual Machines.
Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

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

properties.interNodeCommunication

Whether the pool permits direct communication between nodes.
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'.

properties.metadata

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.

properties.mountConfiguration

A list of file systems to mount on each node in the pool.
This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

properties.networkConfiguration

The network configuration for the pool.
The network configuration for a pool.

properties.scaleSettings

Settings which configure the number of nodes in the pool.
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.

properties.startTask

A task specified to run on each compute node as it joins the pool.
In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

properties.taskSchedulingPolicy

How tasks are distributed across compute nodes in a pool.
If not specified, the default is spread.

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

properties.userAccounts

The list of user accounts to be created on each node in the pool.

properties.vmSize
  • string

The size of virtual machines in the pool. All VMs 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. 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).

Responses

Name Type Description
200 OK

The operation was successful. The response contains the pool entity.

Headers

  • ETag: string
Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

CreatePool - Custom Image
CreatePool - Full CloudServiceConfiguration
CreatePool - Full VirtualMachineConfiguration
CreatePool - Minimal CloudServiceConfiguration
CreatePool - Minimal VirtualMachineConfiguration
CreatePool - No public IP
CreatePool - Public IPs
CreatePool - UserAssignedIdentities
CreatePool - VirtualMachineConfiguration Extensions

CreatePool - Custom Image

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Full CloudServiceConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "displayName": "my-pool-name",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Enabled",
    "taskSlotsPerNode": 13,
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack"
    },
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "4",
        "osVersion": "WA-GUEST-OS-4.45_201708-01"
      }
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135",
          "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268"
        ]
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 6,
        "targetLowPriorityNodes": 28,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    },
    "metadata": [
      {
        "name": "metadata-1",
        "value": "value-1"
      },
      {
        "name": "metadata-2",
        "value": "value-2"
      }
    ],
    "startTask": {
      "commandLine": "cmd /c SET",
      "resourceFiles": [
        {
          "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
          "filePath": "c:\\temp\\gohere",
          "fileMode": "777"
        }
      ],
      "environmentSettings": [
        {
          "name": "MYSET",
          "value": "1234"
        }
      ],
      "userIdentity": {
        "autoUser": {
          "scope": "Pool",
          "elevationLevel": "Admin"
        }
      },
      "maxTaskRetryCount": 6,
      "waitForSuccess": true
    },
    "userAccounts": [
      {
        "name": "username1",
        "password": "<ExamplePassword>",
        "elevationLevel": "Admin",
        "linuxUserConfiguration": {
          "sshPrivateKey": "sshprivatekeyvalue",
          "uid": 1234,
          "gid": 4567
        }
      }
    ],
    "applicationPackages": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
        "version": "asdf"
      }
    ],
    "certificates": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        "storeLocation": "LocalMachine",
        "storeName": "MY",
        "visibility": [
          "RemoteUser"
        ]
      }
    ],
    "applicationLicenses": [
      "app-license0",
      "app-license1"
    ]
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Enabled",
    "taskSlotsPerNode": 13,
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack"
    },
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "4",
        "osVersion": "WA-GUEST-OS-4.45_201708-01"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 6,
        "targetLowPriorityNodes": 28,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135",
          "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268"
        ]
      }
    },
    "metadata": [
      {
        "name": "metadata-1",
        "value": "value-1"
      },
      {
        "name": "metadata-2",
        "value": "value-2"
      }
    ],
    "startTask": {
      "commandLine": "cmd /c SET",
      "resourceFiles": [
        {
          "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
          "filePath": "c:\\temp\\gohere",
          "fileMode": "777"
        }
      ],
      "environmentSettings": [
        {
          "name": "MYSET",
          "value": "1234"
        }
      ],
      "userIdentity": {
        "autoUser": {
          "scope": "Pool",
          "elevationLevel": "Admin"
        }
      },
      "maxTaskRetryCount": 6,
      "waitForSuccess": true
    },
    "userAccounts": [
      {
        "name": "username1",
        "elevationLevel": "Admin",
        "linuxUserConfiguration": {
          "uid": 1234,
          "gid": 4567
        }
      }
    ],
    "applicationPackages": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
        "version": "asdf"
      }
    ],
    "certificates": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        "storeLocation": "LocalMachine",
        "storeName": "MY",
        "visibility": [
          "RemoteUser"
        ]
      }
    ],
    "applicationLicenses": [
      "app-license0",
      "app-license1"
    ],
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Full VirtualMachineConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "licenseType": "Windows_Server",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "storageAccountType": "Premium_LRS"
          },
          {
            "lun": 1,
            "caching": "None",
            "diskSizeGB": 200,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "osDisk": {
          "ephemeralOSDiskSettings": {
            "placement": "CacheDisk"
          }
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "protocol": "TCP",
            "backendPort": 12001,
            "frontendPortRangeStart": 15000,
            "frontendPortRangeEnd": 15100,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "192.100.12.45",
                "priority": 150,
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "sourceAddressPrefix": "*",
                "priority": 3500,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "licenseType": "Windows_Server",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "storageAccountType": "Premium_LRS"
          },
          {
            "lun": 1,
            "caching": "None",
            "diskSizeGB": 200,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "protocol": "TCP",
            "backendPort": 12001,
            "frontendPortRangeStart": 15000,
            "frontendPortRangeEnd": 15100,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "192.100.12.45",
                "priority": 150,
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "sourceAddressPrefix": "*",
                "priority": 3500,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Minimal CloudServiceConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "5"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 3
      }
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "5",
        "osVersion": "*"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 3,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "resizeOperationStatus": {
      "startTime": "2017-08-28T10:22:55.9407275Z",
      "targetDedicatedNodes": 3,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M"
    }
  }
}

CreatePool - Minimal VirtualMachineConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - No public IP

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "vmSize": "STANDARD_D4",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Public IPs

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "vmSize": "STANDARD_D4",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - UserAssignedIdentities

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2020-10-01T10:22:55.9407275Z",
    "creationTime": "2020-10-01T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2020-10-01T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2020-10-01T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "principalId1",
        "clientId": "clientId1"
      },
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "principalId": "principalId2",
        "clientId": "clientId2"
      }
    }
  }
}

CreatePool - VirtualMachineConfiguration Extensions

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2021-06-01
{
  "properties": {
    "vmSize": "STANDARD_D4",
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-focal",
          "sku": "20_04-lts"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 20.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "SecurityMonitoringForLinux",
            "publisher": "Microsoft.Azure.Security.Monitoring",
            "typeHandlerVersion": "1.0",
            "autoUpgradeMinorVersion": true,
            "settings": {
              "settingsKey": "settingsValue"
            },
            "protectedSettings": {
              "protectedSettingsKey": "protectedSettingsValue"
            }
          }
        ]
      }
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-focal",
          "sku": "20_04-lts"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 20.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "SecurityMonitoringForLinux",
            "publisher": "Microsoft.Azure.Security.Monitoring",
            "typeHandlerVersion": "1.0",
            "autoUpgradeMinorVersion": true,
            "settings": {
              "settingsKey": "settingsValue"
            }
          }
        ]
      }
    }
  }
}

Definitions

AllocationState

Whether the pool is resizing.

ApplicationPackageReference

Link to an application package inside the batch account

AutoScaleRun

The results and errors from an execution of a pool autoscale formula.

AutoScaleRunError

An error that occurred when autoscaling a pool.

AutoScaleSettings

AutoScale settings for the pool.

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.

BatchPoolIdentity

The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities

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. This must exist inside the same account as the pool.

CertificateStoreLocation

The location of the certificate store on the compute node into which to install the certificate.

CIFSMountConfiguration

Information used to connect to a CIFS file system.

CloudError

An error response from the Batch service.

CloudErrorBody

An error response from the Batch service.

CloudServiceConfiguration

The configuration for nodes in a pool based on the Azure Cloud Services platform.

ComputeNodeDeallocationOption

Determines what to do with a node and its running task(s) after it has been selected for deallocation.

ComputeNodeFillType

How tasks should be distributed across compute nodes.

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

A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

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.

DeploymentConfiguration

Deployment configuration properties.

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.

DiffDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

DiskEncryptionConfiguration

The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image.

ElevationLevel

The elevation level of the user.

EnvironmentSetting

An environment variable to be set on a task process.

FixedScaleSettings

Fixed scale settings for the pool.

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.

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.

InterNodeCommunicationState

Whether the pool permits direct communication between nodes.

IPAddressProvisioningType

The provisioning type for Public IP Addresses for the Batch Pool.

LinuxUserConfiguration

Properties used to create a user account on a Linux node.

LoginMode

Login mode for user

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.

NodePlacementConfiguration

Node placement configuration for batch pools.

NodePlacementPolicyType

The placement policy for allocating nodes in the pool.

OSDisk

Settings for the operating system disk of the virtual machine.

Pool

Contains information about a pool.

PoolEndpointConfiguration

The endpoint configuration for a pool.

PoolIdentityType

The type of identity used for the Batch Pool.

PoolProvisioningState

The current state of the pool.

PublicIPAddressConfiguration

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

ResizeError

An error that occurred when resizing a pool.

ResizeOperationStatus

Details about the current or last completed resize operation.

ResourceFile

A single file or multiple files to be downloaded to a compute node.

ScaleSettings

Scale settings for the pool

StartTask

A task which is run when a compute 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.

TaskContainerSettings

The container settings for a task.

TaskSchedulingPolicy

Specifies how tasks should be distributed across compute nodes.

UserAccount

Properties used to create a user on an Azure Batch node.

UserAssignedIdentities

The list of associated user identities.

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

AllocationState

Whether the pool is resizing.

Name Type Description
Resizing
  • string

The pool is resizing; that is, compute nodes are being added to or removed from the pool.

Steady
  • string

The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes.

Stopping
  • string

The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed.

ApplicationPackageReference

Link to an application package inside the batch account

Name Type Description
id
  • string

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.

version
  • string

The version of the application to deploy. If omitted, the default version is deployed.
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.

AutoScaleRun

The results and errors from an execution of a pool autoscale formula.

Name Type Description
error

Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful.

evaluationTime
  • string

The time at which the autoscale formula was last evaluated.

results
  • string

The final values of all variables used in the evaluation of the autoscale formula.
Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

AutoScaleRunError

An error that occurred when autoscaling a pool.

Name Type Description
code
  • string

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

details

Additional details about the error.

message
  • string

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

AutoScaleSettings

AutoScale settings for the pool.

Name Type Description
evaluationInterval
  • string

The time interval at which to automatically adjust the pool size according to the autoscale formula.
If omitted, the default value is 15 minutes (PT15M).

formula
  • string

A formula for the desired number of compute nodes in the pool.

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

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

scope

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

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

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.

BatchPoolIdentity

The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities

Name Type Description
type

The type of identity used for the Batch Pool.

userAssignedIdentities

The list of user identities associated with the Batch pool.

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. This must exist inside the same account as the pool.

Name Type Description
id
  • string

The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.

storeLocation

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

visibility
  • string[]

Which user accounts on the compute node should have access to the private data of the certificate.

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.

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.

CloudError

An error response from the Batch service.

Name Type Description
error

The body of the error response.

CloudErrorBody

An error response from the Batch service.

Name Type Description
code
  • string

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

details

A list of additional details about the error.

message
  • string

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

target
  • string

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

CloudServiceConfiguration

The configuration for 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.

ComputeNodeDeallocationOption

Determines what to do with a node and its running task(s) after it has been selected for deallocation.

Name Type Description
Requeue
  • string

Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated.

RetainedData
  • string

Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.

TaskCompletion
  • string

Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed.

Terminate
  • string

Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated.

ComputeNodeFillType

How tasks should be distributed across compute nodes.

Name Type Description
Pack
  • string

As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.

Spread
  • string

Tasks should be assigned evenly across all 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

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

The container technology to be used.

ContainerRegistry

A private container registry.

Name Type Description
identityReference

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
DockerCompatible
  • string

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

ContainerWorkingDirectory

A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

Name Type Description
ContainerImageDefault
  • string

Using container image defined working directory. 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

The type of caching to be enabled for the data disks.
Values are:

none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write.

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

diskSizeGB
  • integer

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

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

The storage account type to be used for the data disk.
If omitted, the default is "Standard_LRS". Values are:

Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage.

DeploymentConfiguration

Deployment configuration properties.

Name Type Description
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'.

virtualMachineConfiguration

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

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk for all 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 virtual machine.

Name Type Description
placement

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 which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://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 Virtual Machine Image or Shared Image Gallery Image.

Name Type Description
targets
  • string[]

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

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.

FixedScaleSettings

Fixed scale settings for the pool.

Name Type Description
nodeDeallocationOption

Determines what to do with a node and its running task(s) if the pool size is decreasing.
If omitted, the default value is Requeue.

resizeTimeout
  • string

The timeout for allocation of compute nodes to the pool.
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).

targetDedicatedNodes
  • integer

The desired number of dedicated compute nodes in the pool.
At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

targetLowPriorityNodes
  • integer

The desired number of low-priority compute nodes in the pool.
At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

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.

Name Type Description
id
  • string

The ARM resource identifier of the Shared Image 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}.
This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

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

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

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

The protocol of the endpoint.

InterNodeCommunicationState

Whether the pool permits direct communication between nodes.

Name Type Description
Disabled
  • string

Disable network communication between virtual machines.

Enabled
  • string

Enable network communication between virtual machines.

IPAddressProvisioningType

The provisioning type for Public IP Addresses for the Batch 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 for the Compute Nodes in the Pool.

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

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

Login mode for 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. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended.

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

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

azureFileShareConfiguration

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

cifsMountConfiguration

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

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
endpointConfiguration

The configuration for endpoints on compute nodes in the Batch pool.
Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

publicIPAddressConfiguration

The Public IPAddress configuration for Compute Nodes in the Batch Pool.
This 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 nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. 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

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) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.

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.

NodePlacementConfiguration

Node placement configuration for batch pools.

Name Type Description
policy

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 zones with best effort balancing.

OSDisk

Settings for the operating system disk of the virtual machine.

Name Type Description
ephemeralOSDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

Pool

Contains information about a pool.

Name Type Description
etag
  • string

The ETag of the resource, used for concurrency statements.

id
  • string

The ID of the resource.

identity

The type of identity used for the Batch Pool.
The type of identity used for the Batch Pool.

name
  • string

The name of the resource.

properties.allocationState

Whether the pool is resizing.

properties.allocationStateTransitionTime
  • string

The time at which the pool entered its current allocation state.

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

properties.applicationPackages

The list of application packages to be installed on each compute node in the pool.
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.

properties.autoScaleRun

The results and errors from the last execution of the autoscale formula.
This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

properties.certificates

The list of certificates to be installed on each compute node in the pool.
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.

properties.creationTime
  • string

The creation time of the pool.

properties.currentDedicatedNodes
  • integer

The number of compute nodes currently in the pool.

properties.currentLowPriorityNodes
  • integer

The number of low-priority compute nodes currently in the pool.

properties.deploymentConfiguration

This property describes how the pool nodes will be deployed - using Cloud Services or Virtual Machines.
Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

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

properties.interNodeCommunication

Whether the pool permits direct communication between nodes.
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'.

properties.lastModified
  • string

The last modified time of the pool.
This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.

properties.metadata

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.

properties.mountConfiguration

A list of file systems to mount on each node in the pool.
This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.

properties.networkConfiguration

The network configuration for the pool.
The network configuration for a pool.

properties.provisioningState

The current state of the pool.

properties.provisioningStateTransitionTime
  • string

The time at which the pool entered its current state.

properties.resizeOperationStatus

Contains details about the current or last completed resize operation.
Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

properties.scaleSettings

Settings which configure the number of nodes in the pool.
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.

properties.startTask

A task specified to run on each compute node as it joins the pool.
In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

properties.taskSchedulingPolicy

How tasks are distributed across compute nodes in a pool.
If not specified, the default is spread.

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

properties.userAccounts

The list of user accounts to be created on each node in the pool.

properties.vmSize
  • string

The size of virtual machines in the pool. All VMs 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. 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).

type
  • string

The type of the resource.

PoolEndpointConfiguration

The endpoint configuration for a pool.

Name Type Description
inboundNatPools

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.

PoolIdentityType

The type of identity used for the Batch Pool.

Name Type Description
None
  • string

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

UserAssigned
  • string

Batch pool has user assigned identities with it.

PoolProvisioningState

The current state of the pool.

Name Type Description
Deleting
  • string

The user has requested that the pool be deleted, but the delete operation has not yet completed.

Succeeded
  • string

The pool is available to run tasks subject to the availability of compute nodes.

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

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

ResizeError

An error that occurred when resizing a pool.

Name Type Description
code
  • string

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

details

Additional details about the error.

message
  • string

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

ResizeOperationStatus

Details about the current or last completed resize operation.

Name Type Description
errors

Details of any errors encountered while performing the last resize on the pool.
This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

nodeDeallocationOption

Determines what to do with a node and its running task(s) if the pool size is decreasing.
The default value is requeue.

resizeTimeout
  • string

The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.
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).

startTime
  • string

The time when this resize operation was started.

targetDedicatedNodes
  • integer

The desired number of dedicated compute nodes in the pool.

targetLowPriorityNodes
  • integer

The desired number of low-priority compute nodes in the pool.

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 node. If this property is not specified for a Linux 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, 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

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.

ScaleSettings

Scale settings for the pool

Name Type Description
autoScale

AutoScale settings for the pool.
This property and fixedScale are mutually exclusive and one of the properties must be specified.

fixedScale

Fixed scale settings for the pool.
This property and autoScale are mutually exclusive and one of the properties must be specified.

StartTask

A task which is run when a compute 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 start task.
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.

containerSettings

The settings for the container under which the start task 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.

environmentSettings

A list of environment variable settings for the start task.

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.

resourceFiles

A list of files that the Batch service will download to the compute node before running the command line.

userIdentity

The user identity under which the start task 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 start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.
If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.

StorageAccountType

The storage account type for use in creating data disks.

Name Type Description
Premium_LRS
  • string

The data disk should use premium locally redundant storage.

Standard_LRS
  • string

The data disk should use standard 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

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

workingDirectory

A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

TaskSchedulingPolicy

Specifies how tasks should be distributed across compute nodes.

Name Type Description
nodeFillType

How tasks should be distributed across compute nodes.

UserAccount

Properties used to create a user on an Azure Batch node.

Name Type Description
elevationLevel

The elevation level of the user account.
nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

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.

password
  • string

The password for the user account.

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.

UserAssignedIdentities

The list of associated user identities.

Name Type Description
clientId
  • string

The client id of user assigned identity.

principalId
  • string

The principal id of user assigned identity.

UserIdentity

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

Name Type Description
autoUser

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

The container configuration for the pool.
If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

dataDisks

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.

diskEncryptionConfiguration

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

extensions

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

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 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 node agent to be provisioned on compute nodes in the pool.
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.

nodePlacementConfiguration

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

osDisk

Settings for the operating system disk of the Virtual Machine.
Contains configuration for ephemeral OSDisk settings.

windowsConfiguration

Windows operating system settings on the virtual machine.
This property must not be specified if the imageReference 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.

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

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

Name Type Description
loginMode

Login mode for user
Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.