Job - Disable

Servizio:

Batch Service

Versione API:

2024-07-01.20.0

Disabilita il processo specificato, impedendo l'esecuzione di nuove attività.
Il servizio Batch sposta immediatamente il processo nello 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 fino a quando non torna allo stato attivo. Se si tenta di disabilitare un processo in qualsiasi stato diverso da attivo, disabilitazione o disabilitato, la richiesta ha esito negativo con codice di stato 409.

POST {batchUrl}/jobs/{jobId}/disable?api-version=2024-07-01.20.0

Con parametri facoltativi:

POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2024-07-01.20.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del 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 di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string (uuid)	Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date		string (date-time-rfc1123)	Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; 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'ora dell'ultima modifica 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'ora dell'ultima modifica della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio non è stata modificata dall'ora specificata.

Corpo della richiesta

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

Nome	Necessario	Tipo	Descrizione
disableTasks	True	DisableJobOption	Operazioni da eseguire con le attività attive associate al processo.

Risposte

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

Sicurezza

azure_auth

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Job disable

Esempio di richiesta

HTTP

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2024-07-01.20.0



{
  "disableTasks": "terminate"
}

Risposta di esempio

Codice di stato:

202

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
DisableJobOption	Operazioni da eseguire con le attività attive associate al processo.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
JobDisableParameter	Opzioni durante la disabilitazione di un processo.

BatchError

Object

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati 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

Object

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

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

DisableJobOption

Enumerazione

Operazioni da eseguire con le attività attive associate al processo.

Valore	Descrizione
requeue	Terminare l'esecuzione di Attività e accodarle di nuovo. Le attività verranno eseguite di nuovo quando il processo è abilitato.
terminate	Terminare l'esecuzione di attività. Le attività verranno completate con failureInfo che indica che sono state terminate e non verranno eseguite di nuovo.
wait	Consenti il completamento delle attività attualmente in esecuzione.

ErrorMessage

Object

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

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

JobDisableParameter

Object

Opzioni durante la disabilitazione di un processo.

Nome	Tipo	Descrizione
disableTasks	DisableJobOption	Operazioni da eseguire con le attività attive associate al processo.