你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
JobOperationsExtensions.TerminateAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
终止指定的作业,将其标记为已完成。
public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobTerminateHeaders> TerminateAsync (this Microsoft.Azure.Batch.Protocol.IJobOperations operations, string jobId, string terminateReason = default, Microsoft.Azure.Batch.Protocol.Models.JobTerminateOptions jobTerminateOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member TerminateAsync : Microsoft.Azure.Batch.Protocol.IJobOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.JobTerminateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobTerminateHeaders>
<Extension()>
Public Function TerminateAsync (operations As IJobOperations, jobId As String, Optional terminateReason As String = Nothing, Optional jobTerminateOptions As JobTerminateOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of JobTerminateHeaders)
参数
- operations
- IJobOperations
此扩展方法的操作组。
- jobId
- String
要终止的作业的 ID。
- terminateReason
- String
要显示为作业的 TerminateReason 的文本。 默认值为“UserTerminate”。
- jobTerminateOptions
- JobTerminateOptions
操作的其他参数
- cancellationToken
- CancellationToken
取消标记。
返回
注解
收到终止作业请求时,Batch 服务会将作业设置为终止状态。 然后,Batch 服务终止与作业关联的任何正在运行的任务,并运行任何所需的作业发布任务。 然后,作业将进入已完成状态。 如果作业中有任何任务处于活动状态,它们将保持活动状态。 作业终止后,无法添加新任务,并且不会计划任何剩余的活动任务。