BatchPool interface

Package:

@azure/batch

A Pool in the Azure Batch service.

Properties

allocationState	Whether the Pool is resizing.
allocationStateTransitionTime	The time at which the Pool entered its current allocation state.
applicationPackageReferences	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.
autoScaleEvaluationInterval	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. The time duration is specified in ISO 8601 format.
autoScaleFormula	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.
creationTime	The creation time of the Pool.
currentDedicatedNodes	The number of dedicated Compute Nodes currently in the Pool.
currentLowPriorityNodes	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.
displayName	The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
enableAutoScale	Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false.
enableInterNodeCommunication	Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.
eTag	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.
id	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).
identity	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}'.
lastModified	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.
metadata	A list of name-value pairs associated with the Pool as metadata.
mountConfiguration	Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.
networkConfiguration	The network configuration for the Pool.
poolStatistics	Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the BatchPool 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.
resizeErrors	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.
resizeTimeout	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. The time duration is specified in ISO 8601 format.
startTask	A Task specified to run on each Compute Node as it joins the Pool.
state	The current state of the Pool.
stateTransitionTime	The time at which the Pool entered its current state.
targetDedicatedNodes	The desired number of dedicated Compute Nodes in the Pool.
targetLowPriorityNodes	The desired number of Spot/Low-priority Compute Nodes in the Pool.
taskSchedulingPolicy	How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.
taskSlotsPerNode	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.
url	The URL of the Pool.
userAccounts	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.
vmSize	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://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

Property Details

allocationState

Whether the Pool is resizing.

allocationState?: AllocationState

Property Value

AllocationState

allocationStateTransitionTime

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

allocationStateTransitionTime?: Date

Property Value

Date

applicationPackageReferences

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.

applicationPackageReferences?: BatchApplicationPackageReference[]

Property Value

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

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. The time duration is specified in ISO 8601 format.

autoScaleEvaluationInterval?: string

Property Value

string

autoScaleFormula

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.

autoScaleFormula?: string

Property Value

string

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.

autoScaleRun?: AutoScaleRun

Property Value

AutoScaleRun

creationTime

The creation time of the Pool.

creationTime: Date

Property Value

Date

currentDedicatedNodes

The number of dedicated Compute Nodes currently in the Pool.

currentDedicatedNodes: number

Property Value

number

currentLowPriorityNodes

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.

currentLowPriorityNodes: number

Property Value

number

displayName

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

displayName?: string

Property Value

string

enableAutoScale

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.

enableAutoScale?: boolean

Property Value

boolean

enableInterNodeCommunication

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

enableInterNodeCommunication?: boolean

Property Value

boolean

eTag

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.

eTag: string

Property Value

string

id

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

id: string

Property Value

string

identity

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

identity?: BatchPoolIdentity

Property Value

BatchPoolIdentity

lastModified

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.

lastModified: Date

Property Value

Date

metadata

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

metadata?: BatchMetadataItem[]

Property Value

BatchMetadataItem[]

mountConfiguration

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

mountConfiguration?: MountConfiguration[]

Property Value

MountConfiguration[]

networkConfiguration

The network configuration for the Pool.

networkConfiguration?: NetworkConfiguration

Property Value

NetworkConfiguration

poolStatistics

Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the BatchPool 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.

poolStatistics?: BatchPoolStatistics

Property Value

BatchPoolStatistics

resizeErrors

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.

resizeErrors?: ResizeError[]

Property Value

ResizeError[]

resizeTimeout

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. The time duration is specified in ISO 8601 format.

resizeTimeout?: string

Property Value

string

startTask

A Task specified to run on each Compute Node as it joins the Pool.

startTask?: BatchStartTask

Property Value

BatchStartTask

state

The current state of the Pool.

state: BatchPoolState

Property Value

BatchPoolState

stateTransitionTime

The time at which the Pool entered its current state.

stateTransitionTime: Date

Property Value

Date

targetDedicatedNodes

The desired number of dedicated Compute Nodes in the Pool.

targetDedicatedNodes?: number

Property Value

number

targetLowPriorityNodes

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

targetLowPriorityNodes?: number

Property Value

number

taskSchedulingPolicy

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

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

Property Value

BatchTaskSchedulingPolicy

taskSlotsPerNode

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.

taskSlotsPerNode?: number

Property Value

number

upgradePolicy

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

upgradePolicy?: UpgradePolicy

Property Value

UpgradePolicy

url

The URL of the Pool.

url: string

Property Value

string

userAccounts

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

userAccounts?: UserAccount[]

Property Value

UserAccount[]

virtualMachineConfiguration

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

virtualMachineConfiguration?: VirtualMachineConfiguration

Property Value

VirtualMachineConfiguration

vmSize

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://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

vmSize: string

Property Value

string