BatchPoolOutput interface

包:

@azure-rest/batch

Azure Batch 服务中的池。

属性

allocationState	池是否调整大小。 可能的值：“steady”、“resizing”、“stopping”
allocationStateTransitionTime	池进入其当前分配状态的时间。
applicationPackageReferences	要安装在池中每个计算节点上的包列表。 对包引用的更改会影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。 任何给定池上最多有 10 个包引用。
autoScaleEvaluationInterval	根据自动缩放公式自动调整池大小的时间间隔。 仅当池自动缩放（即 enableAutoScale 为 true）时，才会设置此属性。
autoScaleFormula	池中所需计算节点数的公式。 仅当池自动缩放（即 enableAutoScale 为 true）时，才会设置此属性。
autoScaleRun	自动缩放公式上次执行的结果和错误。 仅当池自动缩放（即 enableAutoScale 为 true）时，才会设置此属性。
creationTime	池的创建时间。
currentDedicatedNodes	池中当前专用计算节点数。
currentLowPriorityNodes	池中当前存在的现成/低优先级计算节点数。 此计数中包括已抢占的现成/低优先级计算节点。
displayName	显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。
enableAutoScale	池大小是否应随时间自动调整。 如果为 false，则必须指定至少一个 targetDedicatedNodes 和 targetLowPriorityNodes。 如果为 true，则需要 autoScaleFormula 属性，并且池会根据公式自动调整大小。 默认值为 false。
enableInterNodeCommunication	池是否允许在计算节点之间直接通信。 由于池的计算节点的部署限制，启用节点间通信会限制池的最大大小。 这可能会导致池未达到其所需大小。 默认值为 false。
eTag	池的 ETag。 这是一个不透明的字符串。 可以使用它来检测池是否在请求之间发生了更改。 具体而言，可以在更新池时传递 ETag，以指定仅当其他人在此期间没有修改池时，更改才会生效。
id	唯一标识帐户中的池的字符串。 ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是区分大小写和不区分大小写的（也就是说，帐户中可能没有两个 ID，仅大小写不同）。
identity	Batch 池的标识（如果已配置）。 与 Batch 池关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
lastModified	池的上次修改时间。 这是池级别数据（例如 targetDedicatedNodes 或 enableAutoscale 设置）上次更改的时间。 它不考虑节点级更改，例如计算节点更改状态。
metadata	与池关联的名称/值对列表作为元数据。
mountConfiguration	在池的整个生存期内使用指定的文件系统挂载存储。 使用基于 Azure 文件共享、NFS、CIFS 或 Blobfuse 的文件系统装载存储。
networkConfiguration	池的网络配置。
resizeErrors	在池上执行上一次重设大小时遇到的错误列表。 仅当上一个池调整大小期间发生一个或多个错误，并且仅当 Pool allocationState 为稳定时，才会设置此属性。
resizeTimeout	将计算节点分配给池的超时。 这是最近调整大小操作的超时。 （创建池时的初始大小调整计为调整大小。默认值为 15 分钟。
startTask	指定在联接池时在每个计算节点上运行的任务。
state	池的当前状态。 可能的值：“active”、“删除”
stateTransitionTime	池进入其当前状态的时间。
stats	池整个生存期的利用率和资源使用情况统计信息。 仅当使用包含“stats”属性的 expand 子句检索 BatchPool 时，才会填充此属性;否则为 null。 统计信息可能不会立即可用。 Batch 服务执行统计信息的定期汇总。 典型的延迟约为 30 分钟。
targetDedicatedNodes	池中所需的专用计算节点数。
targetLowPriorityNodes	池中所需的现成/低优先级计算节点数。
taskSchedulingPolicy	任务如何在池中的计算节点之间分布。 如果未指定，则默认为分散。
taskSlotsPerNode	可用于在池中的单个计算节点上运行并发任务的任务槽数。 默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。
upgradePolicy	池的升级策略。 描述升级策略 - 自动、手动或滚动。
url	池的 URL。
userAccounts	将在池中的每个计算节点上创建的用户帐户列表。
virtualMachineConfiguration	池的虚拟机配置。 必须指定此属性。
vmSize	池中虚拟机的大小。 池中的所有虚拟机的大小都相同。 有关池中虚拟机的可用大小的信息，请参阅为 Azure Batch 池中的计算节点选择 VM 大小 （https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes）。

属性详细信息

allocationState

池是否调整大小。

可能的值：“steady”、“resizing”、“stopping”

allocationState?: string

属性值

string

allocationStateTransitionTime

池进入其当前分配状态的时间。

allocationStateTransitionTime?: string

属性值

string

applicationPackageReferences

要安装在池中每个计算节点上的包列表。 对包引用的更改会影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。 任何给定池上最多有 10 个包引用。

applicationPackageReferences?: BatchApplicationPackageReferenceOutput[]

属性值

BatchApplicationPackageReferenceOutput[]

autoScaleEvaluationInterval

