你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Pool interface

包:

@azure/arm-batch

包含有关池的信息。

扩展

AzureProxyResource

属性

allocationState	池是否调整大小。 注意：此属性不会序列化。 它只能由服务器填充。
allocationStateTransitionTime	池进入其当前分配状态的时间。 注意：此属性不会序列化。 它只能由服务器填充。
applicationLicenses	应用程序许可证列表必须是可用 Batch 服务应用程序许可证的子集。 如果请求的许可证不受支持，则池创建将失败。
applicationPackages	对应用程序包引用的更改会影响所有加入池的新计算节点，但在重新启动或重新映像之前，不会影响池中已有的计算节点。 任何给定池上最多有 10 个应用程序包引用。
autoScaleRun	仅当池自动缩放（即使用 autoScaleSettings）时，才会设置此属性。 注意：此属性不会序列化。 它只能由服务器填充。
certificates	对于 Windows 计算节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在任务工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“certs”目录，并将证书置于该目录中。 警告：此属性已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。
creationTime	池的创建时间。 注意：此属性不会序列化。 它只能由服务器填充。
currentDedicatedNodes	池中当前专用计算节点的数目。 注意：此属性不会序列化。 它只能由服务器填充。
currentLowPriorityNodes	池中当前存在的现成/低优先级计算节点数。 注意：此属性不会序列化。 它只能由服务器填充。
currentNodeCommunicationMode	确定池如何与 Batch 服务通信。 注意：此属性不会序列化。 它只能由服务器填充。
deploymentConfiguration	部署配置属性。
displayName	显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。
identity	用于 Batch 池的标识类型。
interNodeCommunication	这会对可分配给池的节点施加限制。 启用此值可以减少在池中分配请求的节点数的可能性。 如果未指定，则此值默认为“Disabled”。
lastModified	这是池级别数据（如 targetDedicatedNodes 或 autoScaleSettings）上次更改的时间。 它不考虑节点级更改，例如计算节点更改状态。 注意：此属性不会序列化。 它只能由服务器填充。
metadata	Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。
mountConfiguration	这支持 Azure 文件存储、NFS、CIFS/SMB 和 Blobfuse。
networkConfiguration	池的网络配置。
provisioningState	池的当前状态。 注意：此属性不会序列化。 它只能由服务器填充。
provisioningStateTransitionTime	池进入其当前状态的时间。 注意：此属性不会序列化。 它只能由服务器填充。
resizeOperationStatus	描述当前作（如果池 AllocationState 调整大小）或之前完成的作（如果 AllocationState 为稳定）。 注意：此属性不会序列化。 它只能由服务器填充。
resourceTags	要与 Azure Batch 池关联的用户定义的标记。 指定后，这些标记将传播到与池关联的支持 Azure 资源。 仅当使用 poolAllocationMode 属性设置为“UserSubscription”创建的 Batch 帐户时，才能指定此属性。
scaleSettings	定义池的所需大小。 这可以是指定所请求的目标DedicatedNode 的“fixedScale”，也可以是定义定期重新计算的公式的“autoScale”。 如果未指定此属性，则池将具有具有 0 个 targetDedicatedNodes 的固定缩放。
startTask	在 PATCH（更新）作中，此属性可以设置为空对象，以从池中删除启动任务。
targetNodeCommunicationMode	如果省略，则默认值为 Default。
taskSchedulingPolicy	如果未指定，则默认为分散。
taskSlotsPerNode	默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。
upgradePolicy	描述升级策略 - 自动、手动或滚动。
userAccounts	将在池中的每个节点上创建的用户帐户列表。
vmSize	有关可用 VM 大小的信息，请参阅虚拟机（Linux）（https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/）或虚拟机（Windows）的大小（https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/）。 Batch 支持除STANDARD_A0和具有高级存储（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）之外的所有 Azure VM 大小。

继承属性

etag	资源的 ETag，用于并发语句。 注意：此属性不会序列化。 它只能由服务器填充。
id	资源的 ID。 注意：此属性不会序列化。 它只能由服务器填充。
name	资源的名称。 注意：此属性不会序列化。 它只能由服务器填充。
tags	资源的标记。
type	资源的类型。 注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

allocationState

池是否调整大小。 注意：此属性不会序列化。 它只能由服务器填充。

allocationState?: AllocationState

属性值

AllocationState

allocationStateTransitionTime

池进入其当前分配状态的时间。 注意：此属性不会序列化。 它只能由服务器填充。

allocationStateTransitionTime?: Date

属性值

Date

applicationLicenses

应用程序许可证列表必须是可用 Batch 服务应用程序许可证的子集。 如果请求的许可证不受支持，则池创建将失败。

applicationLicenses?: string[]

属性值

string[]

applicationPackages

对应用程序包引用的更改会影响所有加入池的新计算节点，但在重新启动或重新映像之前，不会影响池中已有的计算节点。 任何给定池上最多有 10 个应用程序包引用。

applicationPackages?: ApplicationPackageReference[]

属性值

ApplicationPackageReference[]

autoScaleRun

仅当池自动缩放（即使用 autoScaleSettings）时，才会设置此属性。 注意：此属性不会序列化。 它只能由服务器填充。

