BatchPoolUpdateOptions interface

包:

@azure-rest/batch

用于更新 Azure Batch 池的参数。

属性

applicationPackageReferences	要安装在池中每个计算节点上的包列表。 对包引用的更改会影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。 如果此元素存在，它将替换任何现有的包引用。 如果指定空集合，则会从池中删除所有包引用。 如果省略，则保留任何现有包引用不变。
displayName	池的显示名称。 显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。 仅当池为空时，才能更新此字段。
enableInterNodeCommunication	池是否允许在计算节点之间直接通信。 由于池的计算节点的部署限制，启用节点间通信会限制池的最大大小。 这可能会导致池未达到其所需大小。 默认值为 false。 仅当池为空时，才能更新此字段。
metadata	与池关联的名称/值对列表作为元数据。 如果此元素存在，它将替换池上配置的任何现有元数据。 如果指定空集合，则会从池中删除任何元数据。 如果省略，则任何现有元数据保持不变。
mountConfiguration	在池的整个生存期内使用指定的文件系统装载存储。 使用 Azure 文件共享、NFS、CIFS 或基于 Blobfuse 的文件系统装载存储。 仅当池为空时，才能更新此字段。
networkConfiguration	池的网络配置。 仅当池为空时，才能更新此字段。
startTask	在联接池时在每个计算节点上运行的任务。 当将计算节点添加到池或重启计算节点时，任务将运行。 如果此元素存在，它将覆盖任何现有的 StartTask。 如果省略，则任何现有的 StartTask 保持不变。
taskSchedulingPolicy	任务如何在池中的计算节点之间分布。 如果未指定，则默认为分散。 仅当池为空时，才能更新此字段。
taskSlotsPerNode	可用于在池中单个计算节点上运行并发任务的任务槽数。 默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。 仅当池为空时，才能更新此字段。
upgradePolicy	池的升级策略。 描述升级策略 - 自动、手动或滚动。 仅当池为空时，才能更新此字段。
userAccounts	将在池中的每个计算节点上创建的用户帐户列表。 仅当池为空时，才能更新此字段。
virtualMachineConfiguration	池的虚拟机配置。 必须指定此属性。 仅当池为空时，才能更新此字段。
vmSize	池中虚拟机的大小。 有关池中虚拟机的可用大小的信息，请参阅为 Azure Batch 池中的计算节点选择 VM 大小（https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes）。 仅当池为空时，才能更新此字段。

属性详细信息

applicationPackageReferences

要安装在池中每个计算节点上的包列表。 对包引用的更改会影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。 如果此元素存在，它将替换任何现有的包引用。 如果指定空集合，则会从池中删除所有包引用。 如果省略，则保留任何现有包引用不变。

applicationPackageReferences?: BatchApplicationPackageReference[]

属性值

BatchApplicationPackageReference[]

displayName

池的显示名称。 显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。 仅当池为空时，才能更新此字段。

displayName?: string

属性值

string

enableInterNodeCommunication

池是否允许在计算节点之间直接通信。 由于池的计算节点的部署限制，启用节点间通信会限制池的最大大小。 这可能会导致池未达到其所需大小。 默认值为 false。

仅当池为空时，才能更新此字段。

enableInterNodeCommunication?: boolean

属性值

boolean

metadata

与池关联的名称/值对列表作为元数据。 如果此元素存在，它将替换池上配置的任何现有元数据。 如果指定空集合，则会从池中删除任何元数据。 如果省略，则任何现有元数据保持不变。

metadata?: BatchMetadataItem[]

属性值

BatchMetadataItem[]

mountConfiguration

在池的整个生存期内使用指定的文件系统装载存储。 使用 Azure 文件共享、NFS、CIFS 或基于 Blobfuse 的文件系统装载存储。

仅当池为空时，才能更新此字段。

mountConfiguration?: MountConfiguration[]

属性值

MountConfiguration[]

networkConfiguration

池的网络配置。 仅当池为空时，才能更新此字段。

networkConfiguration?: NetworkConfiguration

属性值

NetworkConfiguration

startTask

在联接池时在每个计算节点上运行的任务。 当将计算节点添加到池或重启计算节点时，任务将运行。 如果此元素存在，它将覆盖任何现有的 StartTask。 如果省略，则任何现有的 StartTask 保持不变。

startTask?: BatchStartTask

属性值

BatchStartTask

taskSchedulingPolicy

任务如何在池中的计算节点之间分布。 如果未指定，则默认为分散。

仅当池为空时，才能更新此字段。

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

属性值

BatchTaskSchedulingPolicy

taskSlotsPerNode

可用于在池中单个计算节点上运行并发任务的任务槽数。 默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。

仅当池为空时，才能更新此字段。

taskSlotsPerNode?: number

属性值

number

upgradePolicy

池的升级策略。 描述升级策略 - 自动、手动或滚动。

仅当池为空时，才能更新此字段。

upgradePolicy?: UpgradePolicy

属性值

UpgradePolicy

userAccounts

将在池中的每个计算节点上创建的用户帐户列表。 仅当池为空时，才能更新此字段。

userAccounts?: UserAccount[]

属性值

UserAccount[]

virtualMachineConfiguration

池的虚拟机配置。 必须指定此属性。

仅当池为空时，才能更新此字段。

virtualMachineConfiguration?: VirtualMachineConfiguration

属性值

VirtualMachineConfiguration

vmSize

池中虚拟机的大小。 有关池中虚拟机的可用大小的信息，请参阅为 Azure Batch 池中的计算节点选择 VM 大小（https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes）。

仅当池为空时，才能更新此字段。

vmSize?: string

属性值

string