根据自动缩放公式自动调整池大小的时间间隔。 仅当池自动缩放（即 enableAutoScale 为 true）时，才会设置此属性。

autoScaleEvaluationInterval?: string

属性值

string

autoScaleFormula

池中所需计算节点数的公式。 仅当池自动缩放（即 enableAutoScale 为 true）时，才会设置此属性。

autoScaleFormula?: string

属性值

string

autoScaleRun

自动缩放公式上次执行的结果和错误。 仅当池自动缩放（即 enableAutoScale 为 true）时，才会设置此属性。

autoScaleRun?: AutoScaleRunOutput

属性值

AutoScaleRunOutput

creationTime

池的创建时间。

creationTime: string

属性值

string

currentDedicatedNodes

池中当前专用计算节点数。

currentDedicatedNodes: number

属性值

number

currentLowPriorityNodes

池中当前存在的现成/低优先级计算节点数。 此计数中包括已抢占的现成/低优先级计算节点。

currentLowPriorityNodes: number

属性值

number

displayName

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

displayName?: string

属性值

string

enableAutoScale

池大小是否应随时间自动调整。 如果为 false，则必须指定至少一个 targetDedicatedNodes 和 targetLowPriorityNodes。 如果为 true，则需要 autoScaleFormula 属性，并且池会根据公式自动调整大小。 默认值为 false。

enableAutoScale?: boolean

属性值

boolean

enableInterNodeCommunication

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

enableInterNodeCommunication?: boolean

属性值

boolean

eTag

池的 ETag。 这是一个不透明的字符串。 可以使用它来检测池是否在请求之间发生了更改。 具体而言，可以在更新池时传递 ETag，以指定仅当其他人在此期间没有修改池时，更改才会生效。

eTag: string

属性值

string

id

唯一标识帐户中的池的字符串。 ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是区分大小写和不区分大小写的（也就是说，帐户中可能没有两个 ID，仅大小写不同）。

id: string

属性值

string

identity

Batch 池的标识（如果已配置）。 与 Batch 池关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

identity?: BatchPoolIdentityOutput

属性值

BatchPoolIdentityOutput

lastModified

池的上次修改时间。 这是池级别数据（例如 targetDedicatedNodes 或 enableAutoscale 设置）上次更改的时间。 它不考虑节点级更改，例如计算节点更改状态。

lastModified: string

属性值

string

metadata

与池关联的名称/值对列表作为元数据。

metadata?: BatchMetadataItemOutput[]

属性值

BatchMetadataItemOutput[]

mountConfiguration

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

mountConfiguration?: MountConfigurationOutput[]

属性值

MountConfigurationOutput[]

networkConfiguration

池的网络配置。

networkConfiguration?: NetworkConfigurationOutput

属性值

NetworkConfigurationOutput

resizeErrors

在池上执行上一次重设大小时遇到的错误列表。 仅当上一个池调整大小期间发生一个或多个错误，并且仅当 Pool allocationState 为稳定时，才会设置此属性。

resizeErrors?: ResizeErrorOutput[]

属性值

ResizeErrorOutput[]

resizeTimeout

将计算节点分配给池的超时。 这是最近调整大小操作的超时。 （创建池时的初始大小调整计为调整大小。默认值为 15 分钟。

resizeTimeout?: string

属性值

string

startTask

指定在联接池时在每个计算节点上运行的任务。

startTask?: BatchStartTaskOutput

属性值

BatchStartTaskOutput

state

池的当前状态。

可能的值：“active”、“删除”

state: string

属性值

string

stateTransitionTime

池进入其当前状态的时间。

stateTransitionTime: string

属性值

string

stats

池整个生存期的利用率和资源使用情况统计信息。 仅当使用包含“stats”属性的 expand 子句检索 BatchPool 时，才会填充此属性;否则为 null。 统计信息可能不会立即可用。 Batch 服务执行统计信息的定期汇总。 典型的延迟约为 30 分钟。

stats?: BatchPoolStatisticsOutput

属性值

BatchPoolStatisticsOutput

targetDedicatedNodes

池中所需的专用计算节点数。

targetDedicatedNodes?: number

属性值

number

targetLowPriorityNodes

池中所需的现成/低优先级计算节点数。

targetLowPriorityNodes?: number

属性值

number

taskSchedulingPolicy

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

taskSchedulingPolicy?: BatchTaskSchedulingPolicyOutput

属性值

BatchTaskSchedulingPolicyOutput

taskSlotsPerNode

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

taskSlotsPerNode?: number

属性值

number

upgradePolicy

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

upgradePolicy?: UpgradePolicyOutput

属性值

UpgradePolicyOutput

url

池的 URL。

url: string

属性值

string

userAccounts

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

userAccounts?: UserAccountOutput[]

属性值

UserAccountOutput[]

virtualMachineConfiguration

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

virtualMachineConfiguration?: VirtualMachineConfigurationOutput

属性值

VirtualMachineConfigurationOutput

vmSize

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

vmSize: string

属性值

string