Task - Update

Servizio:

Batch Service

Versione API:

2024-07-01.20.0

Aggiorna le proprietà dell'attività specificata.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0

Con parametri facoltativi:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?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 contenente l'attività.
taskId	path	True	string	ID dell'attività da aggiornare.
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	Tipo	Descrizione
constraints	TaskConstraints	Vincoli che si applicano a questa attività. Se omesso, all'attività vengono assegnati i vincoli predefiniti. Per le attività a istanze multiple, l'aggiornamento del tempo di conservazione si applica solo all'attività primaria e non alle sottoattività.

Risposte

Nome	Tipo	Descrizione
200 OK		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

Task update

Esempio di richiesta

HTTP

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

Risposta di esempio

Codice di stato:

200

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.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
TaskConstraints	Vincoli di esecuzione da applicare a un'attività.
TaskUpdateParameter	Set di modifiche da apportare a un'attività.

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.

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.

TaskConstraints

Object

Vincoli di esecuzione da applicare a un'attività.

Nome	Tipo	Descrizione
maxTaskRetryCount	integer (int32)	Numero massimo di tentativi dell'attività. Il servizio Batch ritenta un'attività se il codice di uscita è diverso da zero. Si noti che questo valore controlla in modo specifico il numero di tentativi per l'eseguibile task a causa di un codice di uscita diverso da zero. Il servizio Batch proverà l'attività una sola volta e potrebbe quindi riprovare fino a questo limite. Ad esempio, se il numero massimo di tentativi è 3, Batch prova l'attività fino a 4 volte (un tentativo iniziale e 3 tentativi). Se il numero massimo di tentativi è 0, il servizio Batch non ritenta l'attività dopo il primo tentativo. Se il numero massimo di tentativi è -1, il servizio Batch ritenta l'attività senza limite, ma non è consigliabile per un'attività di avvio o per qualsiasi attività. Il valore predefinito è 0 (nessun tentativo).
maxWallClockTime	string (duration)	Tempo massimo trascorso che l'attività può essere eseguita, misurata dal momento in cui viene avviata l'attività. Se l'attività non viene completata entro il limite di tempo, il servizio Batch lo termina. Se non viene specificato, non è previsto alcun limite di tempo per quanto tempo l'attività può essere eseguita.
retentionTime	string (duration)	Tempo minimo per conservare la directory Task nel nodo di calcolo in cui è stata eseguita, dal momento in cui viene completata l'esecuzione. Dopo questo periodo, il servizio Batch può eliminare la directory Attività e tutto il relativo contenuto. Il valore predefinito è 7 giorni, ad esempio la directory Attività verrà mantenuta per 7 giorni, a meno che il nodo di calcolo non venga rimosso o che il processo venga eliminato.

TaskUpdateParameter

Object

Set di modifiche da apportare a un'attività.

Nome	Tipo	Descrizione
constraints	TaskConstraints	Vincoli che si applicano a questa attività. Se omesso, all'attività vengono assegnati i vincoli predefiniti. Per le attività a istanze multiple, l'aggiornamento del tempo di conservazione si applica solo all'attività primaria e non alle sottoattività.