Job - Terminate

Service:

Batch Service

API Version:

2023-11-01.18.0

Termina il processo specificato, contrassegnandolo come completato.
Quando viene ricevuta una richiesta di processo termina, il servizio Batch imposta il processo sullo stato di terminazione. Il servizio Batch termina quindi qualsiasi attività in esecuzione associata al processo ed esegue tutte le attività necessarie per la versione del processo. Il processo viene quindi spostato nello stato completato. Se nel processo sono presenti attività nello stato attivo, rimarranno nello stato attivo. Una volta terminato un processo, non è possibile aggiungere nuove attività e le attività attive rimanenti non verranno pianificate.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste di servizio Azure Batch.
jobId	path	True	string	ID del processo da terminare.
api-version	query	True	string	Versione dell'API client.
timeout	query		integer int32	Tempo massimo per cui il server può trascorrere l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string uuid	Identità richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50E-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se il server deve restituire l'ID richiesta client nella risposta.
ocp-date		string date-time-rfc1123	Ora in cui è stata eseguita la richiesta. Le librerie client in genere impostano l'ora dell'orologio del sistema corrente; impostarla in modo esplicito se si chiama direttamente l'API REST.
If-Match		string	Valore ETag associato alla versione della risorsa nota al client. L'operazione verrà eseguita solo se l'ETag corrente della risorsa nel servizio corrisponde esattamente al valore specificato dal client.
If-None-Match		string	Valore ETag associato alla versione della risorsa nota al client. L'operazione verrà eseguita solo se l'ETag corrente della risorsa nel servizio non corrisponde al valore specificato dal client.
If-Modified-Since		string date-time-rfc1123	Timestamp che indica l'ultima ora modificata della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio è stata modificata dall'ora specificata.
If-Unmodified-Since		string date-time-rfc1123	Timestamp che indica l'ultima ora modificata della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio non è stata modificata dopo l'ora specificata.

Corpo della richiesta

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

Nome	Tipo	Descrizione
terminateReason	string	Testo che si vuole visualizzare come TerminaReason del processo. Il valore predefinito è "UserTerminate".

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta al servizio Batch ha avuto esito positivo. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Errore dal servizio Batch.

Sicurezza

azure_auth

Microsoft Entra flusso di codice di autenticazione OAuth 2.0

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

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Type: apiKey
In: header

Esempio

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

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore Azure Batch.
JobTerminateParameter	Opzioni durante la terminazione di un processo.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
message	ErrorMessage	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta all'errore.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

Nome	Tipo	Descrizione
lang	string	Codice del linguaggio del messaggio di errore
value	string	Testo del messaggio.

JobTerminateParameter

Opzioni durante la terminazione di un processo.

Nome	Tipo	Descrizione
terminateReason	string	Testo che si vuole visualizzare come TerminaReason del processo. Il valore predefinito è "UserTerminate".