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=2024-07-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The name of the Batch account. Regex pattern: |
pool
|
path | True |
string |
The pool name. This must be unique within the account. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group that contains the Batch account. |
subscription
|
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. |
|
properties.applicationLicenses |
string[] |
The list of application licenses the Batch service will make available on each compute node in the pool. |
properties.applicationPackages |
The list of application packages to be installed on each compute node in the pool. |
|
properties.certificates |
The list of certificates to be installed on each compute node in the pool. Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
|
properties.deploymentConfiguration |
This property describes the virtual machines that the pool nodes will be deployed on. |
|
properties.displayName |
string |
The display name for the pool. |
properties.interNodeCommunication |
Whether the pool permits direct communication between nodes. |
|
properties.metadata |
A list of name-value pairs associated with the pool as metadata. |
|
properties.mountConfiguration |
A list of file systems to mount on each node in the pool. |
|
properties.networkConfiguration |
The network configuration for the pool. |
|
properties.resourceTags |
object |
The user-specified tags associated with the pool. |
properties.scaleSettings |
Settings which configure the number of nodes in the pool. |
|
properties.startTask |
A task specified to run on each compute node as it joins the pool. |
|
properties.targetNodeCommunicationMode |
The desired node communication mode for the pool. |
|
properties.taskSchedulingPolicy |
How tasks are distributed across compute nodes in a pool. |
|
properties.taskSlotsPerNode |
integer |
The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. |
properties.upgradePolicy |
The upgrade policy for the pool. |
|
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. |
tags |
object |
The tags of the resource. |
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
Microsoft Entra OAuth 2.0 auth code flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
CreatePool - accelerated networking
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01
{
"properties": {
"vmSize": "STANDARD_D1_V2",
"networkConfiguration": {
"subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
"enableAcceleratedNetworking": true
},
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.windows amd64"
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0
}
}
}
}
Sample response
ETag: W/"0x8DB46CB72A227E2"
{
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
"name": "testpool",
"type": "Microsoft.Batch/batchAccounts/pools",
"etag": "W/\"0x8DB46CB72A227E2\"",
"properties": {
"lastModified": "2023-04-27T02:59:41.8592226Z",
"creationTime": "2023-04-27T02:59:41.8592226Z",
"provisioningState": "Succeeded",
"provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z",
"allocationState": "Steady",
"allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z",
"vmSize": "STANDARD_D1_V2",
"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"
}
},
"networkConfiguration": {
"subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
"dynamicVnetAssignmentScope": "none",
"enableAcceleratedNetworking": true
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0,
"resizeTimeout": "PT15M"
}
},
"resizeOperationStatus": {
"targetDedicatedNodes": 1,
"nodeDeallocationOption": "Requeue",
"resizeTimeout": "PT15M",
"startTime": "2023-04-27T02:59:41.8592226Z"
},
"currentDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"currentNodeCommunicationMode": "Classic"
}
}
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=2024-07-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 VirtualMachineConfiguration
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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 VirtualMachineConfiguration
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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=2024-07-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=2024-07-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 - ResourceTags
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01
{
"properties": {
"vmSize": "Standard_d4s_v3",
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "UbuntuServer",
"sku": "18_04-lts-gen2",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.ubuntu 18.04"
}
},
"resourceTags": {
"TagName1": "TagValue1",
"TagName2": "TagValue2"
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0
}
}
}
}
Sample response
ETag: W/"0x8DB554F8E08BCF4"
{
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
"name": "testpool",
"type": "Microsoft.Batch/batchAccounts/pools",
"etag": "W/\"0x8DB554F8E08BCF4\"",
"properties": {
"lastModified": "2023-06-14T07:03:58.3231917Z",
"creationTime": "2023-06-14T07:03:58.3231917Z",
"provisioningState": "Succeeded",
"provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
"allocationState": "Resizing",
"allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
"vmSize": "STANDARD_D4S_V3",
"interNodeCommunication": "Disabled",
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "Spread"
},
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "UbuntuServer",
"sku": "18_04-lts-gen2",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.ubuntu 18.04"
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0,
"resizeTimeout": "PT15M"
}
},
"resizeOperationStatus": {
"targetDedicatedNodes": 1,
"nodeDeallocationOption": "Requeue",
"resizeTimeout": "PT15M",
"startTime": "2023-09-27T07:33:13.0625789Z"
},
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"resourceTags": {
"TagName1": "TagValue1",
"TagName2": "TagValue2"
}
}
}
CreatePool - SecurityProfile
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01
{
"properties": {
"vmSize": "Standard_d4s_v3",
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "UbuntuServer",
"sku": "18_04-lts-gen2",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.ubuntu 18.04",
"securityProfile": {
"securityType": "trustedLaunch",
"encryptionAtHost": true,
"uefiSettings": {
"secureBootEnabled": null,
"vTpmEnabled": false
}
}
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0
}
}
}
}
Sample response
ETag: W/"0x8DB554F8E08BCF4"
{
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
"name": "testpool",
"type": "Microsoft.Batch/batchAccounts/pools",
"etag": "W/\"0x8DB554F8E08BCF4\"",
"properties": {
"lastModified": "2023-06-14T07:03:58.3231917Z",
"creationTime": "2023-06-14T07:03:58.3231917Z",
"provisioningState": "Succeeded",
"provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
"allocationState": "Resizing",
"allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
"vmSize": "STANDARD_D4S_V3",
"interNodeCommunication": "Disabled",
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "Spread"
},
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "UbuntuServer",
"sku": "18_04-lts-gen2",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.ubuntu 18.04",
"securityProfile": {
"securityType": "trustedLaunch",
"encryptionAtHost": true,
"uefiSettings": {
"vTpmEnabled": false
}
}
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0,
"resizeTimeout": "PT15M"
}
},
"resizeOperationStatus": {
"targetDedicatedNodes": 1,
"nodeDeallocationOption": "Requeue",
"resizeTimeout": "PT15M",
"startTime": "2023-06-14T07:03:58.3231917Z"
},
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0
}
}
CreatePool - Tags
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01
{
"tags": {
"TagName1": "TagValue1",
"TagName2": "TagValue2"
},
"properties": {
"vmSize": "Standard_d4s_v3",
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-jammy",
"sku": "22_04-lts",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.ubuntu 22.04"
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0
}
}
}
}
Sample response
ETag: W/"0x8DB554F8E08BCF4"
{
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
"name": "testpool",
"type": "Microsoft.Batch/batchAccounts/pools",
"etag": "W/\"0x8DB554F8E08BCF4\"",
"properties": {
"lastModified": "2023-06-14T07:03:58.3231917Z",
"creationTime": "2023-06-14T07:03:58.3231917Z",
"provisioningState": "Succeeded",
"provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
"allocationState": "Resizing",
"allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
"vmSize": "STANDARD_D4S_V3",
"interNodeCommunication": "Disabled",
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "Spread"
},
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-jammy",
"sku": "22_04-lts",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.ubuntu 22.04"
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0,
"resizeTimeout": "PT15M"
}
},
"resizeOperationStatus": {
"targetDedicatedNodes": 1,
"nodeDeallocationOption": "Requeue",
"resizeTimeout": "PT15M",
"startTime": "2023-09-27T07:33:13.0625789Z"
},
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0
},
"tags": {
"TagName1": "TagValue1",
"TagName2": "TagValue2"
}
}
CreatePool - UpgradePolicy
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01
{
"properties": {
"vmSize": "Standard_d4s_v3",
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2019-datacenter-smalldisk",
"version": "latest"
},
"nodePlacementConfiguration": {
"policy": "Zonal"
},
"nodeAgentSkuId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
}
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 2,
"targetLowPriorityNodes": 0
}
},
"upgradePolicy": {
"mode": "automatic",
"automaticOSUpgradePolicy": {
"disableAutomaticRollback": true,
"enableAutomaticOSUpgrade": true,
"useRollingUpgradePolicy": true,
"osRollingUpgradeDeferral": true
},
"rollingUpgradePolicy": {
"enableCrossZoneUpgrade": true,
"maxBatchInstancePercent": 20,
"maxUnhealthyInstancePercent": 20,
"maxUnhealthyUpgradedInstancePercent": 20,
"pauseTimeBetweenBatches": "PT0S",
"prioritizeUnhealthyInstances": false,
"rollbackFailedInstancesOnPolicyBreach": false
}
}
}
}
Sample response
ETag: W/"0x8DB51E64D3C3B69"
{
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
"name": "testpool",
"type": "Microsoft.Batch/batchAccounts/pools",
"etag": "W/\"0x8DB51E64D3C3B69\"",
"properties": {
"lastModified": "2023-05-11T06:16:44.2372184Z",
"creationTime": "2023-05-11T06:16:44.2372184Z",
"provisioningState": "Succeeded",
"provisioningStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
"allocationState": "Resizing",
"allocationStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
"vmSize": "STANDARD_D4S_V3",
"interNodeCommunication": "Disabled",
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "Spread"
},
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2019-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
},
"nodePlacementConfiguration": {
"policy": "Zonal"
}
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 2,
"targetLowPriorityNodes": 0,
"resizeTimeout": "PT15M"
}
},
"resizeOperationStatus": {
"targetDedicatedNodes": 2,
"nodeDeallocationOption": "Requeue",
"resizeTimeout": "PT15M",
"startTime": "2023-05-11T06:16:44.2372184Z"
},
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"upgradePolicy": {
"mode": "automatic",
"automaticOSUpgradePolicy": {
"disableAutomaticRollback": true,
"enableAutomaticOSUpgrade": true,
"useRollingUpgradePolicy": true,
"osRollingUpgradeDeferral": true
},
"rollingUpgradePolicy": {
"enableCrossZoneUpgrade": true,
"maxBatchInstancePercent": 20,
"maxUnhealthyInstancePercent": 20,
"maxUnhealthyUpgradedInstancePercent": 20,
"pauseTimeBetweenBatches": "PT0S",
"prioritizeUnhealthyInstances": false,
"rollbackFailedInstancesOnPolicyBreach": false
}
}
}
}
CreatePool - UserAssignedIdentities
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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=2024-07-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": "KeyVaultForLinux",
"publisher": "Microsoft.Azure.KeyVault",
"typeHandlerVersion": "2.0",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": {
"secretsManagementSettingsKey": "secretsManagementSettingsValue",
"authenticationSettingsKey": "authenticationSettingsValue"
}
}
]
}
},
"targetNodeCommunicationMode": "Default"
}
}
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": "KeyVaultForLinux",
"publisher": "Microsoft.Azure.KeyVault",
"typeHandlerVersion": "2.0",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": {
"secretsManagementSettingsKey": "secretsManagementSettingsValue",
"authenticationSettingsKey": "authenticationSettingsValue"
}
}
]
}
},
"targetNodeCommunicationMode": "Default"
}
}
CreatePool - VirtualMachineConfiguration OSDisk
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01
{
"properties": {
"vmSize": "Standard_d2s_v3",
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "microsoftwindowsserver",
"offer": "windowsserver",
"sku": "2022-datacenter-smalldisk"
},
"osDisk": {
"diskSizeGB": 100,
"managedDisk": {
"storageAccountType": "StandardSSD_LRS"
},
"caching": "ReadWrite",
"writeAcceleratorEnabled": false
},
"nodeAgentSkuId": "batch.node.windows amd64"
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0
}
}
}
}
Sample response
ETag: W/"0x8DB51F14DC1A8AD"
{
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
"name": "testpool",
"type": "Microsoft.Batch/batchAccounts/pools",
"etag": "W/\"0x8DB51F396992B8D\"",
"properties": {
"lastModified": "2023-08-24T02:12:27.7527697Z",
"creationTime": "2023-08-24T02:12:27.7527697Z",
"provisioningState": "Succeeded",
"provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
"allocationState": "Resizing",
"allocationStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
"vmSize": "STANDARD_D2_V3",
"interNodeCommunication": "Disabled",
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "Spread"
},
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "microsoftwindowsserver",
"offer": "windowsserver",
"sku": "2022-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.windows amd64",
"osDisk": {
"caching": "ReadWrite",
"managedDisk": {
"storageAccountType": "StandardSSD_LRS"
},
"diskSizeGB": 100,
"writeAcceleratorEnabled": false
}
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0,
"resizeTimeout": "PT15M"
}
},
"resizeOperationStatus": {
"targetDedicatedNodes": 1,
"nodeDeallocationOption": "Requeue",
"resizeTimeout": "PT15M",
"startTime": "2023-08-24T02:12:27.7527697Z"
},
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0
}
}
CreatePool - VirtualMachineConfiguration ServiceArtifactReference
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01
{
"properties": {
"vmSize": "Standard_d4s_v3",
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2019-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
},
"serviceArtifactReference": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
}
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 2,
"targetLowPriorityNodes": 0
}
},
"upgradePolicy": {
"mode": "automatic",
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true
}
}
}
}
Sample response
ETag: W/"0x8DB51F14DC1A8AD"
{
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
"name": "mypool41",
"type": "Microsoft.Batch/batchAccounts/pools",
"etag": "W/\"0x8DB51F396992B8D\"",
"properties": {
"lastModified": "2023-05-11T07:44:44.8580493Z",
"creationTime": "2023-05-11T07:44:44.8580493Z",
"provisioningState": "Succeeded",
"provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
"allocationState": "Resizing",
"allocationStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
"vmSize": "STANDARD_D4S_V3",
"interNodeCommunication": "Disabled",
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "Spread"
},
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2019-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSkuId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
},
"serviceArtifactReference": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
}
}
},
"scaleSettings": {
"fixedScale": {
"targetDedicatedNodes": 2,
"targetLowPriorityNodes": 0,
"resizeTimeout": "PT15M"
}
},
"resizeOperationStatus": {
"targetDedicatedNodes": 2,
"nodeDeallocationOption": "Requeue",
"resizeTimeout": "PT15M",
"startTime": "2023-05-11T07:44:44.8580493Z"
},
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"upgradePolicy": {
"mode": "automatic",
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true
}
}
}
}
Definitions
Name | Description |
---|---|
Allocation |
Whether the pool is resizing. |
Application |
Link to an application package inside the batch account |
Automatic |
The configuration parameters used for performing automatic OS upgrade. |
Auto |
The results and errors from an execution of a pool autoscale formula. |
Auto |
An error that occurred when autoscaling a pool. |
Auto |
AutoScale settings for the pool. |
Auto |
The scope for the auto user |
Auto |
Specifies the parameters for the auto user that runs a task on the Batch service. |
Azure |
Information used to connect to an Azure Storage Container using Blobfuse. |
Azure |
Information used to connect to an Azure Fileshare. |
Batch |
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 |
Caching |
The type of caching to enable for the disk. |
Certificate |
A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool. |
Certificate |
The location of the certificate store on the compute node into which to install the certificate. |
Certificate |
Which user accounts on the compute node should have access to the private data of the certificate. |
CIFSMount |
Information used to connect to a CIFS file system. |
Cloud |
An error response from the Batch service. |
Cloud |
An error response from the Batch service. |
Compute |
Determines what to do with a node and its running task(s) after it has been selected for deallocation. |
Compute |
How tasks should be distributed across compute nodes. |
Compute |
The reference to a user assigned identity associated with the Batch pool which a compute node will use. |
Container |
The configuration for container-enabled pools. |
Container |
The entry of path and mount mode you want to mount into task container. |
Container |
The paths which will be mounted to container task's container. |
Container |
A private container registry. |
Container |
The container technology to be used. |
Container |
A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. |
Data |
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. |
Deployment |
Deployment configuration properties. |
Diff |
Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. |
Diff |
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. |
Disk |
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 Azure Compute Gallery Image. |
Disk |
The list of disk targets Batch Service will encrypt on the compute node |
Dynamic |
The scope of dynamic vnet assignment. |
Elevation |
The elevation level of the user. |
Environment |
An environment variable to be set on a task process. |
Fixed |
Fixed scale settings for the pool. |
Image |
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. |
Inbound |
The protocol of the endpoint. |
Inbound |
A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally. |
Inter |
Whether the pool permits direct communication between nodes. |
IPAddress |
The provisioning type for Public IP Addresses for the Batch Pool. |
Linux |
Properties used to create a user account on a Linux node. |
Login |
Login mode for user |
Managed |
|
Metadata |
A name-value pair associated with a Batch service resource. |
Mount |
The file system to mount on each node. |
Network |
The network configuration for a pool. |
Network |
A network security group rule to apply to an inbound endpoint. |
Network |
The action that should be taken for a specified IP address, subnet range or tag. |
NFSMount |
Information used to connect to an NFS file system. |
Node |
Determines how a pool communicates with the Batch service. |
Node |
Node placement configuration for batch pools. |
Node |
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. |
Pool |
The endpoint configuration for a pool. |
Pool |
The type of identity used for the Batch Pool. |
Pool |
The current state of the pool. |
Public |
The public IP Address configuration of the networking configuration of a Pool. |
Resize |
An error that occurred when resizing a pool. |
Resize |
Details about the current or last completed resize operation. |
Resource |
A single file or multiple files to be downloaded to a compute node. |
Rolling |
The configuration parameters used while performing a rolling upgrade. |
Scale |
Scale settings for the pool |
Security |
Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs. |
Security |
Specifies the security profile settings for the virtual machine or virtual machine scale set. |
Security |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. |
Service |
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. |
Start |
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. |
Storage |
The storage account type for use in creating data disks or OS disk. |
Task |
The container settings for a task. |
Task |
Specifies how tasks should be distributed across compute nodes. |
Uefi |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
Upgrade |
Specifies the mode of an upgrade to virtual machines in the scale set. |
Upgrade |
Describes an upgrade policy - automatic, manual, or rolling. |
User |
Properties used to create a user on an Azure Batch node. |
User |
The list of associated user identities. |
User |
The definition of the user identity under which the task is run. |
Virtual |
The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. |
VMDisk |
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs. |
VMExtension |
The configuration for virtual machine extensions. |
Windows |
Windows operating system settings to apply to the virtual machine. |
Windows |
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. |
AutomaticOSUpgradePolicy
The configuration parameters used for performing automatic OS upgrade.
Name | Type | Description |
---|---|---|
disableAutomaticRollback |
boolean |
Whether OS image rollback feature should be disabled. |
enableAutomaticOSUpgrade |
boolean |
Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. |
osRollingUpgradeDeferral |
boolean |
Defer OS upgrades on the TVMs if they are running tasks. |
useRollingUpgradePolicy |
boolean |
Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. |
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. |
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. |
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. |
|
scope |
The scope for the auto user |
AzureBlobFileSystemConfiguration
Information used to connect to an Azure Storage Container using Blobfuse.
Name | Type | Description |
---|---|---|
accountKey |
string |
The Azure Storage Account key. |
accountName |
string |
The Azure Storage Account name. |
blobfuseOptions |
string |
Additional command line options to pass to the mount command. |
containerName |
string |
The Azure Blob Storage Container name. |
identityReference |
The reference to the user assigned identity to use to access containerName |
|
relativeMountPath |
string |
The relative path on the compute node where the file system will be mounted |
sasKey |
string |
The Azure Storage SAS token. |
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. |
mountOptions |
string |
Additional command line options to pass to the mount command. |
relativeMountPath |
string |
The relative path on the compute node where the file system will be mounted |
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 |
<string,
User |
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. |
|
storeName |
string |
The name of the certificate store on the compute node into which to install the certificate. |
visibility |
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. |
CertificateVisibility
Which user accounts on the compute node should have access to the private data of the certificate.
Name | Type | Description |
---|---|---|
RemoteUser |
string |
The certificate should be visible to the user accounts under which users remotely access the node. |
StartTask |
string |
The certificate should be visible to the user account under which the start task is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well. |
Task |
string |
The certificate should be visible to the user accounts under which job tasks are run. |
CIFSMountConfiguration
Information used to connect to a CIFS file system.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Additional command line options to pass to the mount command. |
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 |
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. |
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. |
containerRegistries |
Additional private registries from which containers can be pulled. |
|
type |
The container technology to be used. |
ContainerHostBatchBindMountEntry
The entry of path and mount mode you want to mount into task container.
Name | Type | Description |
---|---|---|
isReadOnly |
boolean |
Mount this source path as read-only mode or not. Default value is false (read/write mode). |
source |
The path which be mounted to container customer can select. |
ContainerHostDataPath
The paths which will be mounted to container task's container.
Name | Type | Description |
---|---|---|
Applications |
string |
The applications path. |
JobPrep |
string |
The job-prep task path. |
Shared |
string |
The path for multi-instances task to shared their files. |
Startup |
string |
The path for start task. |
Task |
string |
The task path. |
VfsMounts |
string |
The path contains all virtual file systems are mounted on this node. |
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. |
|
password |
string |
The password to log into the registry server. |
registryServer |
string |
The registry URL. |
username |
string |
The user name to log into the registry server. |
ContainerType
The container technology to be used.
Name | Type | Description |
---|---|---|
CriCompatible |
string |
A CRI based technology will be used to launch the containers. |
DockerCompatible |
string |
A Docker compatible container technology will be used to launch the containers. |
ContainerWorkingDirectory
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. 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. |
storageAccountType |
The storage account type to be used for the data disk. 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 |
---|---|---|
virtualMachineConfiguration |
The virtual machine configuration for the pool. |
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. |
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 Azure Compute Gallery Image.
Name | Type | Description |
---|---|---|
targets |
The list of disk targets Batch Service will encrypt on the compute node |
DiskEncryptionTarget
The list of disk targets Batch Service will encrypt on the compute node
Name | Type | Description |
---|---|---|
OsDisk |
string |
The OS Disk on the compute node is encrypted. |
TemporaryDisk |
string |
The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time. |
DynamicVNetAssignmentScope
The scope of dynamic vnet assignment.
Name | Type | Description |
---|---|---|
job |
string |
Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support |
none |
string |
No dynamic VNet assignment is enabled. |
ElevationLevel
The elevation level of the user.
Name | Type | Description |
---|---|---|
Admin |
string |
The user is a user with elevated access and operates with full Administrator permissions. |
NonAdmin |
string |
The user is a standard user without elevated access. |
EnvironmentSetting
An environment variable to be set on a task process.
Name | Type | Description |
---|---|---|
name |
string |
The name of the environment variable. |
value |
string |
The value of the environment variable. |
FixedScaleSettings
Fixed scale settings for the pool.
Name | Type | Default value | Description |
---|---|---|---|
nodeDeallocationOption |
Determines what to do with a node and its running task(s) if the pool size is decreasing. |
||
resizeTimeout |
string |
PT15M |
The timeout for allocation of compute nodes to the pool. |
targetDedicatedNodes |
integer |
The desired number of dedicated compute nodes in the pool. |
|
targetLowPriorityNodes |
integer |
The desired number of Spot/low-priority compute nodes in 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.
Name | Type | Description |
---|---|---|
communityGalleryImageId |
string |
The community gallery image unique identifier |
id |
string |
The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}. |
offer |
string |
The offer type of the Azure Virtual Machines Marketplace image. |
publisher |
string |
The publisher of the Azure Virtual Machines Marketplace image. |
sharedGalleryImageId |
string |
The shared gallery image unique identifier |
sku |
string |
The SKU of the Azure Virtual Machines Marketplace image. |
version |
string |
The version of the Azure Virtual Machines Marketplace image. |
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. |
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. |
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. |
name |
string |
The name of the endpoint. |
networkSecurityGroupRules |
A list of network security group rules that will be applied to the endpoint. |
|
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. |
sshPrivateKey |
string |
The SSH private key for the user account. |
uid |
integer |
The user ID of the user account. |
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. |
ManagedDisk
Name | Type | Description |
---|---|---|
securityProfile |
Specifies the security profile for the managed disk. |
|
storageAccountType |
The storage account type for managed disk. |
MetadataItem
A name-value pair associated with a Batch service resource.
Name | Type | Description |
---|---|---|
name |
string |
The name of the metadata item. |
value |
string |
The value of the metadata item. |
MountConfiguration
The file system to mount on each node.
Name | Type | Description |
---|---|---|
azureBlobFileSystemConfiguration |
The Azure Storage Container to mount using blob FUSE on each node. |
|
azureFileShareConfiguration |
The Azure File Share to mount on each node. |
|
cifsMountConfiguration |
The CIFS/SMB file system to mount on each node. |
|
nfsMountConfiguration |
The NFS file system to mount on each node. |
NetworkConfiguration
The network configuration for a pool.
Name | Type | Default value | Description |
---|---|---|---|
dynamicVnetAssignmentScope | none |
The scope of dynamic vnet assignment. |
|
enableAcceleratedNetworking |
boolean |
Whether this pool should enable accelerated networking. |
|
endpointConfiguration |
The configuration for endpoints on compute nodes in the Batch pool. |
||
publicIPAddressConfiguration |
The Public IPAddress configuration for Compute Nodes in the Batch Pool. |
||
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}. |
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. |
sourceAddressPrefix |
string |
The source address prefix or tag to match for the rule. |
sourcePortRanges |
string[] |
The source port ranges to match for the rule. |
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. |
relativeMountPath |
string |
The relative path on the compute node where the file system will be mounted |
source |
string |
The URI of the file system to mount. |
NodeCommunicationMode
Determines how a pool communicates with the Batch service.
Name | Type | Description |
---|---|---|
Classic |
string |
Nodes using the Classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. |
Default |
string |
The node communication mode is automatically set by the Batch service. |
Simplified |
string |
Nodes using the Simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. |
NodePlacementConfiguration
Node placement configuration for batch pools.
Name | Type | Description |
---|---|---|
policy |
Node placement Policy type on Batch Pools. |
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 |
---|---|---|
caching |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. |
|
diskSizeGB |
integer |
The initial disk size in GB when creating new OS disk. |
ephemeralOSDiskSettings |
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. |
|
managedDisk |
The managed disk parameters. |
|
writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
Pool
Contains information about a pool.
Name | Type | Default value | 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. |
||
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. |
|
properties.applicationPackages |
The list of application packages to be installed on each compute node in the pool. |
||
properties.autoScaleRun |
The results and errors from the last execution of the autoscale formula. |
||
properties.certificates |
The list of certificates to be installed on each compute node in the pool. Warning: This property is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. |
||
properties.creationTime |
string |
The creation time of the pool. |
|
properties.currentDedicatedNodes |
integer |
The number of dedicated compute nodes currently in the pool. |
|
properties.currentLowPriorityNodes |
integer |
The number of Spot/low-priority compute nodes currently in the pool. |
|
properties.currentNodeCommunicationMode |
The current state of the pool communication mode. |
||
properties.deploymentConfiguration |
This property describes the virtual machines that the pool nodes will be deployed on. |
||
properties.displayName |
string |
The display name for the pool. |
|
properties.interNodeCommunication |
Whether the pool permits direct communication between nodes. |
||
properties.lastModified |
string |
The last modified time of the pool. |
|
properties.metadata |
A list of name-value pairs associated with the pool as metadata. |
||
properties.mountConfiguration |
A list of file systems to mount on each node in the pool. |
||
properties.networkConfiguration |
The network configuration for the 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. |
||
properties.resourceTags |
object |
The user-specified tags associated with the pool. |
|
properties.scaleSettings |
Settings which configure the number of nodes in the pool. |
||
properties.startTask |
A task specified to run on each compute node as it joins the pool. |
||
properties.targetNodeCommunicationMode |
The desired node communication mode for the pool. |
||
properties.taskSchedulingPolicy |
How tasks are distributed across compute nodes in a pool. |
||
properties.taskSlotsPerNode |
integer |
1 |
The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. |
properties.upgradePolicy |
The upgrade policy for the pool. |
||
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. |
|
tags |
object |
The tags of the resource. |
|
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. |
PoolIdentityType
The type of identity used for the Batch Pool.
Name | Type | Description |
---|---|---|
None |
string |
Batch pool has no identity associated with it. Setting |
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. |
provision |
The provisioning type for Public IP Addresses for the pool |
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. |
|
nodeDeallocationOption |
Determines what to do with a node and its running task(s) if the pool size is decreasing. |
|
resizeTimeout |
string |
The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. |
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 Spot/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. |
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. |
fileMode |
string |
The file permission mode attribute in octal format. |
filePath |
string |
The location on the compute node to which to download the file, relative to the task's working directory. |
httpUrl |
string |
The URL of the file to download. |
identityReference |
The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl |
|
storageContainerUrl |
string |
The URL of the blob container within Azure Blob Storage. |
RollingUpgradePolicy
The configuration parameters used while performing a rolling upgrade.
Name | Type | Description |
---|---|---|
enableCrossZoneUpgrade |
boolean |
Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. |
maxBatchInstancePercent |
integer |
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. |
maxUnhealthyInstancePercent |
integer |
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. |
maxUnhealthyUpgradedInstancePercent |
integer |
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. |
pauseTimeBetweenBatches |
string |
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. |
prioritizeUnhealthyInstances |
boolean |
Upgrade all unhealthy instances in a scale set before any healthy instances. |
rollbackFailedInstancesOnPolicyBreach |
boolean |
Rollback failed instances to previous model if the Rolling Upgrade policy is violated. |
ScaleSettings
Scale settings for the pool
Name | Type | Description |
---|---|---|
autoScale |
AutoScale settings for the pool. |
|
fixedScale |
Fixed scale settings for the pool. |
SecurityEncryptionTypes
Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs.
Name | Type | Description |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
Specifies the security profile settings for the virtual machine or virtual machine scale set.
Name | Type | Description |
---|---|---|
encryptionAtHost |
boolean |
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. |
securityType |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. |
|
uefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
SecurityTypes
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
Name | Type | Description |
---|---|---|
confidentialVM |
string |
Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. |
trustedLaunch |
string |
Trusted launch protects against advanced and persistent attack techniques. |
ServiceArtifactReference
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.
Name | Type | Description |
---|---|---|
id |
string |
The service artifact reference id of ServiceArtifactReference |
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 | Default value | Description |
---|---|---|---|
commandLine |
string |
The command line of the start task. |
|
containerSettings |
The settings for the container under which the start task runs. |
||
environmentSettings |
A list of environment variable settings for the start task. |
||
maxTaskRetryCount |
integer |
0 |
The maximum number of times the task may be retried. |
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. |
||
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. |
StorageAccountType
The storage account type for use in creating data disks or OS disk.
Name | Type | Description |
---|---|---|
Premium_LRS |
string |
The data disk / OS disk should use premium locally redundant storage. |
StandardSSD_LRS |
string |
The data disk / OS disk should use standard SSD locally redundant storage. |
Standard_LRS |
string |
The data disk / OS disk should use standard locally redundant storage. |
TaskContainerSettings
The container settings for a task.
Name | Type | Description |
---|---|---|
containerHostBatchBindMounts |
The paths you want to mounted to container task. |
|
containerRunOptions |
string |
Additional options to the container create command. |
imageName |
string |
The image to use to create the container in which the task will run. |
registry |
The private registry which contains the container image. |
|
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 | Default value | Description |
---|---|---|---|
nodeFillType | Spread |
How tasks should be distributed across compute nodes. |
UefiSettings
Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
Name | Type | Description |
---|---|---|
secureBootEnabled |
boolean |
Specifies whether secure boot should be enabled on the virtual machine. |
vTpmEnabled |
boolean |
Specifies whether vTPM should be enabled on the virtual machine. |
UpgradeMode
Specifies the mode of an upgrade to virtual machines in the scale set.
Possible values are:
Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.
Automatic - All virtual machines in the scale set are automatically updated at the same time.
Rolling - Scale set performs updates in batches with an optional pause time in between.
Name | Type | Description |
---|---|---|
automatic |
string |
All virtual machines in the scale set are automatically updated at the same time. |
manual |
string |
You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. |
rolling |
string |
The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. |
UpgradePolicy
Describes an upgrade policy - automatic, manual, or rolling.
Name | Type | Description |
---|---|---|
automaticOSUpgradePolicy |
Configuration parameters used for performing automatic OS Upgrade. |
|
mode |
Specifies the mode of an upgrade to virtual machines in the scale set. |
|
rollingUpgradePolicy |
The configuration parameters used while performing a rolling upgrade. |
UserAccount
Properties used to create a user on an Azure Batch node.
Name | Type | Description |
---|---|---|
elevationLevel |
The elevation level of the user account. |
|
linuxUserConfiguration |
The Linux-specific user configuration for the user account. |
|
name |
string |
The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. |
password |
string |
The password for the user account. |
windowsUserConfiguration |
The Windows-specific user configuration for the user account. |
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. |
|
userName |
string |
The name 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.
Name | Type | Description |
---|---|---|
containerConfiguration |
The container configuration for the pool. |
|
dataDisks |
Data |
The configuration for data disks attached to the compute nodes in the pool. |
diskEncryptionConfiguration |
The disk encryption configuration for the pool. |
|
extensions |
The virtual machine extension for the pool. |
|
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. 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. |
nodePlacementConfiguration |
The node placement configuration for the pool. |
|
osDisk |
Settings for the operating system disk of the Virtual Machine. |
|
securityProfile |
Specifies the security profile settings for the virtual machine or virtual machine scale set. |
|
serviceArtifactReference |
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. |
|
windowsConfiguration |
Windows operating system settings on the virtual machine. |
VMDiskSecurityProfile
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.
Name | Type | Description |
---|---|---|
securityEncryptionType |
Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs. |
VMExtension
The configuration for virtual machine extensions.
Name | Type | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
enableAutomaticUpgrade |
boolean |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
name |
string |
The name of the virtual machine extension. |
protectedSettings |
object |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
provisionAfterExtensions |
string[] |
The collection of extension names. |
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. |
WindowsUserConfiguration
Properties used to create a user account on a Windows node.
Name | Type | Description |
---|---|---|
loginMode |
Login mode for user |