Job - Terminate

Service:

Batch Service

API Version:

2023-11-01.18.0

Hiermee beëindigt u de opgegeven taak en markeert deze als voltooid.
Wanneer een aanvraag voor het beëindigen van de taak wordt ontvangen, stelt de Batch-service de taak in op de eindstatus. De Batch-service beëindigt vervolgens alle actieve taken die aan de taak zijn gekoppeld en voert alle vereiste taakreleasetaken uit. Vervolgens wordt de taak verplaatst naar de status Voltooid. Als er taken in de taak met de actieve status zijn, blijven deze in de actieve status. Zodra een taak is beëindigd, kunnen er geen nieuwe taken meer worden toegevoegd en worden resterende actieve taken niet meer gepland.

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-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
jobId	path	True	string	De id van de taak die moet worden beëindigd.
api-version	query	True	string	Client-API-versie.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel deze expliciet in als u de REST API rechtstreeks aanroept.
If-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service exact overeenkomt met de waarde die is opgegeven door de client.
If-None-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service niet overeenkomt met de waarde die is opgegeven door de client.
If-Modified-Since		string date-time-rfc1123	Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource in de service sinds het opgegeven tijdstip is gewijzigd.
If-Unmodified-Since		string date-time-rfc1123	Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource in de service niet is gewijzigd sinds het opgegeven tijdstip.

Aanvraagbody

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

Name	Type	Description
terminateReason	string	De tekst die u wilt weergeven als TerminateReason van de taak. De standaardwaarde is 'UserTerminate'.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag voor de Batch-service is geslaagd. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
BatchError	Een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch foutbericht.
JobTerminateParameter	Opties bij het beëindigen van een taak.

BatchError

Een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch foutbericht.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

JobTerminateParameter

Opties bij het beëindigen van een taak.

Name	Type	Description
terminateReason	string	De tekst die u wilt weergeven als TerminateReason van de taak. De standaardwaarde is 'UserTerminate'.