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

IJobOperations.DisableWithHttpMessagesAsync 方法

定义

禁用指定的作业,从而阻止新的任务运行。

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobDisableHeaders>> DisableWithHttpMessagesAsync (string jobId, Microsoft.Azure.Batch.Protocol.Models.DisableJobOption disableTasks, Microsoft.Azure.Batch.Protocol.Models.JobDisableOptions jobDisableOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DisableWithHttpMessagesAsync : string * Microsoft.Azure.Batch.Protocol.Models.DisableJobOption * Microsoft.Azure.Batch.Protocol.Models.JobDisableOptions * 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.JobDisableHeaders>>
Public Function DisableWithHttpMessagesAsync (jobId As String, disableTasks As DisableJobOption, Optional jobDisableOptions As JobDisableOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of JobDisableHeaders))

参数

jobId
String

要禁用的作业的 ID。

disableTasks
DisableJobOption

如何处理与作业关联的活动任务。 可能的值包括:“requeue”、“terminate”、“wait”

jobDisableOptions
JobDisableOptions

操作的其他参数

customHeaders
Dictionary<String,List<String>>

将添加到请求的标头。

cancellationToken
CancellationToken

取消标记。

返回

例外

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

当所需参数为 null 时引发

注解

Batch 服务会立即将作业移动到禁用状态。 然后,Batch 使用 disableTasks 参数确定对作业当前正在运行的任务执行的操作。 作业一直处于禁用状态,直到禁用操作完成并且已根据 disableTasks 选项处理所有任务;然后,作业将进入禁用状态。 在作业移回活动状态之前,不会在作业下启动任何新任务。 如果尝试禁用处于活动、禁用或禁用状态以外的任何状态的作业,请求将失败,状态代码为 409。

适用于