你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

IJobOperations.TerminateWithHttpMessagesAsync 方法

定义

终止指定的作业,将其标记为已完成。

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobTerminateHeaders>> TerminateWithHttpMessagesAsync (string jobId, string terminateReason = default, Microsoft.Azure.Batch.Protocol.Models.JobTerminateOptions jobTerminateOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member TerminateWithHttpMessagesAsync : string * string * Microsoft.Azure.Batch.Protocol.Models.JobTerminateOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobTerminateHeaders>>
Public Function TerminateWithHttpMessagesAsync (jobId As String, Optional terminateReason As String = Nothing, Optional jobTerminateOptions As JobTerminateOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of JobTerminateHeaders))

参数

jobId
String

要终止的作业的 ID。

terminateReason
String

要显示为作业的 TerminateReason 的文本。 默认值为“UserTerminate”。

jobTerminateOptions
JobTerminateOptions

操作的其他参数

customHeaders
Dictionary<String,List<String>>

将添加到请求的标头。

cancellationToken
CancellationToken

取消标记。

返回

例外

操作返回无效状态代码时引发

当所需的参数为 null 时引发

注解

收到终止作业请求时,Batch 服务会将作业设置为终止状态。 然后,Batch 服务将终止与作业关联的任何正在运行的任务,并运行任何所需的作业发布任务。 然后,作业进入已完成状态。 如果作业中有任何任务处于活动状态,它们将保持活动状态。 作业终止后,无法添加新任务,并且不会计划任何剩余的活动任务。

适用于