次の方法で共有


JobOperationsExtensions.TerminateAsync メソッド

定義

指定したジョブを終了し、完了としてマークします。

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 サービスは、ジョブに関連付けられている実行中のタスクを終了し、必要なジョブ リリース タスクを実行します。 その後、ジョブは完了状態に移行します。 ジョブにアクティブな状態のタスクがある場合は、アクティブな状態のままです。 ジョブが終了すると、新しいタスクを追加できず、残りのアクティブなタスクはスケジュールされません。

適用対象