BatchJobOutput interface

包:

@azure-rest/batch

Azure Batch 作业。

属性

allowTaskPreemption	此作业中的任务是否可以被其他高优先级作业抢占。 （默认情况下，此属性不可用。请联系支持人员了解更多信息）如果该值设置为 True，则提交到系统的其他高优先级作业将优先，并且能够从此作业重新排队任务。 使用更新作业 API 创建作业后，可以更新作业的 allowTaskPreemption。
commonEnvironmentSettings	常见环境变量设置的列表。 为作业中的所有任务（包括作业管理器、作业准备和作业发布任务）设置这些环境变量。 单个任务可以通过使用不同的值指定相同的设置名称来替代此处指定的环境设置。
constraints	作业的执行约束。
creationTime	作业的创建时间。
displayName	作业的显示名称。
eTag	作业的 ETag。 这是一个不透明的字符串。 可以使用它来检测作业是否在请求之间发生了更改。 具体而言，可以在更新作业时传递 ETag，以指定只有在其他人同时没有修改作业时，更改才会生效。
executionInfo	作业的执行信息。
id	唯一标识帐户中作业的字符串。 ID 是区分大小写和不区分大小写的（也就是说，帐户中可能没有两个 ID，仅大小写不同）。
jobManagerTask	启动作业时要启动的作业管理器任务的详细信息。
jobPreparationTask	作业准备任务。 作业准备任务是在作业的任何其他任务之前在每个计算节点上运行的特殊任务。
jobReleaseTask	作业发布任务。 作业发布任务是在每个运行作业的任何其他任务的计算节点上作业结束时运行的特殊任务。
lastModified	作业的上次修改时间。 这是作业级别数据（如作业状态或优先级）上次更改的时间。 它不考虑任务级更改，例如添加新的任务或任务更改状态。
maxParallelTasks	可为作业并行执行的最大任务数。 （默认情况下，此属性不可用。请联系支持人员了解更多信息）maxParallelTasks 的值必须为 -1 或大于 0（如果指定）。 如果未指定，则默认值为 -1，这意味着一次可以运行的任务数没有限制。 使用更新作业 API 创建作业后，可以更新作业的 maxParallelTasks。
metadata	与作业关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。
networkConfiguration	（默认情况下，此属性不可用。请联系支持人员了解更多信息）作业的网络配置。
onAllTasksComplete	当作业中的所有任务都处于完成状态时，Batch 服务应执行的操作。 默认值为 noaction。 可能的值：“noaction”、“terminatejob”
onTaskFailure	当作业中的任何任务失败时，Batch 服务应执行的操作。 如果存在 failureInfo，则任务被视为失败。 如果任务在耗尽重试计数后使用非零退出代码完成，或者启动任务时出错（例如由于资源文件下载错误），则设置 failureInfo。 默认值为 noaction。 可能的值：“noaction”、“performexitoptionsjobaction”
poolInfo	与作业关联的池设置。
previousState	作业的上一个状态。 如果作业处于初始活动状态，则不会设置此属性。 可能的值：“active”、“disableing”、“disabled”、“enabling”、“terminating”、“completed”、“删除”
previousStateTransitionTime	作业进入其上一状态的时间。 如果作业处于初始活动状态，则不会设置此属性。
priority	作业的优先级。 优先级值的范围可以是 -1000 到 1000，-1000 是最低优先级，1000 是最高优先级。 默认值为 0。
state	作业的当前状态。 可能的值：“active”、“disableing”、“disabled”、“enabling”、“terminating”、“completed”、“删除”
stateTransitionTime	作业进入其当前状态的时间。
stats	作业整个生存期的资源使用情况统计信息。 仅当使用包含“stats”属性的 expand 子句检索 BatchJob 时，才会填充此属性;否则为 null。 统计信息可能不会立即可用。 Batch 服务执行统计信息的定期汇总。 典型的延迟约为 30 分钟。
url	作业的 URL。
usesTaskDependencies	作业中的任务是否可以定义彼此的依赖关系。 默认值为 false。

