az batch job

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

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

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

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

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

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

作业管理器任务的命令行。 命令行未在 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.

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

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

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

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

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

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

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

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

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

现有池的 ID。 作业的所有任务都将在指定的池上运行。 必须确保此属性引用的池存在。 如果 Batch 服务尝试计划作业时池不存在，则在创建具有该 ID 的池之前，不会运行该作业的任务。请注意，Batch 服务不会拒绝作业请求;它只会在池存在之前不运行任务。 必须指定池 ID 或自动池规范，但不能同时指定这两者。

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

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

作业中的任务是否可以定义彼此的依赖关系。 默认值为 false。 如此 如果存在标志。

要删除的作业的 ID。 Required.

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

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

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

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

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

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

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

不要提示确认。

要禁用的作业的 ID。 Required.

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

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

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

对与作业关联的活动任务执行的操作。 Required. 已知值为：“requeue”、“terminate”和“wait”。

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

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

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

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

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

要启用的作业的 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://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch。

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

OData $select 子句。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

当作业中的所有任务都处于完成状态时，Batch 服务应执行的操作。 默认值为 noaction。 已知值为：“noaction”和“terminatejob”。

现有池的 ID。 作业的所有任务都将在指定的池上运行。 必须确保此属性引用的池存在。 如果 Batch 服务尝试计划作业时池不存在，则在创建具有该 ID 的池之前，不会运行该作业的任务。请注意，Batch 服务不会拒绝作业请求;它只会在池存在之前不运行任务。 必须指定池 ID 或自动池规范，但不能同时指定这两者。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

与作业关联的名称/值对列表作为元数据。 如果省略，现有作业元数据保持不变。 以“key=value”格式分隔的空间值。

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

现有池的 ID。 作业的所有任务都将在指定的池上运行。 必须确保此属性引用的池存在。 如果 Batch 服务尝试计划作业时池不存在，则在创建具有该 ID 的池之前，不会运行该作业的任务。请注意，Batch 服务不会拒绝作业请求;它只会在池存在之前不运行任务。 必须指定池 ID 或自动池规范，但不能同时指定这两者。

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

作业的 ID。 Required.

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

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

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

OData $expand 子句。

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

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

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

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

OData $select 子句。

要终止的作业的 ID。 Required.

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

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

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

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

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

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

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

终止原因。

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