Job - Terminate
Avslutar det angivna jobbet och markerar det som slutfört.
När en begäran om att avsluta jobb tas emot anger Batch-tjänsten jobbet till sluttillståndet. Batch-tjänsten avslutar sedan alla aktiviteter som körs som är associerade med jobbet och kör alla nödvändiga uppgifter för jobblansering. Sedan flyttas jobbet till slutfört tillstånd. Om det finns några aktiviteter i jobbet i aktivt tillstånd förblir de i aktivt tillstånd. När ett jobb har avslutats går det inte att lägga till nya aktiviteter och eventuella återstående aktiva aktiviteter schemaläggs inte.
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-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Bas-URL:en för alla Azure Batch tjänstbegäranden. |
job
|
path | True |
string |
ID:t för jobbet som ska avslutas. |
api-version
|
query | True |
string |
Klient-API-version. |
timeout
|
query |
integer int32 |
Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. |
Begärandehuvud
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
client-request-id |
string uuid |
Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Om servern ska returnera klient-request-id i svaret. |
|
ocp-date |
string date-time-rfc1123 |
Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt. |
|
If-Match |
string |
Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten exakt matchar det värde som anges av klienten. |
|
If-None-Match |
string |
Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten inte matchar det värde som anges av klienten. |
|
If-Modified-Since |
string date-time-rfc1123 |
En tidsstämpel som anger den senast ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten har ändrats sedan den angivna tiden. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
En tidsstämpel som anger den senast ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten inte har ändrats sedan den angivna tiden. |
Begärandetext
Media Types: "application/json; odata=minimalmetadata"
Name | Typ | Description |
---|---|---|
terminateReason |
string |
Texten som du vill ska visas som jobbets TerminateReason. Standardvärdet är "UserTerminate". |
Svar
Name | Typ | Description |
---|---|---|
202 Accepted |
Begäran till Batch-tjänsten lyckades. Headers
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Microsoft Entra autentiseringskodflöde för OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Authorization
Type:
apiKey
In:
header
Exempel
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
Definitioner
Name | Description |
---|---|
Batch |
Ett felsvar som tagits emot från Azure Batch-tjänsten. |
Batch |
Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar. |
Error |
Ett felmeddelande som togs emot i ett Azure Batch felsvar. |
Job |
Alternativ när du avslutar ett jobb. |
BatchError
Ett felsvar som tagits emot från Azure Batch-tjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt. |
message |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
|
values |
En samling nyckel/värde-par som innehåller ytterligare information om felet. |
BatchErrorDetail
Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
Name | Typ | Description |
---|---|---|
key |
string |
En identifierare som anger innebörden av egenskapen Value. |
value |
string |
Den ytterligare information som ingår i felsvaret. |
ErrorMessage
Ett felmeddelande som togs emot i ett Azure Batch felsvar.
Name | Typ | Description |
---|---|---|
lang |
string |
Språkkoden för felmeddelandet |
value |
string |
Texten i meddelandet. |
JobTerminateParameter
Alternativ när du avslutar ett jobb.
Name | Typ | Description |
---|---|---|
terminateReason |
string |
Texten som du vill ska visas som jobbets TerminateReason. Standardvärdet är "UserTerminate". |