BatchPoolSpecificationOutput interface
创建新池的规范。
属性
| application |
要安装在池中每个计算节点上的包列表。 创建池时,包的应用程序 ID 必须完全限定(/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName})。 对包引用的更改会影响所有加入池的新节点,但不会影响池中已存在于池中的计算节点,直到重新启动或重新映像这些节点。 任何给定池上最多有 10 个包引用。 |
| auto |
根据自动缩放公式自动调整池大小的时间间隔。 默认值为 15 分钟。 最小值和最大值分别为 5 分钟和 168 小时。 如果指定的值小于 5 分钟或大于 168 小时,Batch 服务将拒绝请求并显示无效属性值错误;如果直接调用 REST API,则 HTTP 状态代码为 400(请求错误)。 |
| auto |
池中所需计算节点数的公式。 如果 enableAutoScale 设置为 false,则不能指定此属性。 如果 enableAutoScale 设置为 true,则需要它。 在创建池之前,将检查公式是否有效。 如果公式无效,Batch 服务会拒绝请求,并显示详细的错误信息。 |
| display |
池的显示名称。 显示名称不一定是唯一的,可以包含最大长度为 1024 的任何 Unicode 字符。 |
| enable |
池大小是否应随时间自动调整。 如果为 false,则必须指定至少一个 targetDedicatedNodes 和 targetLowPriorityNodes。 如果为 true,则需要 autoScaleFormula 元素。 池根据公式自动调整大小。 默认值为 false。 |
| enable |
池是否允许在计算节点之间直接通信。 由于池的计算节点的部署限制,启用节点间通信会限制池的最大大小。 这可能会导致池未达到其所需大小。 默认值为 false。 |
| metadata | 与池关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。 |
| mount |
要安装在池中每个节点上的文件系统列表。 这支持 Azure 文件存储、NFS、CIFS/SMB 和 Blobfuse。 |
| network |
池的网络配置。 |
| resize |
将计算节点分配给池的超时。 此超时仅适用于手动缩放;当 enableAutoScale 设置为 true 时,它不起作用。 默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟,Batch 服务将拒绝请求并显示错误;如果直接调用 REST API,则 HTTP 状态代码为 400(请求错误)。 |
| start |
在联接池时在每个计算节点上运行的任务。 当将计算节点添加到池或重启计算节点时,任务将运行。 |
| target |
池中所需的专用计算节点数。 如果 enableAutoScale 设置为 true,则不能指定此属性。 如果 enableAutoScale 设置为 false,则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。 |
| target |
池中所需的现成/低优先级计算节点数。 如果 enableAutoScale 设置为 true,则不能指定此属性。 如果 enableAutoScale 设置为 false,则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。 |
| task |
任务如何在池中的计算节点之间分布。 如果未指定,则默认为分散。 |
| task |
可用于在池中的单个计算节点上运行并发任务的任务槽数。 默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。 |
| upgrade |
池的升级策略。 描述升级策略 - 自动、手动或滚动。 |
| user |
将在池中的每个计算节点上创建的用户帐户列表。 |
| virtual |
池的虚拟机配置。 必须指定此属性。 |
| vm |
池中虚拟机的大小。 池中的所有虚拟机的大小都相同。 有关池中虚拟机的可用大小的信息,请参阅为 Azure Batch 池中的计算节点选择 VM 大小(https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes)。 |
属性详细信息
applicationPackageReferences
要安装在池中每个计算节点上的包列表。 创建池时,包的应用程序 ID 必须完全限定(/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName})。 对包引用的更改会影响所有加入池的新节点,但不会影响池中已存在于池中的计算节点,直到重新启动或重新映像这些节点。 任何给定池上最多有 10 个包引用。
applicationPackageReferences?: BatchApplicationPackageReferenceOutput[]
属性值
autoScaleEvaluationInterval
根据自动缩放公式自动调整池大小的时间间隔。 默认值为 15 分钟。 最小值和最大值分别为 5 分钟和 168 小时。 如果指定的值小于 5 分钟或大于 168 小时,Batch 服务将拒绝请求并显示无效属性值错误;如果直接调用 REST API,则 HTTP 状态代码为 400(请求错误)。
autoScaleEvaluationInterval?: string
属性值
string
autoScaleFormula
池中所需计算节点数的公式。 如果 enableAutoScale 设置为 false,则不能指定此属性。 如果 enableAutoScale 设置为 true,则需要它。 在创建池之前,将检查公式是否有效。 如果公式无效,Batch 服务会拒绝请求,并显示详细的错误信息。
autoScaleFormula?: string
属性值
string
displayName
池的显示名称。 显示名称不一定是唯一的,可以包含最大长度为 1024 的任何 Unicode 字符。
displayName?: string
属性值
string
enableAutoScale
池大小是否应随时间自动调整。 如果为 false,则必须指定至少一个 targetDedicatedNodes 和 targetLowPriorityNodes。 如果为 true,则需要 autoScaleFormula 元素。 池根据公式自动调整大小。 默认值为 false。
enableAutoScale?: boolean
属性值
boolean
enableInterNodeCommunication
池是否允许在计算节点之间直接通信。 由于池的计算节点的部署限制,启用节点间通信会限制池的最大大小。 这可能会导致池未达到其所需大小。 默认值为 false。
enableInterNodeCommunication?: boolean
属性值
boolean
metadata
与池关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。
metadata?: BatchMetadataItemOutput[]
属性值
mountConfiguration
要安装在池中每个节点上的文件系统列表。 这支持 Azure 文件存储、NFS、CIFS/SMB 和 Blobfuse。
mountConfiguration?: MountConfigurationOutput[]
属性值
networkConfiguration
resizeTimeout
将计算节点分配给池的超时。 此超时仅适用于手动缩放;当 enableAutoScale 设置为 true 时,它不起作用。 默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟,Batch 服务将拒绝请求并显示错误;如果直接调用 REST API,则 HTTP 状态代码为 400(请求错误)。
resizeTimeout?: string
属性值
string
startTask
在联接池时在每个计算节点上运行的任务。 当将计算节点添加到池或重启计算节点时,任务将运行。
startTask?: BatchStartTaskOutput
属性值
targetDedicatedNodes
池中所需的专用计算节点数。 如果 enableAutoScale 设置为 true,则不能指定此属性。 如果 enableAutoScale 设置为 false,则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。
targetDedicatedNodes?: number
属性值
number
targetLowPriorityNodes
池中所需的现成/低优先级计算节点数。 如果 enableAutoScale 设置为 true,则不能指定此属性。 如果 enableAutoScale 设置为 false,则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。
targetLowPriorityNodes?: number
属性值
number
taskSchedulingPolicy
任务如何在池中的计算节点之间分布。 如果未指定,则默认为分散。
taskSchedulingPolicy?: BatchTaskSchedulingPolicyOutput
属性值
taskSlotsPerNode
可用于在池中的单个计算节点上运行并发任务的任务槽数。 默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。
taskSlotsPerNode?: number
属性值
number
upgradePolicy
userAccounts
virtualMachineConfiguration
池的虚拟机配置。 必须指定此属性。
virtualMachineConfiguration?: VirtualMachineConfigurationOutput
属性值
vmSize
池中虚拟机的大小。 池中的所有虚拟机的大小都相同。 有关池中虚拟机的可用大小的信息,请参阅为 Azure Batch 池中的计算节点选择 VM 大小(https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes)。
vmSize: string
属性值
string