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

az batch job

注意

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

管理 Batch 作业。

命令

名称	说明	类型	状态
az batch job create	将作业添加到 Batch 帐户。	核心	GA
az batch job create (azure-batch-cli-extensions 扩展)	将作业和关联的任务添加到 Batch 帐户。	分机	GA
az batch job delete	删除作业。	核心	GA
az batch job disable	禁用指定的作业，防止新任务运行。	核心	GA
az batch job enable	启用指定的作业，允许运行新任务。	核心	GA
az batch job list	列出 Batch 帐户中的所有作业或作业计划。	核心	GA
az batch job prep-release-status	查看 Batch 作业准备和发布任务的状态。	核心	GA
az batch job prep-release-status list	列出作业在运行作业的计算节点中指定作业的作业准备和作业发布任务的执行状态。	核心	GA
az batch job reset	更新 Batch 作业的属性。 可以更新的未指定属性将重置为其默认值。	核心	GA
az batch job set	更新 Batch 作业的属性。 更新子组中的属性将重置该组的未指定属性。	核心	GA
az batch job show	获取有关指定作业的信息。	核心	GA
az batch job stop	停止正在运行的 Batch 作业。	核心	GA
az batch job task-counts	查看 Batch 作业中的任务和槽数及其状态。	核心	GA
az batch job task-counts show	获取指定作业的任务计数。	核心	GA

az batch job create

将作业添加到 Batch 帐户。

az batch job create [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--allow-task-preemption]
                    [--id]
                    [--job-manager-task-command-line]
                    [--job-manager-task-environment-settings]
                    [--job-manager-task-id]
                    [--job-manager-task-resource-files]
                    [--job-max-task-retry-count]
                    [--job-max-wall-clock-time]
                    [--json-file]
                    [--max-parallel-tasks]
                    [--metadata]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--uses-task-dependencies]

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--allow-task-preemption

此作业中的任务是否可以被其他高优先级作业抢占。 如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够重新排队此作业中的任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。 如此 如果存在标志。

--id

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

--job-manager-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）。

--job-manager-task-environment-settings

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

--job-manager-task-id

必需。 ID 可以包含字母数字字符的任意组合，包括连字符和下划线，不能包含超过 64 个字符。

--job-manager-task-resource-files

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

--job-max-task-retry-count

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

--job-max-wall-clock-time

如果作业未在时间限制内完成，Batch 服务将终止该作业，并且仍在运行的任何任务。 在这种情况下，终止原因将是 MaxWallClockTimeExpiry。 如果未指定此属性，则作业的运行时间没有限制。 预期格式为 ISO-8601 持续时间。

--json-file

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

--max-parallel-tasks

可为作业并行执行的最大任务数。 maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，则默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新作业的 maxParallelTasks。 默认值：-1 。

--metadata

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

--pool-id

现有池的 ID。 作业的所有任务都将在指定的池上运行。

--priority

作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 默认值为 0。

--required-slots

任务运行所需的计划槽数。 默认值为 1。 如果节点有足够的可用计划槽，则只能计划任务在计算节点上运行。 对于多实例任务，此属性不受支持，不得指定。

--uses-task-dependencies

作业中的任务是否可以定义彼此的依赖关系。 默认值为 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 job create (azure-batch-cli-extensions 扩展)

将作业和关联的任务添加到 Batch 帐户。

az batch job create [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--allow-task-preemption]
                    [--id]
                    [--job-manager-task-command-line]
                    [--job-manager-task-environment-settings]
                    [--job-manager-task-id]
                    [--job-manager-task-resource-files]
                    [--job-max-task-retry-count]
                    [--job-max-wall-clock-time]
                    [--json-file]
                    [--max-parallel-tasks]
                    [--metadata]
                    [--parameters]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--resource-group]
                    [--template]
                    [--uses-task-dependencies]

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--allow-task-preemption

此作业中的任务是否可以被其他高优先级作业抢占。 如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够重新排队此作业中的任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。

--id

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

--job-manager-task-command-line

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

--job-manager-task-environment-settings

作业管理器任务的环境变量设置列表。 以“key=value”格式分隔的值。

--job-manager-task-id

一个字符串，用于唯一标识作业中的作业管理器任务。 ID 可以包含字母数字字符的任意组合，包括连字符和下划线，不能包含超过 64 个字符。

--job-manager-task-resource-files

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

--job-max-task-retry-count

