JobOperationsExtensions.TerminateAsync Methode

Referenz

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Paket:: Microsoft.Azure.Batch v16.2.0

Quelle:: JobOperationsExtensions.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Beendet den angegebenen Auftrag und markiert ihn als abgeschlossen.

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)

Parameter

operations: IJobOperations

Die Vorgangsgruppe für diese Erweiterungsmethode.

jobId: String

Die ID des zu beendenden Auftrags.

terminateReason: String

Der Text, den Sie als TerminateReason des Auftrags anzeigen möchten. Der Standardwert ist "UserTerminate".

jobTerminateOptions: JobTerminateOptions

Zusätzliche Parameter für den Vorgang

cancellationToken: CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<JobTerminateHeaders>

Hinweise

Wenn eine Anforderung zum Beenden von Aufträgen empfangen wird, legt der Batch-Dienst den Auftrag auf den Status "Beenden" fest. Der Batch-Dienst beendet dann alle ausgeführten Aufgaben, die dem Auftrag zugeordnet sind, und führt alle erforderlichen Auftragsfreigabetasks aus. Dann wechselt der Auftrag in den Status Abgeschlossen. Wenn aufgaben im Status "Aktiv" vorhanden sind, verbleiben diese im aktiven Zustand. Sobald ein Auftrag beendet wurde, können keine neuen Aufgaben hinzugefügt werden, und alle verbleibenden aktiven Tasks werden nicht geplant.

Gilt für:

Freigeben über