Job - Disable

Service:

Batch Service

API Version:

2023-11-01.18.0

Disabilita il processo specificato, impedendo l'esecuzione di nuove attività.
Il servizio Batch sposta immediatamente il processo sullo stato di disabilitazione. Batch usa quindi il parametro disableTasks per determinare cosa fare con le attività attualmente in esecuzione del processo. Il processo rimane nello stato di disabilitazione fino al completamento dell'operazione di disabilitazione e tutte le attività sono state gestite in base all'opzione disableTasks; Il processo passa quindi allo stato disabilitato. Nessuna nuova attività viene avviata nel processo finché non torna allo stato attivo. Se si tenta di disabilitare un processo in qualsiasi stato diverso da attivo, disabilitazione o disabilitata, la richiesta ha esito negativo con il codice di stato 409.

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

With optional parameters:

POST {batchUrl}/jobs/{jobId}/disable?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 disabilitare.
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	Necessario	Tipo	Descrizione
disableTasks	True	DisableJobOption	Cosa fare con attività attive associate al processo.

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 disable

Sample Request

HTTP

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



{
  "disableTasks": "terminate"
}

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.
DisableJobOption	Cosa fare con attività attive associate al processo.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore Azure Batch.
JobDisableParameter	Opzioni durante la disabilitazione 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.

DisableJobOption

Cosa fare con attività attive associate al processo.

Nome	Tipo	Descrizione
requeue	string	Terminare l'esecuzione di Attività e riscrivarle. Le attività verranno eseguite di nuovo quando il processo è abilitato.
terminate	string	Terminare l'esecuzione di attività. Le attività verranno completate con failureInfo che indica che sono state terminate e non verranno eseguiti di nuovo.
wait	string	Consenti di completare le attività attualmente in esecuzione.

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.

JobDisableParameter

Opzioni durante la disabilitazione di un processo.

Nome	Tipo	Descrizione
disableTasks	DisableJobOption	Cosa fare con attività attive associate al processo.