可以重试每个任务的最大次数。 批处理服务在其退出代码非零时重试任务。 请注意，此值专门用于控制重试的次数。 Batch 服务将尝试每个任务一次，然后最多可以重试此限制。 例如，如果最大重试计数为 3，则批处理任务最多尝试任务 4 次（一次是初始尝试，其余 3 次是重试）。 如果最大重试计数为 0，则批处理服务不会重试任务。 如果最大重试计数为 -1，则批处理服务会无限制地重试任务。 默认值为 0（不重试）。

--job-max-wall-clock-time

作业可能运行的最大运行时间，从创建作业的时间开始计算。 如果作业未在时间限制内完成，Batch 服务将终止该作业，以及仍在运行的任何任务。 在这种情况下，终止原因将是 MaxWallClockTimeExpiry。 如果未指定此属性，则作业的运行时间没有限制。 预期格式为 ISO-8601 持续时间。

--json-file

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

--max-parallel-tasks

可为作业并行执行的最大任务数。 maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，则默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新作业的 maxParallelTasks。 默认值：-1 。

--metadata

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

--parameters

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

--pool-id

现有池的 ID。 作业的所有任务都将在指定的池上运行。

--priority

作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 默认值为 0。

--required-slots

任务运行所需的计划槽数。 默认值为 1。 如果节点有足够的可用计划槽，则只能计划任务在计算节点上运行。 对于多实例任务，此属性不受支持，不得指定。

--resource-group

Batch 帐户的资源组。

--template

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

--uses-task-dependencies

确定此作业是否会使用具有依赖项的任务的标志。 如此 如果存在标志。

默认值: 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 job delete

删除作业。

删除作业还会删除属于该作业的所有任务以及所有作业统计信息。 这还会替代任务数据的保留期;也就是说，如果作业包含仍在计算节点上保留的任务，Batch 服务将删除这些任务的工作目录及其所有内容。 收到删除作业请求时，Batch 服务会将作业设置为删除状态。 正在删除状态的作业的所有更新操作都将失败，状态代码为 409（冲突），并显示正在删除作业的其他信息。

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

必需参数

--job-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 job disable

禁用指定的作业，防止新任务运行。

Batch 服务会立即将作业移动到禁用状态。 然后，Batch 使用 disableTasks 参数来确定对作业当前正在运行的任务执行的操作。 作业保持禁用状态，直到禁用操作完成，并且所有任务都已根据 disableTasks 选项进行处理;然后，作业将移动到禁用状态。 在作业恢复为活动状态之前，不会启动任何新任务。 如果尝试禁用处于活动、禁用或禁用状态以外的任何状态的作业，请求将失败，状态代码为 409。

az batch job disable --job-id
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--disable-tasks]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]

必需参数

--job-id

要禁用的作业的 ID。

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--disable-tasks

可能的值包括：“requeue”、“terminate”、“wait”。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

全局参数

--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 job enable

启用指定的作业，允许运行新任务。

调用此 API 时，Batch 服务会将禁用的作业设置为启用状态。 完成此操作后，作业将移动到活动状态，并在作业恢复下计划新任务。 Batch 服务不允许任务在 180 天内保持活动状态。 因此，如果启用包含超过 180 天前添加的活动任务的作业，这些任务将不会运行。

az batch job enable --job-id
                    [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--if-match]
                    [--if-modified-since]
                    [--if-none-match]
                    [--if-unmodified-since]

必需参数

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

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

全局参数

--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 job list

列出 Batch 帐户中的所有作业或作业计划。

