JobOperationsExtensions.Terminate メソッド

定義

名前空間:

Microsoft.Azure.Batch.Protocol

アセンブリ:

Microsoft.Azure.Batch.dll

パッケージ:

Microsoft.Azure.Batch v16.2.0

ソース:

JobOperationsExtensions.cs

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

public static Microsoft.Azure.Batch.Protocol.Models.JobTerminateHeaders Terminate (this Microsoft.Azure.Batch.Protocol.IJobOperations operations, string jobId, string terminateReason = default, Microsoft.Azure.Batch.Protocol.Models.JobTerminateOptions jobTerminateOptions = default);

static member Terminate : Microsoft.Azure.Batch.Protocol.IJobOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.JobTerminateOptions -> Microsoft.Azure.Batch.Protocol.Models.JobTerminateHeaders

<Extension()>
Public Function Terminate (operations As IJobOperations, jobId As String, Optional terminateReason As String = Nothing, Optional jobTerminateOptions As JobTerminateOptions = Nothing) As JobTerminateHeaders

パラメーター

operations

IJobOperations

この拡張メソッドの操作グループ。

jobId

String

終了するジョブの ID。

terminateReason

String

ジョブの TerminateReason として表示するテキスト。 既定値は 'UserTerminate' です。

jobTerminateOptions

JobTerminateOptions

操作の追加パラメーター

戻り値

JobTerminateHeaders

注釈

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