Job - Terminate
Beendet den angegebenen Auftrag und markiert ihn als abgeschlossen.
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. Anschließend 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 Aufgaben werden nicht geplant.
POST {batchUrl}/jobs/{jobId}/terminate?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/terminate?timeout={timeout}&api-version=2023-11-01.18.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
job
|
path | True |
string |
Die ID des zu beendenden Auftrags. |
api-version
|
query | True |
string |
Client-API-Version. |
timeout
|
query |
integer int32 |
Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden. |
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 client-request-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 im Dienst genau 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 den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit dem angegebenen Zeitpunkt geändert wurde. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Ein Zeitstempel, der den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit dem angegebenen Zeitpunkt nicht mehr geändert wurde. |
Anforderungstext
Media Types: "application/json; odata=minimalmetadata"
Name | Typ | Beschreibung |
---|---|---|
terminateReason |
string |
Der Text, den Sie als TerminateReason des Auftrags anzeigen möchten. Der Standardwert ist "UserTerminate". |
Antworten
Name | Typ | Beschreibung |
---|---|---|
202 Accepted |
Die Anforderung an den Batch-Dienst war erfolgreich. Headers
|
|
Other Status Codes |
Der Fehler vom Batch-Dienst. |
Sicherheit
azure_auth
Microsoft Entra OAuth 2.0-Authentifizierungscodeflow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Authorization
Type:
apiKey
In:
header
Beispiele
Job terminate
Sample Request
POST account.region.batch.azure.com/jobs/jobId/terminate?api-version=2023-11-01.18.0
{
"terminateReason": "User supplied termination reason"
}
Sample Response
Definitionen
Name | Beschreibung |
---|---|
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde. |
Job |
Optionen beim Beenden eines Auftrags. |
BatchError
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
message |
Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler. |
BatchErrorDetail
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
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.
Name | Typ | Beschreibung |
---|---|---|
lang |
string |
Der Sprachcode der Fehlermeldung |
value |
string |
Der Text der Meldung. |
JobTerminateParameter
Optionen beim Beenden eines Auftrags.
Name | Typ | Beschreibung |
---|---|---|
terminateReason |
string |
Der Text, den Sie als TerminateReason des Auftrags anzeigen möchten. Der Standardwert ist "UserTerminate". |