通过

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

az batch pool

  • 参考

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展，使其受益于其扩展功能。 详细了解扩展。

管理 Batch 池。

命令

名称 说明 类型 Status
az batch pool autoscale

管理 Batch 池的自动缩放。

 核心 加语
az batch pool autoscale disable

禁用池的自动缩放。

 核心 加语
az batch pool autoscale enable

为池启用自动缩放。

 核心 加语
az batch pool autoscale evaluate

获取在池上评估自动缩放公式的结果。

 核心 加语
az batch pool create

在帐户中创建 Batch 池。 创建池时，请从云服务配置或虚拟机配置中选择参数。

 核心 加语
az batch pool create (azure-batch-cli-extensions 扩展)

在帐户中创建 Batch 池。 创建池时，请从云服务配置或虚拟机配置中选择参数。

 外延 加语
az batch pool delete

从指定的帐户中删除池。

 核心 加语
az batch pool list

列出指定帐户中的所有池。

 核心 加语
az batch pool node-counts

获取 Batch 池的节点计数。

 核心 加语
az batch pool node-counts list

获取按池分组的每个状态中的计算节点数。

 核心 加语
az batch pool reset

更新 Batch 池的属性。 可以更新的未指定属性将重置为其默认值。

 核心 加语
az batch pool resize

调整或停止调整 Batch 池的大小。

 核心 加语
az batch pool set

更新 Batch 池的属性。 更新子组中的属性将重置该组的未指定属性。

 核心 加语
az batch pool show

获取有关指定池的信息。

 核心 加语
az batch pool supported-images

查询有关 Azure Batch 服务支持的 VM 映像的信息。

 核心 加语
az batch pool supported-images list

列出 Azure Batch 服务支持的所有虚拟机映像。

 核心 加语
az batch pool usage-metrics

查看 Batch 池的使用情况指标。

 核心 加语
az batch pool usage-metrics list

列出指定帐户的按池聚合的单个时间间隔的使用情况指标。

 核心 加语

az batch pool create

编辑

在帐户中创建 Batch 池。 创建池时，请从云服务配置或虚拟机配置中选择参数。

az batch pool create [--accelerated-networking {false, true}]
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--application-licenses]
                     [--application-package-references]
                     [--auto-scale-formula]
                     [--certificate-references]
                     [--defer-os-rolling-upgrade {false, true}]
                     [--disable-auto-rollback {false, true}]
                     [--disk-encryption-targets]
                     [--enable-auto-os-upgrade {false, true}]
                     [--enable-cross-zone-upgrade {false, true}]
                     [--enable-inter-node-communication]
                     [--enable-secure-boot {false, true}]
                     [--enable-vtpm {false, true}]
                     [--enable-write-accel {false, true}]
                     [--encryption-at-host {false, true}]
                     [--id]
                     [--image]
                     [--json-file]
                     [--max-batch-instance-percent]
                     [--max-unhealthy-instance-percent]
                     [--max-unhealthy-upgraded-instance-percent]
                     [--metadata]
                     [--node-agent-sku-id]
                     [--os-disk-caching {none, readonly, readwrite}]
                     [--os-disk-size]
                     [--os-family {2, 3, 4, 5, 6}]
                     [--os-version]
                     [--pause-time-between-batches]
                     [--placement {cachedisk}]
                     [--policy {regional, zonal}]
                     [--prioritize-unhealthy-instances {false, true}]
                     [--resize-timeout]
                     [--resource-tags]
                     [--rollback-failed-instances-on-policy-breach {false, true}]
                     [--security-type]
                     [--start-task-command-line]
                     [--start-task-resource-files]
                     [--start-task-wait-for-success]
                     [--storage-account-type {premium_lrs, standard_lrs, standardssd_lrs}]
                     [--target-communication {classic, default, simplified}]
                     [--target-dedicated-nodes]
                     [--target-low-priority-nodes]
                     [--targets]
                     [--task-slots-per-node]
                     [--upgrade-policy-mode {automatic, manual, rolling}]
                     [--use-rolling-upgrade-policy {false, true}]
                     [--vm-size]

可选参数

--accelerated-networking

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

接受的值: false, true
--account-endpoint

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

--account-key

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

--account-name

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

