az batch pool

此池是否应启用加速网络。 加速网络使单个根 I/O 虚拟化（SR-IOV）能够连接到 VM，这可能会导致网络性能得到改善。 有关详细信息，请参阅：https://dori-uw-1.kuma-moon.com/azure/virtual-network/accelerated-networking-overview。 设置为 true 以启用。

Batch 服务终结点。 或者，由环境变量设置：AZURE_BATCH_ENDPOINT。

Batch 帐户密钥。 或者，由环境变量设置：AZURE_BATCH_ACCESS_KEY。

Batch 帐户名称。 或者，按环境变量设置：AZURE_BATCH_ACCOUNT。

要安装在池中每个计算节点上的包列表。 创建池时，包的应用程序 ID 必须完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。 # pylint：disable=line-too-long Changes to Package references 影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。 任何给定池上最多有 10 个包引用。 采用“id[#version]”格式的可选版本以空格分隔的应用程序 ID。

池中所需计算节点数的公式。 如果 enableAutoScale 设置为 false，则不能指定此属性。 如果 enableAutoScale 设置为 true，则需要它。 在创建池之前，将检查公式是否有效。 如果公式无效，Batch 服务会拒绝请求，并显示详细的错误信息。 有关指定此公式的详细信息，请参阅“自动缩放 Azure Batch 池中的计算节点”（https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/）。

如果 OS 升级正在运行任务，请延迟 TVM 上的 OS 升级。 如此 如果存在标志。

是否应禁用 OS 映像回滚功能。 如此 如果存在标志。

DiskEncryptionTargets 的空间分隔列表。 当前可能的值包括 OsDisk 和 TemporaryDisk。

指示当较新版本的 OS 映像可用时，是否应以滚动方式自动将 OS 升级应用于规模集实例。 ：code：<br />：code：<br /> 如果这设置为基于 Windows 的池为 true，则无法将 WindowsConfiguration.enableAutomaticUpdates <https://dori-uw-1.kuma-moon.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration>_ 设置为 true。 如此 如果存在标志。

允许 VMSS 在构造升级批处理时忽略 AZ 边界。 考虑 Update 域和 maxBatchInstancePercent 以确定批大小。 仅当将 NodePlacementConfiguration 用作 Zonal 时，此字段才可设置为 true 或 false。 如此 如果存在标志。

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

启用安全启动。

启用 vTPM。

指定是否应在磁盘上启用或禁用 writeAccelerator。

用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。 这将为所有磁盘启用加密，包括主机本身的资源/临时磁盘。 默认行为为：除非将此属性设置为 true，否则将禁用主机上的加密。

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

OS 映像参考。 这可以是“publisher：offer：sku[：version]”格式，也可以是格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}”的完全限定的 ARM 映像 ID。 如果“publisher：offer：sku[：version]”格式，则版本是可选的，如果省略了最新版本，则将使用。 可以通过“az batch pool supported-images list”检索有效值。 例如：“MicrosoftWindowsServer：WindowsServer：2012-R2-Datacenter：latest”。

包含池的文件在 JSON 中创建属性参数规范（格式设置为与 REST API 请求正文匹配）。 如果指定此参数，则忽略所有“池创建属性参数参数参数”。 请参阅 https://dori-uw-1.kuma-moon.com/rest/api/batchservice/pool/add?tabs=HTTP#request-body。

一批滚动升级同时升级的总虚拟机实例的最大百分比。 由于这是一个最大值，因此以前的或将来的批中的不正常实例可能会导致批处理中的实例百分比降低，以确保更高的可靠性。 此字段的值应介于 5 和 100 之间（含）。 如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都赋值，则 maxBatchInstancePercent 的值不应大于 maxUnhealthyInstancePercent。

规模集中可能同时运行不正常的虚拟机实例的最大百分比，无论是由于升级，还是虚拟机运行状况检查在滚动升级中止之前处于不正常状态。 在启动任何批处理之前，将检查此约束。 此字段的值应介于 5 和 100 之间（含）。 如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都赋值，则 maxBatchInstancePercent 的值不应大于 maxUnhealthyInstancePercent。

可发现处于不正常状态的已升级虚拟机实例的最大百分比。 升级每个批处理后，将进行此检查。 如果超过此百分比，滚动更新将中止。 此字段的值应介于 0 和 100 之间（含）。