属性详细信息

allowTaskPreemption

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

allowTaskPreemption?: boolean

属性值

boolean

commonEnvironmentSettings

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

commonEnvironmentSettings?: EnvironmentSettingOutput[]

属性值

EnvironmentSettingOutput[]

constraints

作业的执行约束。

constraints?: BatchJobConstraintsOutput

属性值

BatchJobConstraintsOutput

creationTime

作业的创建时间。

creationTime: string

属性值

string

displayName

作业的显示名称。

displayName?: string

属性值

string

eTag

作业的 ETag。 这是一个不透明的字符串。 可以使用它来检测作业是否在请求之间发生了更改。 具体而言，可以在更新作业时传递 ETag，以指定只有在其他人同时没有修改作业时，更改才会生效。

eTag: string

属性值

string

executionInfo

作业的执行信息。

executionInfo?: BatchJobExecutionInfoOutput

属性值

BatchJobExecutionInfoOutput

id

唯一标识帐户中作业的字符串。 ID 是区分大小写和不区分大小写的（也就是说，帐户中可能没有两个 ID，仅大小写不同）。

id: string

属性值

string

jobManagerTask

启动作业时要启动的作业管理器任务的详细信息。

jobManagerTask?: BatchJobManagerTaskOutput

属性值

BatchJobManagerTaskOutput

jobPreparationTask

作业准备任务。 作业准备任务是在作业的任何其他任务之前在每个计算节点上运行的特殊任务。

jobPreparationTask?: BatchJobPreparationTaskOutput

属性值

BatchJobPreparationTaskOutput

jobReleaseTask

作业发布任务。 作业发布任务是在每个运行作业的任何其他任务的计算节点上作业结束时运行的特殊任务。

jobReleaseTask?: BatchJobReleaseTaskOutput

属性值

BatchJobReleaseTaskOutput

lastModified

作业的上次修改时间。 这是作业级别数据（如作业状态或优先级）上次更改的时间。 它不考虑任务级更改，例如添加新的任务或任务更改状态。

lastModified: string

属性值

string

maxParallelTasks

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

maxParallelTasks?: number

属性值

number

metadata

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

metadata?: BatchMetadataItemOutput[]

属性值

BatchMetadataItemOutput[]

networkConfiguration

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

networkConfiguration?: BatchJobNetworkConfigurationOutput

属性值

BatchJobNetworkConfigurationOutput

onAllTasksComplete

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

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

onAllTasksComplete?: string

属性值

string

onTaskFailure

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

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

onTaskFailure?: string

属性值

string

poolInfo

与作业关联的池设置。

poolInfo: BatchPoolInfoOutput

属性值

BatchPoolInfoOutput

previousState

作业的上一个状态。 如果作业处于初始活动状态，则不会设置此属性。

可能的值：“active”、“disableing”、“disabled”、“enabling”、“terminating”、“completed”、“删除”

previousState?: string

属性值

string

previousStateTransitionTime

作业进入其上一状态的时间。 如果作业处于初始活动状态，则不会设置此属性。

previousStateTransitionTime?: string

属性值

string

priority

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

priority?: number

属性值

number

state

作业的当前状态。

可能的值：“active”、“disableing”、“disabled”、“enabling”、“terminating”、“completed”、“删除”

state: string

属性值

string

stateTransitionTime

作业进入其当前状态的时间。

stateTransitionTime: string

属性值

string

stats

作业整个生存期的资源使用情况统计信息。 仅当使用包含“stats”属性的 expand 子句检索 BatchJob 时，才会填充此属性;否则为 null。 统计信息可能不会立即可用。 Batch 服务执行统计信息的定期汇总。 典型的延迟约为 30 分钟。

stats?: BatchJobStatisticsOutput

属性值

BatchJobStatisticsOutput

url

作业的 URL。

url: string

属性值

string

usesTaskDependencies

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

usesTaskDependencies?: boolean

属性值

boolean