Job - Terminate

Dienst:

Batch Service

API-Version:

2024-07-01.20.0

Beendet den angegebenen Auftrag und markiert ihn als abgeschlossen.
Wenn eine Terminierungsauftragsanforderung empfangen wird, legt der Batchdienst den Auftrag auf den Beendigungszustand fest. Der Batchdienst beendet dann alle ausgeführten Aufgaben, die dem Auftrag zugeordnet sind, und führt alle erforderlichen Aufgaben für die Auftragsfreigabe aus. Anschließend wechselt der Auftrag in den abgeschlossenen Zustand. Wenn der Auftrag im aktiven Zustand enthalten ist, verbleiben sie im aktiven Zustand. Nachdem ein Auftrag beendet wurde, können keine neuen Vorgänge hinzugefügt werden, und alle verbleibenden aktiven Vorgänge werden nicht geplant.

POST {batchUrl}/jobs/{jobId}/terminate?api-version=2024-07-01.20.0

Mit optionalen Parametern:

POST {batchUrl}/jobs/{jobId}/terminate?timeout={timeout}&force={force}&api-version=2024-07-01.20.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
jobId	path	True	string	Die ID des zu beendenden Auftrags.
api-version	query	True	string	Client-API-Version.
force	query		boolean	Wenn true, beendet der Server den Auftrag, auch wenn die entsprechenden Knoten die Beendigung nicht vollständig verarbeitet haben. Der Standardwert ist "false".
timeout	query		integer (int32)	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

Anforderungsheader

Media Types: "application/json; odata=minimalmetadata"

Name	Erforderlich	Typ	Beschreibung
client-request-id		string (uuid)	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date		string (date-time-rfc1123)	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.
If-Match		string	Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst exakt mit dem vom Client angegebenen Wert übereinstimmt.
If-None-Match		string	Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst nicht mit dem vom Client angegebenen Wert übereinstimmt.
If-Modified-Since		string (date-time-rfc1123)	Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt geändert wurde.
If-Unmodified-Since		string (date-time-rfc1123)	Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt nicht geändert wurde.

Anforderungstext

Media Types: "application/json; odata=minimalmetadata"

Name	Typ	Beschreibung
terminateReason	string	Der Text, der als TerminateReason des Auftrags angezeigt werden soll. Der Standardwert ist "UserTerminate".

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung an den Batchdienst war erfolgreich. Header client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Job terminate

Beispielanforderung

HTTP

POST account.region.batch.azure.com/jobs/jobId/terminate?api-version=2024-07-01.20.0



{
  "terminateReason": "User supplied termination reason"
}

Beispiel für eine Antwort

Statuscode:

202

Definitionen

Name	Beschreibung
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
JobTerminateParameter	Optionen beim Beenden eines Auftrags.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Objekt

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

ErrorMessage

Objekt

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung
value	string	Der Text der Nachricht.

JobTerminateParameter

Objekt

Optionen beim Beenden eines Auftrags.

Name	Typ	Beschreibung
terminateReason	string	Der Text, der als TerminateReason des Auftrags angezeigt werden soll. Der Standardwert ist "UserTerminate".