--application-licenses

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

--application-package-references

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

--auto-scale-formula

池中所需计算节点数的公式。 在创建池之前，将检查公式是否有效。 如果公式无效，Batch 服务会拒绝请求，并显示详细的错误信息。 有关指定此公式的详细信息，请参阅 https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/。

--certificate-references

对于 Windows 节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在 Task 工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“证书”目录，并将证书置于该目录中。 警告：此属性已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。 空格分隔的证书指纹。

--defer-os-rolling-upgrade

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

接受的值: false, true
--disable-auto-rollback

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

接受的值: false, true
--disk-encryption-targets

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

--enable-auto-os-upgrade

指示当较新版本的 OS 映像可用时，是否应以滚动方式自动将 OS 升级应用于规模集实例。

如果对于基于 Windows 的池，WindowsConfiguration.enableAutomaticUpdates 不能设置为 true。 如此 如果存在标志。

接受的值: false, true
--enable-cross-zone-upgrade

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

接受的值: false, true
--enable-inter-node-communication

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

--enable-secure-boot

启用安全启动。

接受的值: false, true
--enable-vtpm

启用 vTPM。

接受的值: false, true
--enable-write-accel

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

接受的值: false, true
--encryption-at-host

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

接受的值: false, true
--id

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

--image

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-file

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

--max-batch-instance-percent

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

--max-unhealthy-instance-percent

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

--max-unhealthy-upgraded-instance-percent

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

--metadata

Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。 以“key=value”格式分隔的空间值。

--node-agent-sku-id

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

--os-disk-caching

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

接受的值: none, readonly, readwrite
--os-disk-size

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

--os-family

必填。 可能的值为：2 - OS 系列 2，等效于 Windows Server 2008 R2 SP1。 3 - OS 系列 3，等效于 Windows Server 2012。 4 - OS 系列 4，等效于 Windows Server 2012 R2。 5 - OS 系列 5，相当于 Windows Server 2016。 6 - OS 系列 6，等效于 Windows Server 2019。 有关详细信息，请参阅 Azure 来宾 OS 版本（https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases）。

接受的值: 2, 3, 4, 5, 6
--os-version

默认值为 * ，指定指定 OS 系列的最新操作系统版本。

--pause-time-between-batches

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

--placement

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

接受的值: cachedisk
--policy

Batch 池上的节点放置策略类型。 Batch 服务用于预配节点的分配策略。 如果未指定，Batch 将使用区域策略。

接受的值: regional, zonal
--prioritize-unhealthy-instances

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

接受的值: false, true
--resize-timeout

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

--resource-tags

用户能够指定池的资源标记。 然后，为池创建的任何资源也会由同一资源标记进行标记。

--rollback-failed-instances-on-policy-breach

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

接受的值: false, true
--security-type

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

--start-task-command-line

必填。 命令行未在 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）。

--start-task-resource-files

此元素下列出的文件位于任务的工作目录中。 以 filename=httpurl 格式分隔的空间分隔资源引用。

--start-task-wait-for-success

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

--storage-account-type

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

接受的值: premium_lrs, standard_lrs, standardssd_lrs
--target-communication

池的所需节点通信模式。 如果存在此元素，它将替换池上配置的现有 targetNodeCommunicationMode。 如果省略，则任何现有元数据保持不变。

接受的值: classic, default, simplified
--target-dedicated-nodes

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

--target-low-priority-nodes

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

--targets

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

--task-slots-per-node

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

--upgrade-policy-mode

池 OS 升级的模式。

接受的值: automatic, manual, rolling
--use-rolling-upgrade-policy

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

接受的值: false, true
--vm-size

必填。 有关云服务池（使用 cloudServiceConfiguration 创建的池）的可用虚拟机大小的信息，请参阅云服务的大小（https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/）。 Batch 支持除 ExtraSmall、A1V2 和 A2V2 之外的所有云服务 VM 大小。 有关使用虚拟机市场（使用 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 大小。

全局参数
--debug

增加日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关详细信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。

az batch pool create (azure-batch-cli-extensions 扩展)

在帐户中创建 Batch 池。 创建池时，请从云服务配置或虚拟机配置中选择参数。