与池关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。 以“key=value”格式分隔的空间值。

要在池中的计算节点上预配的 Batch 计算节点代理的 SKU。 Batch 计算节点代理是在池中的每个计算节点上运行的程序，并在计算节点和 Batch 服务之间提供命令和控制接口。 对于不同的操作系统，计算节点代理有不同的实现（称为 SKU）。 必须指定与所选映像引用匹配的计算节点代理 SKU。 若要获取支持的计算节点代理 SKU 及其已验证映像引用列表，请参阅“列出支持的计算节点代理 SKU”操作。 Required.

指定缓存要求。 可能的值包括：None、ReadOnly、ReadWrite。 默认值为：标准存储无。 高级存储的 ReadOnly。

创建新 OS 磁盘时的初始磁盘大小（以 GB 为单位）。

完成一批中所有虚拟机的更新和开始下一批之间的等待时间。 持续时间应采用 ISO 8601 格式指定。 预期格式为 ISO-8601 持续时间。

指定池中所有 VM 的操作系统磁盘的临时磁盘放置。 用户可以在请求中使用此属性来选择用于临时 OS 磁盘预配的位置，例如缓存磁盘空间。 有关临时 OS 磁盘大小要求的详细信息，请参阅 https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirementshttps://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements 和 Linux VM 的 Windows VM 的临时 OS 磁盘大小要求。 "cachedisk".

Batch 池上的节点放置策略类型。 Batch 服务用于预配节点的分配策略。 如果未指定，Batch 将使用区域策略。 已知值为：“区域”和“区域”。

在任何正常运行的实例之前，升级规模集中的所有不正常实例。 如此 如果存在标志。

将计算节点分配给池的超时。 此超时仅适用于手动缩放;当 enableAutoScale 设置为 true 时，它不起作用。 默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 预期格式为 ISO-8601 持续时间。

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

如果违反滚动升级策略，回滚失败实例到以前的模型。 如此 如果存在标志。

指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。 默认行为为：除非设置了此属性，否则不会启用 UefiSettings。

StartTask 的命令行。 命令行未在 shell 下运行，因此不能利用 shell 功能（如环境变量扩展）。 如果要利用这些功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。 如果命令行引用文件路径，则应使用相对路径（相对于任务工作目录），或使用 Batch 提供的环境变量（https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables）。 Required.

StartTask 的环境变量设置列表。 以“key=value”格式分隔的空间值。

可以重试任务的最大次数。 如果 Batch 服务退出代码为非零，则重试任务。 请注意，此值专门控制重试次数。 Batch 服务将尝试一次任务，然后可能会重试到此限制。 例如，如果最大重试计数为 3，Batch 将尝试任务最多 4 次（一次初始尝试和 3 次重试）。 如果最大重试计数为 0，Batch 服务不会重试任务。 如果最大重试计数为 -1，Batch 服务将重试任务，但不建议用于启动任务或任何任务。 默认值为 0（无重试）。

Batch 服务在运行命令行之前将下载到计算节点的文件列表。 资源文件列表的最大大小。 超过最大大小时，请求将失败，响应错误代码将为 RequestEntityTooLarge。 如果发生这种情况，则必须减小 ResourceFiles 的集合大小。 这可以使用 .zip 文件、应用程序包或 Docker 容器来实现。 此元素下列出的文件位于任务的工作目录中。 以 filename=httpurl 格式分隔的空间分隔资源引用。

在计划计算节点上的任何任务之前，Batch 服务是否应等待 StartTask 成功完成（即退出代码 0）。 如果 True 且 StartTask 在节点上失败，Batch 服务将重试 StartTask，最大重试计数（maxTaskRetryCount）。 如果任务在所有重试后仍未成功完成，则 Batch 服务会标记节点不可用，并且不会为其计划任务。 可以通过计算节点状态和故障信息详细信息来检测此条件。 如果为 false，Batch 服务不会等待 StartTask 完成。 在这种情况下，在 StartTask 仍在运行时，其他任务可以开始在计算节点上执行;即使 StartTask 失败，新任务将继续在计算节点上计划。 默认值为 true。 如此 如果存在标志。

