BatchJobUpdateOptions interface

包:

@azure-rest/batch

用于更新 Azure Batch 作业的参数。

属性

allowTaskPreemption	此作业中的任务是否可以被其他高优先级作业抢占。 （默认情况下，此属性不可用。请联系支持人员了解更多信息）如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够从此作业重新排队任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。
constraints	作业的执行约束。 如果省略，则现有执行约束保持不变。
maxParallelTasks	可为作业并行执行的最大任务数。 （默认情况下，此属性不可用。请联系支持人员了解更多信息）maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，则默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新作业的 maxParallelTasks。
metadata	与作业关联的名称/值对列表作为元数据。 如果省略，现有作业元数据保持不变。
networkConfiguration	（默认情况下，此属性不可用。请联系支持人员了解更多信息）作业的网络配置。
onAllTasksComplete	当作业中的所有任务都处于完成状态时，Batch 服务应执行的作。 如果省略，则完成行为保持不变。 不能将值从 terminatejob 更改为 noaction - 即，一旦执行了自动作业终止，则不能再次将其关闭。 如果尝试执行此作，则请求失败并出现“无效属性值”错误响应;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。 可能的值：“noaction”、“terminatejob”
poolInfo	Batch 服务在其中运行作业任务的池。 只有在禁用作业时，才能更改作业的池。 如果包括 poolInfo 元素且作业未禁用，则修补作业调用将失败。 如果在 poolInfo 中指定 autoPoolSpecification，则只能更新 autoPoolSpecification 的 keepAlive 属性，并且仅当 autoPoolSpecification 具有 Job 的 poolLifetimeOption 时（其他作业属性可以正常更新）。 如果省略，作业将继续在其当前池上运行。
priority	作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 如果省略，则作业的优先级保持不变。

属性详细信息

allowTaskPreemption

此作业中的任务是否可以被其他高优先级作业抢占。 （默认情况下，此属性不可用。请联系支持人员了解更多信息）如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够从此作业重新排队任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。

allowTaskPreemption?: boolean

属性值

boolean

constraints

作业的执行约束。 如果省略，则现有执行约束保持不变。

constraints?: BatchJobConstraints

属性值

BatchJobConstraints

maxParallelTasks

可为作业并行执行的最大任务数。 （默认情况下，此属性不可用。请联系支持人员了解更多信息）maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，则默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新作业的 maxParallelTasks。

maxParallelTasks?: number

属性值

number

metadata

与作业关联的名称/值对列表作为元数据。 如果省略，现有作业元数据保持不变。

metadata?: BatchMetadataItem[]

属性值

BatchMetadataItem[]

networkConfiguration

（默认情况下，此属性不可用。请联系支持人员了解更多信息）作业的网络配置。

networkConfiguration?: BatchJobNetworkConfiguration

属性值

BatchJobNetworkConfiguration

onAllTasksComplete

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

可能的值：“noaction”、“terminatejob”

onAllTasksComplete?: string

属性值

string

poolInfo

Batch 服务在其中运行作业任务的池。 只有在禁用作业时，才能更改作业的池。 如果包括 poolInfo 元素且作业未禁用，则修补作业调用将失败。 如果在 poolInfo 中指定 autoPoolSpecification，则只能更新 autoPoolSpecification 的 keepAlive 属性，并且仅当 autoPoolSpecification 具有 Job 的 poolLifetimeOption 时（其他作业属性可以正常更新）。 如果省略，作业将继续在其当前池上运行。

poolInfo?: BatchPoolInfo

属性值

BatchPoolInfo

priority

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

priority?: number

属性值

number