az batch pool create [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--application-licenses]
                     [--application-package-references]
                     [--auto-scale-formula]
                     [--certificate-references]
                     [--disk-encryption-targets]
                     [--enable-inter-node-communication]
                     [--id]
                     [--image]
                     [--json-file]
                     [--metadata]
                     [--node-agent-sku-id]
                     [--os-family]
                     [--os-version]
                     [--parameters]
                     [--policy]
                     [--resize-timeout]
                     [--resource-group]
                     [--start-task-command-line]
                     [--start-task-resource-files]
                     [--start-task-wait-for-success]
                     [--target-dedicated-nodes]
                     [--target-low-priority-nodes]
                     [--targets]
                     [--task-slots-per-node]
                     [--template]
                     [--vm-size]

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--application-licenses

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

--application-package-references

创建池时，包的应用程序 ID 必须完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。 对包引用的更改会影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。 任何给定池上最多有 10 个包引用。

--auto-scale-formula

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

--certificate-references

对于 Windows 节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在 Task 工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“证书”目录，并将证书置于该目录中。 警告：此属性已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。

--disk-encryption-targets

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

--enable-inter-node-communication

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

默认值: False
--id

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

--image

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

--json-file

包含以 JSON 格式创建的池的文件（如果指定此参数，则忽略所有其他参数）。

--metadata

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

--node-agent-sku-id

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

--os-family

要安装在池中的虚拟机上的 Azure 来宾 OS 系列。 可能的值为：2 - OS 系列 2，等效于 Windows Server 2008 R2 SP1。 3 - OS 系列 3，等效于 Windows Server 2012。 4 - OS 系列 4，等效于 Windows Server 2012 R2。 5 - OS 系列 5，相当于 Windows Server 2016。 有关详细信息，请参阅 Azure 来宾 OS 版本（https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases）。 允许的值：2、3、4、5。

--os-version

默认值为 * ，指定指定 OS 系列的最新操作系统版本。

--parameters

Batch 池 JSON 模板文件的参数值。 只能与 --template 一起使用。

--policy

Batch 池上的节点放置策略类型。 Batch 服务用于预配节点的分配策略。 如果未指定，Batch 将使用区域策略。 允许的值：区域、区域。

--resize-timeout

此超时仅适用于手动缩放;当 enableAutoScale 设置为 true 时，它不起作用。 默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。

--resource-group

Batch 帐户的资源组。

--start-task-command-line

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

--start-task-resource-files

Batch 服务在运行命令行之前将下载到计算节点的文件列表。 以 filename=httpurl 格式分隔的资源引用空间。

--start-task-wait-for-success

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

默认值: False
--target-dedicated-nodes

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

--target-low-priority-nodes

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

--targets

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

--task-slots-per-node

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

--template

Batch 池 JSON 模板文件。 如果指定此参数，则忽略所有其他参数。

--vm-size

必填。 有关云服务池（使用 cloudServiceConfiguration 创建的池）的可用虚拟机大小的信息，请参阅云服务的大小（https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/）。 Batch 支持除 ExtraSmall、A1V2 和 A2V2 之外的所有云服务 VM 大小。 有关使用虚拟机市场（使用 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 大小。

全局参数
--debug

增加日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关详细信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。

az batch pool delete

编辑

从指定的帐户中删除池。

请求删除池时，会发生以下操作：池状态设置为删除;正在对池执行的任何调整大小操作将停止;Batch 服务开始将池大小调整为零个计算节点;在现有计算节点上运行的任何任务将终止并重新排队（就好像使用默认重新排队选项请求了调整池大小操作一样）：最后，将从系统中删除池。 由于重新排队运行的任务，因此用户可以通过将作业更新为面向其他池来重新运行这些任务。 然后，任务可以在新的池上运行。 如果要重写重新排队行为，则应在删除池之前显式调用调整池大小以将池收缩为零大小。 如果在删除状态下对池调用更新、修补或删除 API，它将失败并显示 HTTP 状态代码 409，错误代码为 PoolBeingDeleted。

az batch pool delete --pool-id
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]
                     [--yes]

必需参数

--pool-id

要删除的池的 ID。

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--yes -y

不要提示确认。

默认值: False
全局参数
--debug

增加日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关详细信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。

az batch pool list