托管磁盘的存储帐户类型。

池中所需的专用计算节点数。 如果 enableAutoScale 设置为 true，则不能指定此属性。 如果 enableAutoScale 设置为 false，则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。

池中所需的现成/低优先级计算节点数。 如果 enableAutoScale 设置为 true，则不能指定此属性。 如果 enableAutoScale 设置为 false，则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。

磁盘目标 Batch 服务将在计算节点上加密。 如果省略，池中的计算节点上没有磁盘将被加密。 在 Linux 池中，仅支持“TemporaryDisk”;在 Windows 池中，必须指定“OsDisk”和“TemporaryDisk”。 要加密的空间分离目标磁盘。 值可以是 OsDisk 或 TemporaryDisk。

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

池 OS 升级的模式。

指示是否应在自动 OS 升级期间使用滚动升级策略。 如果未在 VMSS 上定义任何策略，则自动 OS 升级将回退到默认策略。 如此 如果存在标志。

池中虚拟机的大小。 池中的所有虚拟机的大小都相同。 有关使用虚拟机市场映像（使用 virtualMachineConfiguration 创建的池）的可用 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 大小。 Required.

要获取的池的 ID。 Required.

Batch 服务终结点。 或者，由环境变量设置：AZURE_BATCH_ENDPOINT。

Batch 帐户密钥。 或者，由环境变量设置：AZURE_BATCH_ACCESS_KEY。

Batch 帐户名称。 或者，按环境变量设置：AZURE_BATCH_ACCOUNT。

与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值完全匹配时，才会执行该操作。

一个时间戳，指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时，才会执行该操作。

与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值不匹配时，才会执行该操作。

一个时间戳，指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时，才会执行该操作。

不要提示确认。

Batch 服务终结点。 或者，由环境变量设置：AZURE_BATCH_ENDPOINT。

Batch 帐户密钥。 或者，由环境变量设置：AZURE_BATCH_ACCESS_KEY。

Batch 帐户名称。 或者，按环境变量设置：AZURE_BATCH_ACCOUNT。

OData $expand 子句。

OData $filter 子句。 有关构造此筛选器的详细信息，请参阅 https://dori-uw-1.kuma-moon.com/rest/api/batchservice/odata-filters-in-batch。

OData $select 子句。

要更新的池的 ID。

Batch 服务终结点。 或者，由环境变量设置：AZURE_BATCH_ENDPOINT。

Batch 帐户密钥。 或者，由环境变量设置：AZURE_BATCH_ACCESS_KEY。

Batch 帐户名称。 仅需要环境变量设置：AZURE_BATCH_ACCOUNT。

Required. 该列表替换池上的任何现有应用程序包引用。 对应用程序包引用的更改会影响所有加入池的新计算节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。 任何给定池上最多有 10 个应用程序包引用。 如果省略，或者指定空集合，则会从池中删除任何现有的应用程序包引用。 在给定池上最多可以指定 10 个引用。

包含 JSON 格式的池更新属性参数规范的文件（格式与 REST API 请求正文匹配）。 如果指定此参数，则忽略所有“池更新属性参数参数参数”。

Required. 此列表替换池上配置的任何现有元数据。 如果省略或指定了 anempty 集合，则会从Pool 中删除任何现有元数据。

启动任务的命令行。 命令行未在 shell 下运行，因此不能利用 shell 功能（如环境变量扩展）。 如果要利用这些功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。

启动任务的环境变量设置列表。 以“key=value”格式分隔的空间值。

可以重试任务的最大次数。

Batch 服务在运行命令行之前将下载到计算节点的文件列表。 此元素下列出的文件位于任务的工作目录中。 以 filename=httpurl 格式分隔的空间分隔资源引用。

在计划计算节点上的任何任务之前，Batch 服务是否应等待启动任务成功完成（即退出代码 0）。 如果存在标志，则为 True，否则默认为 False。

池的 ID。

停止池大小调整操作。

Batch 服务终结点。 或者，由环境变量设置：AZURE_BATCH_ENDPOINT。

Batch 帐户密钥。 或者，由环境变量设置：AZURE_BATCH_ACCESS_KEY。

Batch 帐户名称。 仅需要环境变量设置：AZURE_BATCH_ACCOUNT。

