BatchJobCreateOptions interface

包:

@azure-rest/batch

用于创建 Azure Batch 作业的参数。

属性

allowTaskPreemption	此作业中的任务是否可以被其他高优先级作业抢占。 （默认情况下，此属性不可用。请联系支持人员了解更多信息）如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够从此作业重新排队任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。
commonEnvironmentSettings	常见环境变量设置的列表。 为作业中的所有任务（包括作业管理器、作业准备和作业发布任务）设置这些环境变量。 单个任务可以通过使用不同的值指定相同的设置名称来替代此处指定的环境设置。
constraints	作业的执行约束。
displayName	作业的显示名称。 显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。
id	唯一标识帐户中作业的字符串。 ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是区分大小写和不区分大小写的（也就是说，帐户中可能没有两个 ID，仅大小写不同）。
jobManagerTask	启动作业时要启动的作业管理器任务的详细信息。 如果作业未指定作业管理器任务，则用户必须显式将任务添加到作业。 如果作业确实指定了作业管理器任务，Batch 服务会在创建作业时创建作业管理器任务，并将尝试在作业中计划其他任务之前计划作业管理器任务。 作业管理器任务的典型用途是控制和/或监视作业执行，例如，决定要运行的其他任务、确定工作何时完成等。但是，作业管理器任务不限于这些活动 - 它是系统中一个完全完善的任务，并执行作业所需的任何操作。例如，作业管理器任务可能会下载指定为参数的文件，分析该文件的内容，并根据这些内容提交其他任务。
jobPreparationTask	作业准备任务。 如果作业具有作业准备任务，批处理服务将在节点上运行作业准备任务，然后再在该计算节点上启动该作业的任何任务。
jobReleaseTask	作业发布任务。 如果不同时指定作业的作业准备任务，则无法指定作业发布任务。 Batch 服务在运行作业准备任务的节点上运行作业发布任务。 作业发布任务的主要用途是撤消作业准备任务对计算节点所做的更改。 示例活动包括删除本地文件或关闭在作业准备过程中启动的服务。
maxParallelTasks	可为作业并行执行的最大任务数。 （默认情况下，此属性不可用。请联系支持人员了解更多信息）maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，则默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新作业的 maxParallelTasks。
metadata	与作业关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。
networkConfiguration	（默认情况下，此属性不可用。请联系支持人员了解更多信息）作业的网络配置。
onAllTasksComplete	当作业中的所有任务都处于完成状态时，Batch 服务应执行的操作。 请注意，如果作业不包含任何任务，则所有任务都被视为已完成。 因此，此选项最常用于作业管理器任务;如果要在没有作业管理器的情况下使用自动作业终止，则应最初将 OnAllTasksComplete 设置为 noaction，并将作业属性更新为在完成添加任务后将 OnAllTasksComplete 设置为 terminatejob。 默认值为 noaction。 可能的值：“noaction”、“terminatejob”
onTaskFailure	当作业中的任何任务失败时，Batch 服务应执行的操作。 如果存在 failureInfo，则任务被视为失败。 如果任务在耗尽重试计数后使用非零退出代码完成，或者启动任务时出错（例如由于资源文件下载错误），则设置 failureInfo。 默认值为 noaction。 可能的值：“noaction”、“performexitoptionsjobaction”
poolInfo	Batch 服务在其中运行作业任务的池。
priority	作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 默认值为 0。
usesTaskDependencies	作业中的任务是否可以定义彼此的依赖关系。 默认值为 false。

属性详细信息

allowTaskPreemption

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

allowTaskPreemption?: boolean

属性值

boolean

commonEnvironmentSettings

常见环境变量设置的列表。 为作业中的所有任务（包括作业管理器、作业准备和作业发布任务）设置这些环境变量。 单个任务可以通过使用不同的值指定相同的设置名称来替代此处指定的环境设置。

commonEnvironmentSettings?: EnvironmentSetting[]

属性值

EnvironmentSetting[]

constraints

作业的执行约束。

constraints?: BatchJobConstraints

属性值

BatchJobConstraints

displayName

作业的显示名称。 显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。

displayName?: string

属性值

string

id

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

id: string

属性值

string

jobManagerTask

启动作业时要启动的作业管理器任务的详细信息。 如果作业未指定作业管理器任务，则用户必须显式将任务添加到作业。 如果作业确实指定了作业管理器任务，Batch 服务会在创建作业时创建作业管理器任务，并将尝试在作业中计划其他任务之前计划作业管理器任务。 作业管理器任务的典型用途是控制和/或监视作业执行，例如，决定要运行的其他任务、确定工作何时完成等。但是，作业管理器任务不限于这些活动 - 它是系统中一个完全完善的任务，并执行作业所需的任何操作。例如，作业管理器任务可能会下载指定为参数的文件，分析该文件的内容，并根据这些内容提交其他任务。

jobManagerTask?: BatchJobManagerTask

属性值

BatchJobManagerTask

jobPreparationTask

作业准备任务。 如果作业具有作业准备任务，批处理服务将在节点上运行作业准备任务，然后再在该计算节点上启动该作业的任何任务。

jobPreparationTask?: BatchJobPreparationTask

属性值

BatchJobPreparationTask

jobReleaseTask

作业发布任务。 如果不同时指定作业的作业准备任务，则无法指定作业发布任务。 Batch 服务在运行作业准备任务的节点上运行作业发布任务。 作业发布任务的主要用途是撤消作业准备任务对计算节点所做的更改。 示例活动包括删除本地文件或关闭在作业准备过程中启动的服务。

jobReleaseTask?: BatchJobReleaseTask

属性值

BatchJobReleaseTask

maxParallelTasks

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

maxParallelTasks?: number

属性值

number

metadata

与作业关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。

metadata?: BatchMetadataItem[]

属性值

BatchMetadataItem[]

networkConfiguration

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

networkConfiguration?: BatchJobNetworkConfiguration

属性值

BatchJobNetworkConfiguration

onAllTasksComplete

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

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

onAllTasksComplete?: string

属性值

string

onTaskFailure

当作业中的任何任务失败时，Batch 服务应执行的操作。 如果存在 failureInfo，则任务被视为失败。 如果任务在耗尽重试计数后使用非零退出代码完成，或者启动任务时出错（例如由于资源文件下载错误），则设置 failureInfo。 默认值为 noaction。

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

onTaskFailure?: string

属性值

string

poolInfo

Batch 服务在其中运行作业任务的池。

poolInfo: BatchPoolInfo

属性值

BatchPoolInfo

priority

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

priority?: number

属性值

number

usesTaskDependencies

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

usesTaskDependencies?: boolean

属性值

boolean