Pool - Get

CloudPool

A response containing the Pool.

Headers

• client-request-id: string
• request-id: string
• ETag: string
• Last-Modified: string

BatchError

The error from the Batch service.

string

The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool.

string

The Pool is not resizing. There are no changes to the number of Compute 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 Compute Nodes.

string

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

string

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

string

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

boolean

Whether OS image rollback feature should be disabled.

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.

If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.

boolean

Defer OS upgrades on the TVMs if they are running tasks.

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.

AutoScaleRunError

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

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.

string

The time at which the autoscale formula was last evaluated.

string

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

string

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

NameValuePair[]

A list of additional error details related to the autoscale error.

string

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

string

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

ElevationLevel

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

AutoUserScope

The scope for the auto user
The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks.

string

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

string

The Azure Storage Account name.

string

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

string

The Azure Blob Storage Container name.

ComputeNodeIdentityReference

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

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.

string

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

string

The Azure Storage account key.

string

The Azure Storage account name.

string

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

string

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

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.

string

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

ErrorMessage

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

BatchErrorDetail[]

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

string

An identifier specifying the meaning of the Value property.

string

The additional information included with the error response.

PoolIdentityType

The identity of the Batch pool, if configured.
The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

UserAssignedIdentity[]

The list of user identities associated with the Batch account.
The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

string

The caching mode for the disk is not enabled.

string

The caching mode for the disk is read only.

string

The caching mode for the disk is read and write.

CertificateStoreLocation

The location of the Certificate store on the Compute Node into which to install the Certificate.
The default value is currentuser. This property is applicable only for Pools configured with Windows Compute Nodes. 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.

string

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

string

The thumbprint of the Certificate.

string

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

CertificateVisibility[]

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

string

Certificates should be installed to the CurrentUser Certificate store.

string

Certificates should be installed to the LocalMachine Certificate store.

string

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

string

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

string

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

string

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

string

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

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.

string

The URI of the file system to mount.

string

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

AllocationState

Whether the Pool is resizing.

string

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

ApplicationPackageReference[]

The list of Packages to be installed on each Compute Node in the Pool.
Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool.

string

The time interval at which to automatically adjust the Pool size according to the autoscale formula.
This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

string

A formula for the desired number of Compute Nodes in the Pool.
This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.

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. enableAutoScale is true.

CertificateReference[]

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

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

string

The creation time of the Pool.

integer

The number of dedicated Compute Nodes currently in the Pool.

integer

The number of Spot/Low-priority Compute Nodes currently in the Pool.
Spot/Low-priority Compute Nodes which have been preempted are included in this count.

NodeCommunicationMode

The current state of the pool communication mode.

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.

string

The ETag of the Pool.
This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime.

boolean

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

boolean

Whether the Pool permits direct communication between Compute Nodes.
This imposes restrictions on which Compute Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute Nodes to be allocated in the Pool.

string

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

BatchPoolIdentity

The identity of the Batch pool, if configured.
The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

string

The last modified time of the Pool.
This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state.

MetadataItem[]

A list of name-value pairs associated with the Pool as metadata.

MountConfiguration[]

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

NetworkConfiguration

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

ResizeError[]

A list of errors encountered while performing the last resize on the Pool.
This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady.

string

The timeout for allocation of Compute Nodes to the Pool.
This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes.

object

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

StartTask

A Task specified to run on each Compute Node as it joins the Pool.
Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask.

PoolState

The current state of the Pool.

string

The time at which the Pool entered its current state.

PoolStatistics

Utilization and resource usage statistics for the entire lifetime of the Pool.
This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

integer

The desired number of dedicated Compute Nodes in the Pool.

integer

The desired number of Spot/Low-priority Compute Nodes in the Pool.

NodeCommunicationMode

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

TaskSchedulingPolicy

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

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.

UpgradePolicy

The upgrade policy for the Pool.
Describes an upgrade policy - automatic, manual, or rolling.

string

The URL of the Pool.

UserAccount[]

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

VirtualMachineConfiguration

The virtual machine configuration for the Pool.
This property must be specified.

string

The size of virtual machines in the Pool. All virtual machines in a Pool are the same size.
For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

string

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

string

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

string

The ARM resource id of the user assigned identity.

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.

ContainerRegistry[]

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

ContainerType

The container technology to be used.

boolean

Mount this source path as read-only mode or not. Default value is false (read/write mode).
For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path.

ContainerHostDataPath

The path which be mounted to container customer can select.

string

The applications path.

string

The job-prep task path.

string

The path for multi-instances task to shared their files.

string

The path for start task.

string

The task path.

string

The path contains all virtual file systems are mounted on this node.

ComputeNodeIdentityReference

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

string

The password to log into the registry server.

string

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

string

The user name to log into the registry server.

string

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

string

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

string

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

string

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

CachingType

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

integer

The initial disk size in gigabytes.

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

string

The Ephemeral OS Disk is stored on the VM cache.

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.
This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionTarget[]

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

string

The OS Disk on the compute node is encrypted.

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.

string

Dynamic VNet assignment is done per-job.

string

No dynamic VNet assignment is enabled.

string

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

string

The user is a standard user without elevated access.

string

The name of the environment variable.

string

The value of the environment variable.

string

The language code of the error message

string

The text of the message.

string

The community gallery image unique identifier
This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.

string

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

string

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

string

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

string

The shared gallery image unique identifier
This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.

string

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

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

string

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

string

Use TCP for the endpoint.

string

Use UDP for the endpoint.

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.

integer

The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes.
Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

integer

The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes.
Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

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.