autoScaleRun?: AutoScaleRun

属性值

AutoScaleRun

certificates

对于 Windows 计算节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在任务工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“certs”目录，并将证书置于该目录中。

警告：此属性已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。

certificates?: CertificateReference[]

属性值

CertificateReference[]

creationTime

池的创建时间。 注意：此属性不会序列化。 它只能由服务器填充。

creationTime?: Date

属性值

Date

currentDedicatedNodes

池中当前专用计算节点的数目。 注意：此属性不会序列化。 它只能由服务器填充。

currentDedicatedNodes?: number

属性值

number

currentLowPriorityNodes

池中当前存在的现成/低优先级计算节点数。 注意：此属性不会序列化。 它只能由服务器填充。

currentLowPriorityNodes?: number

属性值

number

currentNodeCommunicationMode

确定池如何与 Batch 服务通信。 注意：此属性不会序列化。 它只能由服务器填充。

currentNodeCommunicationMode?: NodeCommunicationMode

属性值

NodeCommunicationMode

deploymentConfiguration

部署配置属性。

deploymentConfiguration?: DeploymentConfiguration

属性值

DeploymentConfiguration

displayName

显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。

displayName?: string

属性值

string

identity

用于 Batch 池的标识类型。

identity?: BatchPoolIdentity

属性值

BatchPoolIdentity

interNodeCommunication

这会对可分配给池的节点施加限制。 启用此值可以减少在池中分配请求的节点数的可能性。 如果未指定，则此值默认为“Disabled”。

interNodeCommunication?: InterNodeCommunicationState

属性值

InterNodeCommunicationState

lastModified

这是池级别数据（如 targetDedicatedNodes 或 autoScaleSettings）上次更改的时间。 它不考虑节点级更改，例如计算节点更改状态。 注意：此属性不会序列化。 它只能由服务器填充。

lastModified?: Date

属性值

Date

metadata

Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。

metadata?: MetadataItem[]

属性值

MetadataItem[]

mountConfiguration

这支持 Azure 文件存储、NFS、CIFS/SMB 和 Blobfuse。

mountConfiguration?: MountConfiguration[]

属性值

MountConfiguration[]

networkConfiguration

池的网络配置。

networkConfiguration?: NetworkConfiguration

属性值

NetworkConfiguration

provisioningState

池的当前状态。 注意：此属性不会序列化。 它只能由服务器填充。

provisioningState?: PoolProvisioningState

属性值

PoolProvisioningState

provisioningStateTransitionTime

池进入其当前状态的时间。 注意：此属性不会序列化。 它只能由服务器填充。

provisioningStateTransitionTime?: Date

属性值

Date

resizeOperationStatus

描述当前作（如果池 AllocationState 调整大小）或之前完成的作（如果 AllocationState 为稳定）。 注意：此属性不会序列化。 它只能由服务器填充。

resizeOperationStatus?: ResizeOperationStatus

属性值

ResizeOperationStatus

resourceTags

要与 Azure Batch 池关联的用户定义的标记。 指定后，这些标记将传播到与池关联的支持 Azure 资源。 仅当使用 poolAllocationMode 属性设置为“UserSubscription”创建的 Batch 帐户时，才能指定此属性。

resourceTags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

scaleSettings

定义池的所需大小。 这可以是指定所请求的目标DedicatedNode 的“fixedScale”，也可以是定义定期重新计算的公式的“autoScale”。 如果未指定此属性，则池将具有具有 0 个 targetDedicatedNodes 的固定缩放。

scaleSettings?: ScaleSettings

属性值

ScaleSettings

startTask

在 PATCH（更新）作中，此属性可以设置为空对象，以从池中删除启动任务。

startTask?: StartTask

属性值

StartTask

targetNodeCommunicationMode

如果省略，则默认值为 Default。

targetNodeCommunicationMode?: NodeCommunicationMode

属性值

NodeCommunicationMode

taskSchedulingPolicy

如果未指定，则默认为分散。

taskSchedulingPolicy?: TaskSchedulingPolicy

属性值

TaskSchedulingPolicy

taskSlotsPerNode

默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。

taskSlotsPerNode?: number

属性值

number

upgradePolicy

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

upgradePolicy?: UpgradePolicy

属性值

UpgradePolicy

userAccounts

将在池中的每个节点上创建的用户帐户列表。

userAccounts?: UserAccount[]

属性值

UserAccount[]

vmSize

有关可用 VM 大小的信息，请参阅虚拟机（Linux）（https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/）或虚拟机（Windows）的大小（https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/）。 Batch 支持除STANDARD_A0和具有高级存储（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）之外的所有 Azure VM 大小。

vmSize?: string

属性值

string

继承属性详细信息

etag

资源的 ETag，用于并发语句。 注意：此属性不会序列化。 它只能由服务器填充。

etag?: string

属性值

string

继承自AzureProxyResource.etag

id

资源的 ID。 注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自 AzureProxyResource.id 的

name

资源的名称。 注意：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自 AzureProxyResource.name 的

tags

资源的标记。

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自AzureProxyResource.tags

type

资源的类型。 注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自AzureProxyResource.type