PoolProperties interface
Pool properties.
Properties
| allocation |
Whether the pool is resizing. |
| allocation |
The time at which the pool entered its current allocation state. |
| application |
Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. |
| auto |
This property is set only if the pool automatically scales, i.e. autoScaleSettings are used. |
| creation |
The creation time of the pool. |
| current |
The number of dedicated compute nodes currently in the pool. |
| current |
The number of Spot/low-priority compute nodes currently in the pool. |
| deployment |
Deployment configuration properties. |
| display |
The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. |
| inter |
This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. |
| last |
This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. |
| metadata | The Batch service does not assign any meaning to metadata; it is solely for the use of user code. |
| mount |
This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. |
| network |
The network configuration for a pool. |
| provisioning |
The current state of the pool. |
| provisioning |
The time at which the pool entered its current state. |
| resize |
Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). |
| scale |
Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. |
| start |
In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. |
| task |
If not specified, the default is spread. |
| task |
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. |
| upgrade |
Describes an upgrade policy - automatic, manual, or rolling. |
| user |
The list of user accounts to be created on each node in the pool. |
| vm |
For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://dori-uw-1.kuma-moon.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). |
Property Details
allocationState
allocationStateTransitionTime
The time at which the pool entered its current allocation state.
allocationStateTransitionTime?: Date
Property Value
Date
applicationPackages
Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.
applicationPackages?: ApplicationPackageReference[]
Property Value
autoScaleRun
This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.
autoScaleRun?: AutoScaleRun
Property Value
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.
currentLowPriorityNodes?: number
Property Value
number
deploymentConfiguration
Deployment configuration properties.
deploymentConfiguration?: DeploymentConfiguration
Property Value
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
interNodeCommunication
This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.
interNodeCommunication?: InterNodeCommunicationState
Property Value
lastModified
This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.
lastModified?: Date
Property Value
Date
metadata
The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
metadata?: MetadataItem[]
Property Value
mountConfiguration
This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
mountConfiguration?: MountConfiguration[]
Property Value
networkConfiguration
The network configuration for a pool.
networkConfiguration?: NetworkConfiguration
Property Value
provisioningState
The current state of the pool.
provisioningState?: PoolProvisioningState
Property Value
provisioningStateTransitionTime
The time at which the pool entered its current state.
provisioningStateTransitionTime?: Date
Property Value
Date
resizeOperationStatus
Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
resizeOperationStatus?: ResizeOperationStatus
Property Value
scaleSettings
Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.
scaleSettings?: ScaleSettings
Property Value
startTask
In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
startTask?: StartTask
Property Value
taskSchedulingPolicy
If not specified, the default is spread.
taskSchedulingPolicy?: TaskSchedulingPolicy
Property Value
taskSlotsPerNode
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
Describes an upgrade policy - automatic, manual, or rolling.
upgradePolicy?: UpgradePolicy
Property Value
userAccounts
The list of user accounts to be created on each node in the pool.
userAccounts?: UserAccount[]
Property Value
vmSize
For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://dori-uw-1.kuma-moon.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
vmSize?: string
Property Value
string