你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Task class
表示 Task 的类。
构造函数
| Task(Batch |
创建任务。 |
方法
构造函数详细信息
Task(BatchServiceClientContext)
方法详细信息
add(string, TaskAddParameter, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, callback: ServiceCallback<void>)参数
- jobId
-
string
任务要添加到的作业的 ID。
- task
- TaskAddParameter
要添加的任务。
- callback
-
ServiceCallback<void>
回调
add(string, TaskAddParameter, TaskAddOptionalParams)
任务从添加到完成的最长生存期为 180 天。 如果任务在添加后的 180 天内尚未完成，Batch 服务将终止该任务，并保留其当时处于的任何状态。
function add(jobId: string, task: TaskAddParameter, options?: TaskAddOptionalParams): Promise<TaskAddResponse>参数
- jobId
-
string
任务要添加到的作业的 ID。
- task
- TaskAddParameter
要添加的任务。
- options
- TaskAddOptionalParams
可选参数
返回
Promise<TaskAddResponse>
Promise<Models.TaskAddResponse>
add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, options: TaskAddOptionalParams, callback: ServiceCallback<void>)参数
- jobId
-
string
任务要添加到的作业的 ID。
- task
- TaskAddParameter
要添加的任务。
- options
- TaskAddOptionalParams
可选参数
- callback
-
ServiceCallback<void>
回调
addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], callback: ServiceCallback<TaskAddCollectionResult>)参数
- jobId
-
string
要向其添加 Task 集合的作业的 ID。
- value
要添加的任务集合。 任务的最大计数为 100。 此集合的总序列化大小必须小于 1MB。 如果它大于 1MB (例如，如果每个任务具有 100 个资源文件或环境变量) ，则请求将失败并显示代码“RequestBodyTooLarge”，并应重试并包含较少任务。
- callback
回调
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)
请注意，每个任务必须具有唯一的 ID。 Batch 服务可能不会按在此请求中提交任务的顺序返回每个任务的结果。 如果服务器在请求期间超时或连接关闭，则请求可能已部分或完全处理，或者根本不处理。 在这种情况下，用户应该重新发出该请求。 请注意，重新发出请求时，用户应正确处理故障。 例如，在重试期间应使用相同的任务 ID，以便如果上一个操作成功，重试不会意外创建额外的任务。 如果响应包含任何未能添加的任务，客户端可以重试请求。 在重试中，最高效的是仅重新提交未能添加的任务，并省略第一次尝试时已成功添加的任务。 任务从添加到完成的最长生存期为 180 天。 如果任务在添加后的 180 天内尚未完成，Batch 服务将终止该任务，并保留其当时处于的任何状态。
function addCollection(jobId: string, value: TaskAddParameter[], options?: TaskAddCollectionOptionalParams): Promise<TaskAddCollectionResponse>参数
- jobId
-
string
要向其添加 Task 集合的作业的 ID。
- value
要添加的任务集合。 任务的最大计数为 100。 此集合的总序列化大小必须小于 1MB。 如果它大于 1MB (例如，如果每个任务具有 100 个资源文件或环境变量) ，则请求将失败并显示代码“RequestBodyTooLarge”，并应重试并包含较少任务。
- options
- TaskAddCollectionOptionalParams
可选参数
返回
Promise<TaskAddCollectionResponse>
Promise<Models.TaskAddCollectionResponse>
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], options: TaskAddCollectionOptionalParams, callback: ServiceCallback<TaskAddCollectionResult>)参数
- jobId
-
string
要向其添加 Task 集合的作业的 ID。
- value
要添加的任务的集合。 任务的最大计数为 100。 此集合的总序列化大小必须小于 1MB。 如果大于 1MB (例如，如果每个任务有 100 个资源文件或环境变量) ，则请求将失败并显示代码“RequestBodyTooLarge”，并且应再次重试且任务数较少。
- options
- TaskAddCollectionOptionalParams
可选参数
- callback
回调
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, callback: ServiceCallback<void>)参数
- jobId
-
string
要从中删除任务的作业的 ID。
- taskId
-
string
要删除的任务的 ID。
- callback
-
ServiceCallback<void>
回调
deleteMethod(string, string, TaskDeleteMethodOptionalParams)
删除任务时，无论保留时间) 如何，任务在运行它的计算节点上的目录中的所有文件也会 (被删除。 对于多实例任务，删除任务操作同步应用于主任务;然后，子任务及其文件在后台异步删除。
function deleteMethod(jobId: string, taskId: string, options?: TaskDeleteMethodOptionalParams): Promise<TaskDeleteResponse>参数
- jobId
-
string
要从中删除任务的作业的 ID。
- taskId
-
string
要删除的任务的 ID。
- options
- TaskDeleteMethodOptionalParams
可选参数
返回
Promise<TaskDeleteResponse>
Promise<Models.TaskDeleteResponse>
deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, options: TaskDeleteMethodOptionalParams, callback: ServiceCallback<void>)参数
- jobId
-
string
要从中删除任务的作业的 ID。
- taskId
-
string
要删除的任务的 ID。
- options
- TaskDeleteMethodOptionalParams
可选参数
- callback
-
ServiceCallback<void>
回调
get(string, string, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, callback: ServiceCallback<CloudTask>)参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要获取其相关信息的任务的 ID。
- callback
回调
get(string, string, TaskGetOptionalParams)
对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息引用主任务。 使用列表子任务 API 检索有关子任务的信息。
function get(jobId: string, taskId: string, options?: TaskGetOptionalParams): Promise<TaskGetResponse>参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要获取其相关信息的任务的 ID。
- options
- TaskGetOptionalParams
可选参数
返回
Promise<TaskGetResponse>
Promise<Models.TaskGetResponse>
get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, options: TaskGetOptionalParams, callback: ServiceCallback<CloudTask>)参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要获取其相关信息的任务的 ID。
- options
- TaskGetOptionalParams
可选参数
- callback
回调
list(string, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, callback: ServiceCallback<CloudTaskListResult>)参数
- jobId
-
string
作业的 ID。
- callback
回调
list(string, TaskListOptionalParams)
对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息引用主任务。 使用列表子任务 API 检索有关子任务的信息。
function list(jobId: string, options?: TaskListOptionalParams): Promise<TaskListResponse>参数
- jobId
-
string
作业的 ID。
- options
- TaskListOptionalParams
可选参数
返回
Promise<TaskListResponse>
Promise<Models.TaskListResponse>
list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, options: TaskListOptionalParams, callback: ServiceCallback<CloudTaskListResult>)参数
- jobId
-
string
作业的 ID。
- options
- TaskListOptionalParams
可选参数
- callback
回调
listNext(string, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudTaskListResult>)参数
- nextPageLink
-
string
上一次成功调用 List 操作的 NextLink。
- callback
回调
listNext(string, TaskListNextOptionalParams)
对于多实例任务，affinityId、executionInfo 和 nodeInfo 等信息引用主任务。 使用列表子任务 API 检索有关子任务的信息。
function listNext(nextPageLink: string, options?: TaskListNextOptionalParams): Promise<TaskListResponse>参数
- nextPageLink
-
string
上一次成功调用 List 操作的 NextLink。
- options
- TaskListNextOptionalParams
可选参数
返回
Promise<TaskListResponse>
Promise<Models.TaskListResponse>
listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, options: TaskListNextOptionalParams, callback: ServiceCallback<CloudTaskListResult>)参数
- nextPageLink
-
string
上一次成功调用 List 操作的 NextLink。
- options
- TaskListNextOptionalParams
可选参数
- callback
回调
listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, callback: ServiceCallback<CloudTaskListSubtasksResult>)参数
- jobId
-
string
作业的 ID。
- taskId
-
string
任务的 ID。
- callback
回调
listSubtasks(string, string, TaskListSubtasksOptionalParams)
如果 Task 不是多实例 Task，则返回空集合。
function listSubtasks(jobId: string, taskId: string, options?: TaskListSubtasksOptionalParams): Promise<TaskListSubtasksResponse>参数
- jobId
-
string
作业的 ID。
- taskId
-
string
任务的 ID。
- options
- TaskListSubtasksOptionalParams
可选参数
返回
Promise<TaskListSubtasksResponse>
Promise<Models.TaskListSubtasksResponse>
listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, options: TaskListSubtasksOptionalParams, callback: ServiceCallback<CloudTaskListSubtasksResult>)参数
- jobId
-
string
作业的 ID。
- taskId
-
string
任务的 ID。
- options
- TaskListSubtasksOptionalParams
可选参数
- callback
回调
reactivate(string, string, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, callback: ServiceCallback<void>)参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要重新激活的任务的 ID。
- callback
-
ServiceCallback<void>
回调
reactivate(string, string, TaskReactivateOptionalParams)
重新激活使任务有资格再次重试，达到其最大重试次数。 任务的状态更改为活动状态。 由于任务不再处于已完成状态，因此重新激活后，任何以前的退出代码或失败信息都不再可用。 每次重新激活任务时，其重试计数将重置为 0。 对于未完成或以前成功完成的任务，重新激活将失败， (退出代码为 0) 。 此外，如果作业已完成 (或正在终止或删除) ，它将失败。
function reactivate(jobId: string, taskId: string, options?: TaskReactivateOptionalParams): Promise<TaskReactivateResponse>参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要重新激活的任务的 ID。
- options
- TaskReactivateOptionalParams
可选参数
返回
Promise<TaskReactivateResponse>
Promise<Models.TaskReactivateResponse>
reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, options: TaskReactivateOptionalParams, callback: ServiceCallback<void>)参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要重新激活的任务的 ID。
- options
- TaskReactivateOptionalParams
可选参数
- callback
-
ServiceCallback<void>
回调
terminate(string, string, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, callback: ServiceCallback<void>)参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要终止的任务的 ID。
- callback
-
ServiceCallback<void>
回调
terminate(string, string, TaskTerminateOptionalParams)
任务终止后，会进入已完成状态。 对于多实例任务，终止 Task 操作同步应用于主任务;然后，子任务在后台异步终止。
function terminate(jobId: string, taskId: string, options?: TaskTerminateOptionalParams): Promise<TaskTerminateResponse>参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要终止的任务的 ID。
- options
- TaskTerminateOptionalParams
可选参数
返回
Promise<TaskTerminateResponse>
Promise<Models.TaskTerminateResponse>
terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, options: TaskTerminateOptionalParams, callback: ServiceCallback<void>)参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要终止的任务的 ID。
- options
- TaskTerminateOptionalParams
可选参数
- callback
-
ServiceCallback<void>
回调
update(string, string, ServiceCallback<void>)
function update(jobId: string, taskId: string, callback: ServiceCallback<void>)参数
- jobId
-
string
包含 Task 的作业的 ID。
- taskId
-
string
要更新的任务的 ID。
- callback
-
ServiceCallback<void>
回调
update(string, string, TaskUpdateOptionalParams)
汇报指定 Task 的属性。
function update(jobId: string, taskId: string, options?: TaskUpdateOptionalParams): Promise<TaskUpdateResponse>参数
- jobId
-
string
包含任务的作业的 ID。
- taskId
-
string
要更新的任务的 ID。
- options
- TaskUpdateOptionalParams
可选参数
返回
Promise<TaskUpdateResponse>
Promise<Models.TaskUpdateResponse>
update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)
function update(jobId: string, taskId: string, options: TaskUpdateOptionalParams, callback: ServiceCallback<void>)参数
- jobId
-
string
包含任务的作业的 ID。
- taskId
-
string
要更新的任务的 ID。
- options
- TaskUpdateOptionalParams
可选参数
- callback
-
ServiceCallback<void>
回调