az batch job list [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--expand]
                  [--filter]
                  [--job-schedule-id]
                  [--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 子句。

--job-schedule-id

要从中获取作业列表的作业计划的 ID。 如果省略，则列出帐户中的所有作业。

--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 job reset

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

az batch job reset --job-id
                   [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--allow-task-preemption]
                   [--if-match]
                   [--if-modified-since]
                   [--if-none-match]
                   [--if-unmodified-since]
                   [--job-max-task-retry-count]
                   [--job-max-wall-clock-time]
                   [--json-file]
                   [--max-parallel-tasks]
                   [--metadata]
                   [--on-all-tasks-complete {noaction, terminatejob}]
                   [--pool-id]
                   [--priority]

必需参数

--job-id

要更新其属性的作业的 ID。

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--allow-task-preemption

此作业中的任务是否可以被其他高优先级作业抢占。 如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够重新排队此作业中的任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。 如此 如果存在标志。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--job-max-task-retry-count

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

--job-max-wall-clock-time

如果作业未在时间限制内完成，Batch 服务将终止该作业，并且仍在运行的任何任务。 在这种情况下，终止原因将是 MaxWallClockTimeExpiry。 如果未指定此属性，则作业的运行时间没有限制。 预期格式为 ISO-8601 持续时间。

--json-file

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

--max-parallel-tasks

可为作业并行执行的最大任务数。 maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，则默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新作业的 maxParallelTasks。 默认值：-1 。

--metadata

如果省略，则采用空列表的默认值;实际上，将删除任何现有元数据。 以“key=value”格式分隔的空间值。

--on-all-tasks-complete

当作业中的所有任务都处于完成状态时，Batch 服务应执行的操作。 如果省略，则完成行为设置为 noaction。 如果当前值为 terminatejob，则这是一个错误，因为作业的完成行为可能不会从 terminatejob 更改为 noaction。 不能将值从 terminatejob 更改为 noaction - 即，一旦执行了自动作业终止，则不能再次将其关闭。 如果尝试执行此操作，请求将失败，Batch 将返回状态代码 400（错误请求）和“无效属性值”错误响应。 如果未在 PUT 请求中指定此元素，则它等效于传递 noaction。 如果当前值为 terminatejob，则此错误。

接受的值: noaction, terminatejob

--pool-id

现有池的 ID。 作业的所有任务都将在指定的池上运行。

--priority

作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 如果省略，则设置为默认值 0。

全局参数

--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 job set

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

az batch job set --job-id
                 [--account-endpoint]
                 [--account-key]
                 [--account-name]
                 [--allow-task-preemption]
                 [--if-match]
                 [--if-modified-since]
                 [--if-none-match]
                 [--if-unmodified-since]
                 [--job-max-task-retry-count]
                 [--job-max-wall-clock-time]
                 [--json-file]
                 [--max-parallel-tasks]
                 [--metadata]
                 [--on-all-tasks-complete {noaction, terminatejob}]
                 [--pool-id]
                 [--priority]

必需参数

--job-id

要更新其属性的作业的 ID。

可选参数

--account-endpoint

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

--account-key

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

--account-name

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

--allow-task-preemption

此作业中的任务是否可以被其他高优先级作业抢占。 如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够重新排队此作业中的任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。 指定“true”或“false”以更新属性。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--job-max-task-retry-count

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

--job-max-wall-clock-time

如果作业未在时间限制内完成，Batch 服务将终止该作业，并且仍在运行的任何任务。 在这种情况下，终止原因将是 MaxWallClockTimeExpiry。 如果未指定此属性，则作业的运行时间没有限制。 预期格式为 ISO-8601 持续时间。

--json-file

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

--max-parallel-tasks

可为作业并行执行的最大任务数。 maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，则默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新作业的 maxParallelTasks。

--metadata

如果省略，现有作业元数据保持不变。 以“key=value”格式分隔的空间值。

--on-all-tasks-complete

当作业中的所有任务都处于完成状态时，Batch 服务应执行的操作。 如果省略，则完成行为保持不变。 不能将值从 terminatejob 更改为 noaction - 即，一旦执行了自动作业终止，则不能再次将其关闭。 如果尝试执行此操作，则请求失败并出现“无效属性值”错误响应;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。

接受的值: noaction, terminatejob

--pool-id

现有池的 ID。 作业的所有任务都将在指定的池上运行。

--priority

作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 如果省略，则作业的优先级保持不变。

全局参数

--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 job show

获取有关指定作业的信息。

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

必需参数

--job-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 获取完整的调试日志。

az batch job stop

停止正在运行的 Batch 作业。

终止指定的作业，将其标记为已完成。 收到终止作业请求时，Batch 服务会将作业设置为终止状态。 然后，Batch 服务将终止与作业关联的任何正在运行的任务，并运行任何所需的作业发布任务。 然后，作业将进入已完成状态。 如果作业中有任何任务处于活动状态，它们将保持活动状态。 作业终止后，无法添加新任务，并且不会计划任何剩余的活动任务。

az batch job stop --job-id
                  [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--if-match]
                  [--if-modified-since]
                  [--if-none-match]
                  [--if-unmodified-since]
                  [--terminate-reason]

必需参数

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

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

--terminate-reason

终止原因。

要显示为作业的 TerminateReason 的文本。 默认值为“UserTerminate”。

全局参数

--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 获取完整的调试日志。