仅当资源的当前 ETag 与指定值完全匹配时，才会执行该作。

仅当资源自指定时间戳以来已修改时，才会执行该作。

仅当资源的当前 ETag 与指定值完全匹配时，才会执行该作。

仅当资源自指定时间戳以来已修改时，才会执行该作。

当节点可能从池中删除时，如果池大小正在减少。

默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 ISO-8601 持续时间格式。

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

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

要获取的池的 ID。 Required.

Batch 服务终结点。 或者，由环境变量设置：AZURE_BATCH_ENDPOINT。

Batch 帐户密钥。 或者，由环境变量设置：AZURE_BATCH_ACCESS_KEY。

Batch 帐户名称。 或者，按环境变量设置：AZURE_BATCH_ACCOUNT。

要安装在池中每个计算节点上的包列表。 对包引用的更改会影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。 如果此元素存在，它将替换任何现有的包引用。 如果指定空集合，则会从池中删除所有包引用。 如果省略，则保留任何现有包引用不变。 采用“id[#version]”格式的可选版本以空格分隔的应用程序 ID。

与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值完全匹配时，才会执行该操作。

一个时间戳，指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时，才会执行该操作。

与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值不匹配时，才会执行该操作。

一个时间戳，指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时，才会执行该操作。

一个文件，其中包含 JSON 格式的池规范（格式与相应的 REST API 正文匹配）。 如果指定此参数，则忽略所有“池参数”。

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

StartTask 的命令行。 命令行未在 shell 下运行，因此不能利用 shell 功能（如环境变量扩展）。 如果要利用这些功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。 如果命令行引用文件路径，则应使用相对路径（相对于任务工作目录），或使用 Batch 提供的环境变量（https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables）。 Required.

StartTask 的环境变量设置列表。 以“key=value”格式分隔的空间值。

可以重试任务的最大次数。 如果 Batch 服务退出代码为非零，则重试任务。 请注意，此值专门控制重试次数。 Batch 服务将尝试一次任务，然后可能会重试到此限制。 例如，如果最大重试计数为 3，Batch 将尝试任务最多 4 次（一次初始尝试和 3 次重试）。 如果最大重试计数为 0，Batch 服务不会重试任务。 如果最大重试计数为 -1，Batch 服务将重试任务，但不建议用于启动任务或任何任务。 默认值为 0（无重试）。

Batch 服务在运行命令行之前将下载到计算节点的文件列表。 资源文件列表的最大大小。 超过最大大小时，请求将失败，响应错误代码将为 RequestEntityTooLarge。 如果发生这种情况，则必须减小 ResourceFiles 的集合大小。 这可以使用 .zip 文件、应用程序包或 Docker 容器来实现。 此元素下列出的文件位于任务的工作目录中。 以 filename=httpurl 格式分隔的空间分隔资源引用。

在计划计算节点上的任何任务之前，Batch 服务是否应等待 StartTask 成功完成（即退出代码 0）。 如果 True 且 StartTask 在节点上失败，Batch 服务将重试 StartTask，最大重试计数（maxTaskRetryCount）。 如果任务在所有重试后仍未成功完成，则 Batch 服务会标记节点不可用，并且不会为其计划任务。 可以通过计算节点状态和故障信息详细信息来检测此条件。 如果为 false，Batch 服务不会等待 StartTask 完成。 在这种情况下，在 StartTask 仍在运行时，其他任务可以开始在计算节点上执行;即使 StartTask 失败，新任务将继续在计算节点上计划。 默认值为 true。 如此 如果存在标志。

要获取的池的 ID。 Required.

Batch 服务终结点。 或者，由环境变量设置：AZURE_BATCH_ENDPOINT。

Batch 帐户密钥。 或者，由环境变量设置：AZURE_BATCH_ACCESS_KEY。

Batch 帐户名称。 或者，按环境变量设置：AZURE_BATCH_ACCOUNT。

OData $expand 子句。

与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值完全匹配时，才会执行该操作。

一个时间戳，指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时，才会执行该操作。

与客户端已知的资源版本关联的 ETag 值。 仅当服务的当前 ETag 与客户端指定的值不匹配时，才会执行该操作。

一个时间戳，指示客户端已知资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时，才会执行该操作。

OData $select 子句。