Job - Terminate

Service:

Batch Service

API Version:

2023-11-01.18.0

Leállítja a megadott feladatot, és befejezettként jelöli meg.
A Feladat megszakítása kérelem fogadásakor a Batch szolgáltatás a feladatot lezáró állapotra állítja. A Batch szolgáltatás ezután leállítja a feladathoz társított futó feladatokat, és futtatja a szükséges feladatkiadási feladatokat. Ezután a feladat befejezett állapotba kerül. Ha a Feladat aktív állapotban van, azok aktív állapotban maradnak. A feladat leállása után az új tevékenységek nem vehetők fel, és a fennmaradó aktív tevékenységek nem lesznek ütemezve.

POST {batchUrl}/jobs/{jobId}/terminate?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/jobs/{jobId}/terminate?timeout={timeout}&api-version=2023-11-01.18.0

URI-paraméterek

Name	In	Kötelező	Típus	Description
batchUrl	path	True	string	Az összes Azure Batch szolgáltatáskérés alap URL-címe.
jobId	path	True	string	A leállítandó feladat azonosítója.
api-version	query	True	string	Ügyfél API-verziója.
timeout	query		integer int32	A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
client-request-id		string uuid	A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
ocp-date		string date-time-rfc1123	A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróra-időpontra állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.
If-Match		string	Az ügyfél által ismert erőforrás verziójához társított ETag-érték. A művelet csak akkor lesz végrehajtva, ha az erőforrás aktuális ETagje a szolgáltatásban pontosan megegyezik az ügyfél által megadott értékkel.
If-None-Match		string	Az ügyfél által ismert erőforrás verziójához társított ETag-érték. A művelet csak akkor lesz végrehajtva, ha az erőforrás aktuális ETagje a szolgáltatásban nem egyezik meg az ügyfél által megadott értékkel.
If-Modified-Since		string date-time-rfc1123	Az ügyfél által ismert erőforrás utolsó módosítási idejét jelző időbélyeg. A művelet csak akkor lesz végrehajtva, ha a szolgáltatásban lévő erőforrás a megadott idő óta módosult.
If-Unmodified-Since		string date-time-rfc1123	Az ügyfél által ismert erőforrás utolsó módosítási idejét jelző időbélyeg. A művelet csak akkor lesz végrehajtva, ha a szolgáltatásban lévő erőforrás nem módosult a megadott idő óta.

Kérelem törzse

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

Name	Típus	Description
terminateReason	string	A feladat befejezési idejeként megjeleníteni kívánt szöveg. Az alapértelmezett érték a "UserTerminate".

Válaszok

Name	Típus	Description
202 Accepted		A Batch szolgáltatásnak küldött kérés sikeres volt. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Authorization

Type: apiKey
In: header

Példák

Job terminate

Sample Request

HTTP

POST account.region.batch.azure.com/jobs/jobId/terminate?api-version=2023-11-01.18.0



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

Sample Response

Status code:

202

Definíciók

Name	Description
BatchError	A Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail	A Azure Batch hibaválaszban szereplő további információk egy eleme.
ErrorMessage	Hibaüzenet érkezett egy Azure Batch hibaválaszban.
JobTerminateParameter	Feladatok leállításának beállításai.

BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	ErrorMessage	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	BatchErrorDetail[]	Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.

Name	Típus	Description
key	string	Az Érték tulajdonság jelentését meghatározó azonosító.
value	string	A hibaválaszban szereplő további információk.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name	Típus	Description
lang	string	A hibaüzenet nyelvkódja
value	string	Az üzenet szövege.

JobTerminateParameter

Feladatok leállításának beállításai.

Name	Típus	Description
terminateReason	string	A feladat befejezési idejeként megjeleníteni kívánt szöveg. Az alapértelmezett érték a "UserTerminate".