BatchPoolUpdateOptions interface

Package:

@azure-rest/batch

Parameters for updating an Azure Batch Pool.

Properties

applicationPackageReferences	A 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. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged.
displayName	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. This field can be updated only when the pool is empty.
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. This field can be updated only when the pool is empty.
metadata	A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged.
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. This field can be updated only when the pool is empty.
networkConfiguration	The network configuration for the Pool. This field can be updated only when the pool is empty.
startTask	A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.
taskSchedulingPolicy	How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. This field can be updated only when the pool is empty.
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. This field can be updated only when the pool is empty.
upgradePolicy	The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. This field can be updated only when the pool is empty.
userAccounts	The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool is empty.
virtualMachineConfiguration	The virtual machine configuration for the Pool. This property must be specified. This field can be updated only when the pool is empty.
vmSize	The size of virtual machines in the Pool. 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). This field can be updated only when the pool is empty.

Property Details

applicationPackageReferences

A 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. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged.

applicationPackageReferences?: BatchApplicationPackageReference[]

Property Value

BatchApplicationPackageReference[]

displayName

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. This field can be updated only when the pool is empty.

displayName?: string

Property Value

string

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.

This field can be updated only when the pool is empty.

enableInterNodeCommunication?: boolean

Property Value

boolean

metadata

A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged.

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.

This field can be updated only when the pool is empty.

mountConfiguration?: MountConfiguration[]

Property Value

MountConfiguration[]

networkConfiguration

The network configuration for the Pool. This field can be updated only when the pool is empty.

networkConfiguration?: NetworkConfiguration

Property Value

NetworkConfiguration

startTask

A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.

startTask?: BatchStartTask

Property Value

BatchStartTask

taskSchedulingPolicy

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

This field can be updated only when the pool is empty.

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.

This field can be updated only when the pool is empty.

taskSlotsPerNode?: number

Property Value

number

upgradePolicy

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

This field can be updated only when the pool is empty.

upgradePolicy?: UpgradePolicy

Property Value

UpgradePolicy

userAccounts

The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool is empty.

userAccounts?: UserAccount[]

Property Value

UserAccount[]

virtualMachineConfiguration

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

This field can be updated only when the pool is empty.

virtualMachineConfiguration?: VirtualMachineConfiguration

Property Value

VirtualMachineConfiguration

vmSize

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

This field can be updated only when the pool is empty.

vmSize?: string

Property Value

string