NetworkSecurityGroupRule[]

A list of network security group rules that will be applied to the endpoint.
The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

InboundEndpointProtocol

The protocol of the endpoint.

string

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

string

No public IP Address will be created.

string

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

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.

string

The SSH private key for the user Account.
The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done).

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.

string

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

string

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

VMDiskSecurityProfile

Specifies the security profile settings for the managed disk.
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and required when using Confidential VMs.

StorageAccountType

The storage account type for managed disk.

string

The name of the metadata item.

string

The value of the metadata item.

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.

string

The name in the name-value pair.

string

The value in the name-value pair.

DynamicVNetAssignmentScope

The scope of dynamic vnet assignment.

boolean

Whether this pool should enable accelerated networking.
Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

PoolEndpointConfiguration

The configuration for endpoints on Compute Nodes in the Batch Pool.

PublicIPAddressConfiguration

The Public IPAddress configuration for Compute Nodes in the Batch Pool.
The public IP Address configuration of the networking configuration of a Pool.

string

The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. Enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRuleAccess

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

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.

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.

string[]

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

string

Allow access.

string

Deny access.

string

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

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.

string

The URI of the file system to mount.

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.

string

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

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.

NodePlacementPolicyType

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

string

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

string

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

CachingType

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

integer

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

DiffDiskSettings

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

ManagedDisk

The managed disk parameters.

boolean

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

InboundNATPool[]

A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally.
The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.

string

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

string

Batch pool has user assigned identities with it.

string

The Pool is available to run Tasks subject to the availability of Compute Nodes.

string

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

string

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

ResourceStatistics

Statistics related to resource consumption by Compute Nodes in the Pool.

string

The start time of the time range covered by the statistics.

string

The URL for the statistics.

UsageStatistics

Statistics related to Pool usage, such as the amount of core-time used.

string[]

The list of public IPs which the Batch service will use when provisioning Compute Nodes.
The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

IPAddressProvisioningType

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

string

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

string

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

NameValuePair[]

A list of additional error details related to the Pool resize error.

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.

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.

string

The file permission mode attribute in octal format.
This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file.

string

The location on the Compute Node to which to download the file(s), relative to the Task's working directory.
If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..').

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.

ComputeNodeIdentityReference

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

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.

number

The average CPU usage across all Compute Nodes in the Pool (percentage per node).

number

The average used disk space in GiB across all Compute Nodes in the Pool.

number

The average memory usage in GiB across all Compute Nodes in the Pool.

number

The total amount of data in GiB of disk reads across all Compute Nodes in the Pool.

integer

The total number of disk read operations across all Compute Nodes in the Pool.

number

The total amount of data in GiB of disk writes across all Compute Nodes in the Pool.

integer

The total number of disk write operations across all Compute Nodes in the Pool.

string

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

number

The total amount of data in GiB of network reads across all Compute Nodes in the Pool.

number

The total amount of data in GiB of network writes across all Compute Nodes in the Pool.

number

The peak used disk space in GiB across all Compute Nodes in the Pool.

number

The peak memory usage in GiB across all Compute Nodes in the Pool.

string

The start time of the time range covered by the statistics.

boolean

Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal.

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.

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.

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.

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.

boolean

Upgrade all unhealthy instances in a scale set before any healthy instances.

boolean

Rollback failed instances to previous model if the Rolling Upgrade policy is violated.

string

string

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. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

SecurityTypes

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.
Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

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.

string

Trusted launch protects against advanced and persistent attack techniques.

string

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

string

The command line of the StartTask.
The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

TaskContainerSettings

The settings for the container under which the StartTask runs.
When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.

EnvironmentSetting[]

A list of environment variable settings for the StartTask.

integer

The maximum number of times the Task may be retried.
The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries).

ResourceFile[]

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

UserIdentity

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

boolean

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

string

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

string

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

string

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

ContainerHostBatchBindMountEntry[]

The paths you want to mounted to container task.
If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.

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.

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.

ContainerRegistry

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

ContainerWorkingDirectory

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

ComputeNodeFillType

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

boolean

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

boolean

Specifies whether vTPM should be enabled on the virtual machine.

string

All virtual machines in the scale set are automatically updated at the same time.

string

You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

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.

AutomaticOSUpgradePolicy

Configuration parameters used for performing automatic OS Upgrade.
The configuration parameters used for performing automatic OS upgrade.

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.

RollingUpgradePolicy

The configuration parameters used while performing a rolling upgrade.
The configuration parameters used while performing a rolling upgrade.

string

The aggregated wall-clock time of the dedicated Compute Node cores being part of the Pool.

string

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

string

The start time of the time range covered by the statistics.

ElevationLevel

The elevation level of the user Account.
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.

string

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

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.

string

The client id of the user assigned identity.

string

The principal id of the user assigned identity.

string

The ARM resource id of the user assigned identity

AutoUserSpecification

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

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.

ContainerConfiguration

The container configuration for the Pool.
If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it.

DataDisk[]

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

DiskEncryptionConfiguration

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

VMExtension[]

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.

string

The type of on-premises license to be used when deploying the operating system.
This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

string

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

NodePlacementConfiguration

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.

SecurityProfile

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

ServiceArtifactReference

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

WindowsConfiguration

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

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 is required when using Confidential VMs.

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.

boolean

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

string

The name of the virtual machine extension.

object

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

string[]

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

string

The name of the extension handler publisher.

object

JSON formatted public settings for the extension.

string

The type of the extension.

string

The version of script handler.

boolean

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

LoginMode

The login mode for the user
The default is 'batch'.