编辑

列出指定帐户中的所有池。

az batch pool list [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--expand]
                   [--filter]
                   [--select]

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--expand

OData $expand 子句。

--filter

OData $filter 子句。 有关构造此筛选器的详细信息，请参阅 https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools。

--select

OData $select 子句。

全局参数
--debug

增加日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关详细信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。

az batch pool reset

编辑

更新 Batch 池的属性。 可以更新的未指定属性将重置为其默认值。

az batch pool reset --pool-id
                    [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--application-package-references]
                    [--certificate-references]
                    [--json-file]
                    [--metadata]
                    [--start-task-command-line]
                    [--start-task-environment-settings]
                    [--start-task-max-task-retry-count]
                    [--start-task-wait-for-success]

必需参数

--pool-id

要更新的池的 ID。

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--application-package-references

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

--certificate-references

必填。 此列表替换池上配置的任何现有证书引用。 如果指定空集合，则会从池中删除任何现有证书引用。 对于 Windows 节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在 Task 工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“证书”目录，并将证书置于该目录中。 警告：此属性已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。

--json-file

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

--metadata

必填。 此列表替换池上配置的任何现有元数据。 如果省略，或者指定空集合，则会从池中删除任何现有元数据。

--start-task-command-line

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

--start-task-environment-settings

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

--start-task-max-task-retry-count

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

--start-task-wait-for-success

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

全局参数
--debug

增加日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关详细信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。

az batch pool resize

编辑

调整或停止调整 Batch 池的大小。

az batch pool resize --pool-id
                     [--abort]
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]
                     [--node-deallocation-option {requeue, retaineddata, taskcompletion, terminate}]
                     [--resize-timeout]
                     [--target-dedicated-nodes]
                     [--target-low-priority-nodes]

必需参数

--pool-id

池的 ID。

可选参数

--abort

停止池大小调整操作。

默认值: False
--account-endpoint

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

--account-key

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

--account-name

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

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--node-deallocation-option

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

接受的值: requeue, retaineddata, taskcompletion, terminate
--resize-timeout

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

--target-dedicated-nodes

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

--target-low-priority-nodes

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

全局参数
--debug

增加日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关详细信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。

az batch pool set

编辑

更新 Batch 池的属性。 更新子组中的属性将重置该组的未指定属性。

az batch pool set --pool-id
                  [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--application-package-references]
                  [--certificate-references]
                  [--if-match]
                  [--if-modified-since]
                  [--if-none-match]
                  [--if-unmodified-since]
                  [--json-file]
                  [--metadata]
                  [--start-task-command-line]
                  [--start-task-environment-settings]
                  [--start-task-max-task-retry-count]
                  [--start-task-resource-files]
                  [--start-task-wait-for-success]
                  [--target-communication {classic, default, simplified}]

必需参数

--pool-id

要更新的池的 ID。

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--application-package-references

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

--certificate-references

如果存在此元素，它将替换池上配置的任何现有证书引用。 如果省略，则任何现有证书引用保持不变。 对于 Windows 节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在 Task 工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“证书”目录，并将证书置于该目录中。 警告：此属性已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。 空格分隔的证书指纹。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--json-file

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

--metadata

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

--start-task-command-line

必填。 命令行未在 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）。

--start-task-environment-settings

以“key=value”格式分隔的空间值。

--start-task-max-task-retry-count

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

--start-task-resource-files

此元素下列出的文件位于任务的工作目录中。 以 filename=httpurl 格式分隔的空间分隔资源引用。

--start-task-wait-for-success

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

--target-communication

池的所需节点通信模式。 如果存在此元素，它将替换池上配置的现有 targetNodeCommunicationMode。 如果省略，则任何现有元数据保持不变。

接受的值: classic, default, simplified
全局参数
--debug

增加日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关详细信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。

az batch pool show

编辑

获取有关指定池的信息。

az batch pool show --pool-id
                   [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--expand]
                   [--if-match]
                   [--if-modified-since]
                   [--if-none-match]
                   [--if-unmodified-since]
                   [--select]

必需参数

--pool-id

要获取的池的 ID。

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--expand

OData $expand 子句。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--select

OData $select 子句。

全局参数
--debug

增加日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关详细信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。