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

az batch job-schedule

  • 参考

管理 Batch 作业计划。

命令

名称 说明 类型 状态
az batch job-schedule create

将 Batch 作业计划添加到帐户。

 核心 GA
az batch job-schedule delete

从指定的帐户中删除作业计划。

 核心 GA
az batch job-schedule disable

禁用作业计划。

 核心 GA
az batch job-schedule enable

启用作业计划。

 核心 GA
az batch job-schedule list

列出指定帐户中的所有作业计划。

 核心 GA
az batch job-schedule reset

重置作业计划的属性。 更新的作业规范仅适用于新作业。

 核心 GA
az batch job-schedule set

更新作业计划的属性。

 核心 GA
az batch job-schedule show

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

 核心 GA
az batch job-schedule stop

终止作业计划。

 核心 GA

az batch job-schedule create

编辑

将 Batch 作业计划添加到帐户。

az batch job-schedule create [--account-endpoint]
                             [--account-key]
                             [--account-name]
                             [--allow-task-preemption]
                             [--do-not-run-after]
                             [--do-not-run-until]
                             [--id]
                             [--job-manager-task-command-line]
                             [--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]
                             [--on-all-tasks-complete {noaction, terminatejob}]
                             [--pool-id]
                             [--priority]
                             [--recurrence-interval]
                             [--required-slots]
                             [--start-window]
                             [--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。 如此 如果存在标志。

--do-not-run-after

如果未指定 doNotRunAfter 时间，并且要创建定期作业计划，则在显式终止作业计划之前，作业计划将保持活动状态。 预期格式为 ISO-8601 时间戳。

--do-not-run-until

如果未指定 doNotRunUntil 时间，计划将立即开始创建作业。 预期格式为 ISO-8601 时间戳。

--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-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”格式分隔的空间值。

--on-all-tasks-complete

当在此计划下创建的作业中的所有任务都处于已完成状态时，Batch 服务应执行的操作。 请注意，如果作业不包含任何任务，则所有任务都被视为已完成。 因此，此选项最常用于作业管理器任务;如果要在没有作业管理器的情况下使用自动作业终止，则应最初将 OnAllTasksComplete 设置为 noaction，并将作业属性更新为在完成添加任务后将 OnAllTasksComplete 设置为 terminatejob。 默认值为 noaction。

接受的值: noaction, terminatejob
--pool-id

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

--priority

在此计划下创建的作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 默认值为 0。 此优先级用作作业计划下的所有作业的默认值。 使用更新作业 API 创建作业后，可以更新作业的优先级。

--recurrence-interval

由于作业计划在任何给定时间最多可以有一个活动作业，因此，如果要在作业计划下创建新作业，但上一个作业仍在运行，则 Batch 服务在上一个作业完成之前不会创建新作业。 如果上一个作业未在新 recurrenceInterval 的 startWindow 期间内完成，则不会计划该间隔的新作业。 对于定期作业，通常应在 jobSpecification 中指定 jobManagerTask。 如果不使用 jobManagerTask，则需要一个外部进程来监视何时创建作业、将任务添加到作业并终止作业，以便下次重复。 默认值为计划不会递归：在 doNotRunUntil 时间之后的 startWindow 中创建一个作业，并在该作业完成后立即完成计划。 最小值为 1 分钟。 如果指定了较低的值，Batch 服务将拒绝计划并显示错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 预期格式为 ISO-8601 持续时间。

--required-slots

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

--start-window

如果未在 startWindow 间隔内创建作业，则会丢失“机会”;在计划下一次重复之前，不会创建任何作业。 如果计划是定期的，并且 startWindow 比重复间隔长，则这相当于无限 startWindow，因为一个 recurrenceInterval 中“due”的作业不会转发到下一个重复间隔。 默认值为无限。 最小值为 1 分钟。 如果指定了较低的值，Batch 服务将拒绝计划并显示错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 预期格式为 ISO-8601 持续时间。

--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-schedule delete

编辑

从指定的帐户中删除作业计划。

删除作业计划时，这也会删除该计划下的所有作业和任务。 删除任务后，也会删除计算节点上工作目录中的所有文件（将忽略保留期）。 删除作业计划后，作业计划统计信息将不再可访问，尽管这些统计信息仍计入帐户生存期统计信息。

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

必需参数

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

编辑

禁用作业计划。

在再次启用作业计划之前，不会创建新作业。

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

必需参数

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

编辑

启用作业计划。

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

必需参数

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

编辑

列出指定帐户中的所有作业计划。

az batch job-schedule 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-job-schedules。

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

编辑

重置作业计划的属性。 更新的作业规范仅适用于新作业。

az batch job-schedule reset --job-schedule-id
                            [--account-endpoint]
                            [--account-key]
                            [--account-name]
                            [--allow-task-preemption]
                            [--do-not-run-after]
                            [--do-not-run-until]
                            [--if-match]
                            [--if-modified-since]
                            [--if-none-match]
                            [--if-unmodified-since]
                            [--job-manager-task-application-package-references]
                            [--job-manager-task-command-line]
                            [--job-manager-task-environment-settings]
                            [--job-manager-task-id]
                            [--job-manager-task-resource-files]
                            [--job-metadata]
                            [--json-file]
                            [--max-parallel-tasks]
                            [--metadata]
                            [--on-all-tasks-complete {noaction, terminatejob}]
                            [--pool-id]
                            [--priority]
                            [--recurrence-interval]
                            [--required-slots]
                            [--start-window]
                            [--uses-task-dependencies]

必需参数

--job-schedule-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。 如此 如果存在标志。

--do-not-run-after

如果未指定 doNotRunAfter 时间，并且要创建定期作业计划，则在显式终止作业计划之前，作业计划将保持活动状态。 预期格式为 ISO-8601 时间戳。

--do-not-run-until

如果未指定 doNotRunUntil 时间，计划将立即开始创建作业。 预期格式为 ISO-8601 时间戳。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--job-manager-task-application-package-references

应用程序包将下载并部署到共享目录，而不是任务工作目录。 因此，如果引用的应用程序包已在计算节点上，并且是最新的，则不会重新下载它;使用计算节点上的现有副本。 如果无法安装引用的应用程序包，例如由于包已删除或下载失败，则任务将失败。 采用“id[#version]”格式的可选版本以空格分隔的应用程序 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-metadata

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

--json-file

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

--max-parallel-tasks

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

--metadata

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

--on-all-tasks-complete

当在此计划下创建的作业中的所有任务都处于已完成状态时，Batch 服务应执行的操作。 请注意，如果作业不包含任何任务，则所有任务都被视为已完成。 因此，此选项最常用于作业管理器任务;如果要在没有作业管理器的情况下使用自动作业终止，则应最初将 OnAllTasksComplete 设置为 noaction，并将作业属性更新为在完成添加任务后将 OnAllTasksComplete 设置为 terminatejob。 默认值为 noaction。

接受的值: noaction, terminatejob
--pool-id

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

--priority

在此计划下创建的作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 默认值为 0。 此优先级用作作业计划下的所有作业的默认值。 使用更新作业 API 创建作业后，可以更新作业的优先级。

--recurrence-interval

由于作业计划在任何给定时间最多可以有一个活动作业，因此，如果要在作业计划下创建新作业，但上一个作业仍在运行，则 Batch 服务在上一个作业完成之前不会创建新作业。 如果上一个作业未在新 recurrenceInterval 的 startWindow 期间内完成，则不会计划该间隔的新作业。 对于定期作业，通常应在 jobSpecification 中指定 jobManagerTask。 如果不使用 jobManagerTask，则需要一个外部进程来监视何时创建作业、将任务添加到作业并终止作业，以便下次重复。 默认值为计划不会递归：在 doNotRunUntil 时间之后的 startWindow 中创建一个作业，并在该作业完成后立即完成计划。 最小值为 1 分钟。 如果指定了较低的值，Batch 服务将拒绝计划并显示错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 预期格式为 ISO-8601 持续时间。

--required-slots

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

--start-window

如果未在 startWindow 间隔内创建作业，则会丢失“机会”;在计划下一次重复之前，不会创建任何作业。 如果计划是定期的，并且 startWindow 比重复间隔长，则这相当于无限 startWindow，因为一个 recurrenceInterval 中“due”的作业不会转发到下一个重复间隔。 默认值为无限。 最小值为 1 分钟。 如果指定了较低的值，Batch 服务将拒绝计划并显示错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 预期格式为 ISO-8601 持续时间。

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

编辑

更新作业计划的属性。

可以独立更新计划和作业规范，但对这些实体中的任何一个实体所做的任何更改都将重置该实体中的所有属性。

az batch job-schedule set --job-schedule-id
                          [--account-endpoint]
                          [--account-key]
                          [--account-name]
                          [--allow-task-preemption]
                          [--do-not-run-after]
                          [--do-not-run-until]
                          [--if-match]
                          [--if-modified-since]
                          [--if-none-match]
                          [--if-unmodified-since]
                          [--job-manager-task-application-package-references]
                          [--job-manager-task-command-line]
                          [--job-manager-task-environment-settings]
                          [--job-manager-task-id]
                          [--job-manager-task-resource-files]
                          [--job-metadata]
                          [--json-file]
                          [--max-parallel-tasks]
                          [--metadata]
                          [--on-all-tasks-complete {noaction, terminatejob}]
                          [--pool-id]
                          [--priority]
                          [--recurrence-interval]
                          [--required-slots]
                          [--start-window]
                          [--uses-task-dependencies]

必需参数

--job-schedule-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”以更新属性。

--do-not-run-after

如果未指定 doNotRunAfter 时间，并且要创建定期作业计划，则在显式终止作业计划之前，作业计划将保持活动状态。 预期格式为 ISO-8601 时间戳。

--do-not-run-until

如果未指定 doNotRunUntil 时间，计划将立即开始创建作业。 预期格式为 ISO-8601 时间戳。

--if-match

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

--if-modified-since

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

--if-none-match

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

--if-unmodified-since

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

--job-manager-task-application-package-references

应用程序包将下载并部署到共享目录，而不是任务工作目录。 因此，如果引用的应用程序包已在计算节点上，并且是最新的，则不会重新下载它;使用计算节点上的现有副本。 如果无法安装引用的应用程序包，例如由于包已删除或下载失败，则任务将失败。 采用“id[#version]”格式的可选版本以空格分隔的应用程序 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-metadata

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

--json-file

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

--max-parallel-tasks

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

--metadata

如果未指定此元素，则现有元数据保持不变。 以“key=value”格式分隔的空间值。

--on-all-tasks-complete

当在此计划下创建的作业中的所有任务都处于已完成状态时，Batch 服务应执行的操作。 请注意，如果作业不包含任何任务，则所有任务都被视为已完成。 因此，此选项最常用于作业管理器任务;如果要在没有作业管理器的情况下使用自动作业终止，则应最初将 OnAllTasksComplete 设置为 noaction，并将作业属性更新为在完成添加任务后将 OnAllTasksComplete 设置为 terminatejob。 默认值为 noaction。

接受的值: noaction, terminatejob
--pool-id

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

--priority

在此计划下创建的作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 默认值为 0。 此优先级用作作业计划下的所有作业的默认值。 使用更新作业 API 创建作业后，可以更新作业的优先级。

--recurrence-interval

由于作业计划在任何给定时间最多可以有一个活动作业，因此，如果要在作业计划下创建新作业，但上一个作业仍在运行，则 Batch 服务在上一个作业完成之前不会创建新作业。 如果上一个作业未在新 recurrenceInterval 的 startWindow 期间内完成，则不会计划该间隔的新作业。 对于定期作业，通常应在 jobSpecification 中指定 jobManagerTask。 如果不使用 jobManagerTask，则需要一个外部进程来监视何时创建作业、将任务添加到作业并终止作业，以便下次重复。 默认值为计划不会递归：在 doNotRunUntil 时间之后的 startWindow 中创建一个作业，并在该作业完成后立即完成计划。 最小值为 1 分钟。 如果指定了较低的值，Batch 服务将拒绝计划并显示错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 预期格式为 ISO-8601 持续时间。

--required-slots

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

--start-window

如果未在 startWindow 间隔内创建作业，则会丢失“机会”;在计划下一次重复之前，不会创建任何作业。 如果计划是定期的，并且 startWindow 比重复间隔长，则这相当于无限 startWindow，因为一个 recurrenceInterval 中“due”的作业不会转发到下一个重复间隔。 默认值为无限。 最小值为 1 分钟。 如果指定了较低的值，Batch 服务将拒绝计划并显示错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 预期格式为 ISO-8601 持续时间。

--uses-task-dependencies

作业中的任务是否可以定义彼此的依赖关系。 默认值为 false。 指定“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 job-schedule show

编辑

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

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

必需参数

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

编辑

终止作业计划。

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

必需参数

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