Task - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Ottiene informazioni sull'attività specificata.
Per attività a istanze multiple, informazioni quali affinityId, executionInfo e nodeInfo fanno riferimento all'attività primaria. Usare l'API list subtasks per recuperare informazioni sulle sottoattività.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&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 che contiene l'attività.
taskId	path	True	string	ID dell'attività per ottenere informazioni.
api-version	query	True	string	Versione dell'API client.
$expand	query		string	Clausola $expand OData.
$select	query		string	Clausola $select OData.
timeout	query		integer int32	Tempo massimo per cui il server può dedicare 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à 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 impostano in genere 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.

Risposte

Nome	Tipo	Descrizione
200 OK	CloudTask	Risposta contenente l'attività. Headers 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

Microsoft Entra flusso del 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

Task get

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2016-09-06T06:59:15.1161429Z",
  "lastModified": "2016-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
  "commandLine": "cmd /c hostname",
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  },
  "multiInstanceSettings": {
    "numberOfInstances": 3,
    "coordinationCommandLine": "cmd /c echo coordinating"
  },
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "retentionTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "requiredSlots": 2,
  "executionInfo": {
    "retryCount": 0,
    "requeueCount": 0
  }
}

Definizioni

Nome	Descrizione
AccessScope	Risorse batch a cui il token concede l'accesso.
AffinityInformation	Hint di localizzazione che può essere usato dal servizio Batch per selezionare un nodo di calcolo in cui avviare un'attività.
ApplicationPackageReference	Riferimento a un pacchetto da distribuire nei nodi di calcolo.
AuthenticationTokenSettings	Impostazioni per un token di autenticazione che l'attività può usare per eseguire operazioni del servizio Batch.
AutoUserScope	Ambito dell'utente automatico
AutoUserSpecification	Specifica i parametri per l'utente automatico che esegue un'attività nel servizio Batch.
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.
CloudTask	Attività Azure Batch.
ComputeNodeIdentityReference	Riferimento a un'identità assegnata dall'utente associata al pool batch che verrà usato da un nodo di calcolo.
ComputeNodeInformation	Informazioni sul nodo di calcolo in cui è stata eseguita un'attività.
ContainerRegistry	Registro contenitori privati.
ContainerWorkingDirectory	Percorso della directory di lavoro attività contenitore.
DependencyAction	Azione eseguita dal servizio Batch su Attività che dipendono da questa attività.
ElevationLevel	Livello di elevazione dell'utente.
EnvironmentSetting	Variabile di ambiente da impostare in un processo attività.
ErrorCategory	Categoria dell'errore.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore Azure Batch.
ExitCodeMapping	Come il servizio Batch deve rispondere se un'attività viene chiusa con un determinato codice di uscita.
ExitCodeRangeMapping	Un intervallo di codici di uscita e il modo in cui il servizio Batch deve rispondere ai codici di uscita all'interno di tale intervallo.
ExitConditions	Specifica la modalità di risposta del servizio Batch al termine dell'attività.
ExitOptions	Specifica come il servizio Batch risponde a una determinata condizione di uscita.
HttpHeader	Coppia nome-valore intestazione HTTP
JobAction	Azione da eseguire sul processo contenente l'attività, se l'attività viene completata con la condizione di uscita specificata e la proprietà onTaskFailed del processo è "performExitOptionsJobAction".
MultiInstanceSettings	Impostazioni che specificano come eseguire un'attività multiistanza.
NameValuePair	Rappresenta una coppia nome/valore.
OutputFile	Specifica per il caricamento di file da un nodo di calcolo Azure Batch a un altro percorso dopo che il servizio Batch ha terminato l'esecuzione del processo attività.
OutputFileBlobContainerDestination	Specifica una destinazione di caricamento file all'interno di un contenitore di archiviazione BLOB di Azure.
OutputFileDestination	Destinazione a cui caricare un file.
OutputFileUploadCondition	Condizioni in cui deve essere caricato un file o un set di file di output dell'attività.
OutputFileUploadOptions	Informazioni dettagliate su un'operazione di caricamento dei file di output, incluse le condizioni per eseguire il caricamento.
ResourceFile	Un singolo file o più file da scaricare in un nodo di calcolo.
TaskConstraints	Vincoli di esecuzione da applicare a un'attività.
TaskContainerExecutionInformation	Contiene informazioni sul contenitore in cui è in esecuzione un'attività.
TaskContainerSettings	Impostazioni del contenitore per un'attività.
TaskDependencies	Specifica le dipendenze di un'attività. Qualsiasi attività specificata in modo esplicito o all'interno di un intervallo di dipendenze deve essere completata prima della pianificazione dell'attività dipendente.
TaskExecutionInformation	Informazioni sull'esecuzione di un'attività.
TaskExecutionResult	Risultato dell'esecuzione dell'attività.
TaskFailureInformation	Informazioni su un errore dell'attività.
TaskIdRange	Intervallo di ID attività da cui può dipendere un'attività. Tutte le attività con ID nell'intervallo devono essere completate correttamente prima che l'attività dipendente possa essere pianificata.
TaskState	Stato dell'attività.
TaskStatistics	Statistiche sull'utilizzo delle risorse per un'attività.
UserIdentity	Definizione dell'identità utente in cui viene eseguita l'attività.

AccessScope

Risorse batch a cui il token concede l'accesso.

Nome	Tipo	Descrizione
job	string	Concede l'accesso per eseguire tutte le operazioni sul processo contenente l'attività.

AffinityInformation

Hint di localizzazione che può essere usato dal servizio Batch per selezionare un nodo di calcolo in cui avviare un'attività.

Nome	Tipo	Descrizione
affinityId	string	Stringa opaca che rappresenta la posizione di un nodo di calcolo o di un'attività eseguita in precedenza. È possibile passare l'affinitàId di un nodo per indicare che questa attività deve essere eseguita in tale nodo di calcolo. Si noti che si tratta solo di un'affinità temporanea. Se il nodo di calcolo di destinazione è occupato o non disponibile al momento della pianificazione dell'attività, l'attività verrà pianificata altrove.

ApplicationPackageReference

Riferimento a un pacchetto da distribuire nei nodi di calcolo.

Nome	Tipo	Descrizione
applicationId	string	ID dell'applicazione da distribuire. Quando si crea un pool, l'ID applicazione del pacchetto deve essere completo (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Versione dell'applicazione da distribuire. Se omesso, viene distribuita la versione predefinita. Se viene omesso in un pool e non viene specificata alcuna versione predefinita per questa applicazione, la richiesta ha esito negativo con il codice di errore InvalidApplicationPackageReferences e il codice di stato HTTP 409. Se viene omesso in un'attività e non viene specificata alcuna versione predefinita per questa applicazione, l'attività ha esito negativo con un errore di pre-elaborazione.

AuthenticationTokenSettings

Impostazioni per un token di autenticazione che l'attività può usare per eseguire operazioni del servizio Batch.

Nome	Tipo	Descrizione
access	AccessScope[]	Risorse Batch a cui il token concede l'accesso. Il token di autenticazione concede l'accesso a un set limitato di operazioni del servizio Batch. Attualmente l'unico valore supportato per la proprietà di accesso è 'job', che concede l'accesso a tutte le operazioni correlate al processo che contiene l'attività.

AutoUserScope

Ambito dell'utente automatico

Nome	Tipo	Descrizione
pool	string	Specifica che l'attività viene eseguita come account utente automatico comune creato in ogni nodo di calcolo in un pool.
task	string	Specifica che il servizio deve creare un nuovo utente per l'attività.

AutoUserSpecification

Specifica i parametri per l'utente automatico che esegue un'attività nel servizio Batch.

Nome	Tipo	Descrizione
elevationLevel	ElevationLevel	Livello di elevazione dell'utente automatico. Il valore predefinito è nonAdmin.
scope	AutoUserScope	Ambito dell'utente automatico Il valore predefinito è pool. Se il pool esegue Windows, è necessario specificare un valore di Task se è necessario un isolamento più rigoroso tra le attività. Ad esempio, se l'attività modifica il Registro di sistema in modo da influire su altre attività o se i certificati sono stati specificati nel pool che non devono essere accessibili dalle normali attività, ma devono essere accessibili da StartTasks.

BatchError

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, che deve 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.

CloudTask

Attività Azure Batch.

Nome	Tipo	Descrizione
affinityInfo	AffinityInformation	Hint di località che può essere usato dal servizio Batch per selezionare un nodo di calcolo in cui avviare la nuova attività.
applicationPackageReferences	ApplicationPackageReference[]	Elenco di pacchetti che il servizio Batch distribuirà nel nodo di calcolo prima di eseguire la riga di comando. I pacchetti dell'applicazione vengono scaricati e distribuiti in una directory condivisa, non nella directory di lavoro Attività. Pertanto, se un pacchetto a cui si fa riferimento è già presente nel nodo ed è aggiornato, non viene scaricato nuovamente; viene usata la copia esistente nel nodo di calcolo. Se non è possibile installare un pacchetto a cui si fa riferimento, ad esempio perché il pacchetto è stato eliminato o perché il download non è riuscito, l'attività ha esito negativo.
authenticationTokenSettings	AuthenticationTokenSettings	Impostazioni per un token di autenticazione che l'attività può usare per eseguire operazioni del servizio Batch. Se questa proprietà è impostata, il servizio Batch fornisce all'attività un token di autenticazione che può essere usato per autenticare le operazioni del servizio Batch senza richiedere una chiave di accesso account. Il token viene fornito tramite la variabile di ambiente AZ_BATCH_AUTHENTICATION_TOKEN. Le operazioni che l'attività può eseguire usando il token dipendono dalle impostazioni. Ad esempio, un'attività può richiedere autorizzazioni di processo per aggiungere altre attività al processo oppure controllare lo stato del processo o di altre attività nel processo.
commandLine	string	Riga di comando dell'attività. Per attività a istanze multiple, la riga di comando viene eseguita come attività primaria, dopo che l'attività primaria e tutte le sottoattività hanno completato l'esecuzione della riga di comando di coordinamento. La riga di comando non viene eseguita in una shell e pertanto non può sfruttare le funzionalità della shell, ad esempio l'espansione delle variabili di ambiente. Se si desidera sfruttare tali funzionalità, è necessario richiamare la shell nella riga di comando, ad esempio usando "cmd /c MyCommand" in Windows o "/bin/sh -c MyCommand" in Linux. Se la riga di comando fa riferimento ai percorsi di file, deve usare un percorso relativo (relativo alla directory di lavoro attività) o usare la variabile di ambiente fornita da Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	Vincoli di esecuzione che si applicano a questa attività.
containerSettings	TaskContainerSettings	Impostazioni per il contenitore in cui viene eseguita l'attività. Se il pool che eseguirà questa attività ha impostato containerConfiguration, è necessario impostare anche questo valore. Se il pool che eseguirà questa attività non dispone di containerConfiguration impostato, non deve essere impostato. Quando viene specificato, tutte le directory vengono mappate in modo ricorsivo al di sotto del AZ_BATCH_NODE_ROOT_DIR (la radice delle directory Azure Batch nel nodo) nel contenitore, tutte le variabili di ambiente dell'attività vengono mappate al contenitore e la riga di comando Task viene eseguita nel contenitore. I file prodotti nel contenitore all'esterno di AZ_BATCH_NODE_ROOT_DIR potrebbero non essere riflessi sul disco host, vale a dire che le API del file Batch non saranno in grado di accedere a tali file.
creationTime	string	Ora di creazione dell'attività.
dependsOn	TaskDependencies	Attività da cui dipende questa attività. Questa attività non verrà pianificata fino a quando tutte le attività da cui dipende non saranno state completate correttamente. Se una di queste attività ha esito negativo e esaurisce i conteggi dei tentativi, questa attività non verrà mai pianificata.
displayName	string	Nome visualizzato per l'attività. Il nome visualizzato non deve essere univoco e può contenere caratteri Unicode fino a una lunghezza massima di 1024.
eTag	string	ETag dell'attività. Si tratta di una stringa opaca. È possibile usarlo per rilevare se l'attività è cambiata tra le richieste. In particolare, è possibile passare l'ETag durante l'aggiornamento di un'attività per specificare che le modifiche devono essere applicate solo se nessun altro utente ha modificato l'attività nel frattempo.
environmentSettings	EnvironmentSetting[]	Elenco delle impostazioni delle variabili di ambiente per l'attività.
executionInfo	TaskExecutionInformation	Informazioni sull'esecuzione dell'attività.
exitConditions	ExitConditions	Specifica la modalità di risposta del servizio Batch al termine dell'attività. Risposta del servizio Batch al completamento dell'attività.
id	string	Stringa che identifica in modo univoco l'attività all'interno del processo. L'ID può contenere qualsiasi combinazione di caratteri alfanumerici, inclusi trattini e caratteri di sottolineatura, e non può contenere più di 64 caratteri.
lastModified	string	Ora dell'ultima modifica dell'attività.
multiInstanceSettings	MultiInstanceSettings	Oggetto che indica che l'attività è un'attività a istanze multipla e contiene informazioni su come eseguire l'attività a istanze multipla. Le attività a istanze multiple vengono comunemente usate per supportare le attività MPI. Nel caso MPI, se una delle sottoattività ha esito negativo ,ad esempio a causa dell'uscita con un codice di uscita diverso da zero, l'intera attività a istanze multipli ha esito negativo. L'attività a istanze multipla viene quindi terminata e ritentata, fino al limite di tentativi.
nodeInfo	ComputeNodeInformation	Informazioni sul nodo di calcolo in cui è stata eseguita l'attività.
outputFiles	OutputFile[]	Elenco di file che il servizio Batch caricherà dal nodo di calcolo dopo l'esecuzione della riga di comando. Per le attività a istanze multiple, i file verranno caricati solo dal nodo di calcolo in cui viene eseguita l'attività primaria.
previousState	TaskState	Stato precedente dell'attività. Questa proprietà non è impostata se l'oggetto Task si trova nello stato Attivo iniziale.
previousStateTransitionTime	string	Ora in cui l'attività ha immesso lo stato precedente. Questa proprietà non è impostata se l'oggetto Task si trova nello stato Attivo iniziale.
requiredSlots	integer	Numero di slot di pianificazione necessari per l'esecuzione dell'attività. Il valore predefinito è 1. Un'attività può essere pianificata per l'esecuzione in un nodo di calcolo solo se il nodo dispone di slot di pianificazione gratuiti sufficienti. Per le attività a istanze multiple, deve essere 1.
resourceFiles	ResourceFile[]	Elenco di file che il servizio Batch scaricherà nel nodo di calcolo prima di eseguire la riga di comando. Per le attività a istanze multiple, i file di risorse verranno scaricati solo nel nodo di calcolo in cui viene eseguita l'attività primaria. Per l'elenco dei file di risorse è prevista una dimensione massima. Quando viene superata la dimensione massima, la richiesta avrà esito negativo e il codice di errore della risposta sarà RequestEntityTooLarge. In questo caso, la raccolta di ResourceFiles deve essere ridotta di dimensioni. A tale scopo, è possibile usare .zip file, pacchetti dell'applicazione o contenitori Docker.
state	TaskState	Stato corrente dell'attività.
stateTransitionTime	string	Ora in cui l'attività ha immesso lo stato corrente.
stats	TaskStatistics	Statistiche di utilizzo delle risorse per l'attività.
url	string	URL dell'attività.
userIdentity	UserIdentity	Identità utente con cui viene eseguita l'attività. Se omesso, l'attività viene eseguita come utente non amministrativo univoco per l'attività.

ComputeNodeIdentityReference

Riferimento a un'identità assegnata dall'utente associata al pool batch che verrà usato da un nodo di calcolo.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa ARM dell'identità assegnata dall'utente.

ComputeNodeInformation

Informazioni sul nodo di calcolo in cui è stata eseguita un'attività.

Nome	Tipo	Descrizione
affinityId	string	Identificatore del nodo in cui è stata eseguita l'attività, che può essere passata quando si aggiunge un'attività per richiedere che l'attività venga pianificata in questo nodo di calcolo.
nodeId	string	ID del nodo di calcolo in cui è stata eseguita l'attività.
nodeUrl	string	URL del nodo di calcolo in cui è stata eseguita l'attività.
poolId	string	ID del pool in cui è stata eseguita l'attività.
taskRootDirectory	string	Directory radice dell'attività nel nodo di calcolo.
taskRootDirectoryUrl	string	URL della directory radice dell'attività nel nodo di calcolo.

ContainerRegistry

Registro contenitori privati.

Nome	Tipo	Descrizione
identityReference	ComputeNodeIdentityReference	Riferimento all'identità assegnata dall'utente da usare per accedere a un Registro Azure Container anziché al nome utente e alla password. Riferimento a un'identità assegnata dall'utente associata al pool batch che verrà usato da un nodo di calcolo.
password	string	Password per accedere al server del Registro di sistema.
registryServer	string	URL del Registro di sistema. Se omesso, il valore predefinito è "docker.io".
username	string	Nome utente da accedere al server del Registro di sistema.

ContainerWorkingDirectory

Percorso della directory di lavoro attività contenitore.

Nome	Tipo	Descrizione
containerImageDefault	string	Usare la directory di lavoro definita nell'immagine del contenitore. Tenere presente che questa directory non conterrà i file di risorse scaricati da Batch.
taskWorkingDirectory	string	Usare la directory di lavoro dell'attività del servizio Batch standard, che conterrà i file di risorse attività popolati da Batch.

DependencyAction

Azione eseguita dal servizio Batch su Attività che dipendono da questa attività.

Nome	Tipo	Descrizione
block	string	Blocca le attività in attesa di questa attività, impedendone la pianificazione.
satisfy	string	Soddisfare le attività in attesa di questa attività; una volta soddisfatte tutte le dipendenze, l'attività verrà pianificata per l'esecuzione.

ElevationLevel

Livello di elevazione dell'utente.

Nome	Tipo	Descrizione
admin	string	L'utente è un utente con accesso con privilegi elevati e opera con autorizzazioni di amministratore complete.
nonadmin	string	L'utente è un utente standard senza accesso con privilegi elevati.

EnvironmentSetting

Variabile di ambiente da impostare in un processo attività.

Nome	Tipo	Descrizione
name	string	Nome della variabile di ambiente.
value	string	Valore della variabile di ambiente.

ErrorCategory

Categoria dell'errore.

Nome	Tipo	Descrizione
servererror	string	L'errore è dovuto a un problema interno del server.
usererror	string	L'errore è dovuto a un problema dell'utente, ad esempio una configurazione errata.

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.

ExitCodeMapping

Come il servizio Batch deve rispondere se un'attività viene chiusa con un determinato codice di uscita.

Nome	Tipo	Descrizione
code	integer	Codice di uscita del processo.
exitOptions	ExitOptions	Come il servizio Batch deve rispondere se l'attività viene chiusa con questo codice di uscita.

ExitCodeRangeMapping

Un intervallo di codici di uscita e il modo in cui il servizio Batch deve rispondere ai codici di uscita all'interno di tale intervallo.

Nome	Tipo	Descrizione
end	integer	Ultimo codice di uscita nell'intervallo.
exitOptions	ExitOptions	Come il servizio Batch deve rispondere se l'attività viene chiusa con un codice di uscita nell'intervallo inizio alla fine (inclusivo).
start	integer	Il primo codice di uscita nell'intervallo.

ExitConditions

Specifica la modalità di risposta del servizio Batch al termine dell'attività.

Nome	Tipo	Descrizione
default	ExitOptions	Modalità di risposta del servizio Batch se l'attività ha esito negativo con una condizione di uscita non coperta da altre proprietà. Questo valore viene utilizzato se l'oggetto Task viene chiuso con codice di uscita diverso da zero non elencato nell'insieme exitCodes o exitCodeRanges, con un errore di pre-elaborazione se la proprietà preProcessingError non è presente o con un errore di caricamento del file se la proprietà fileUploadError non è presente. Se si desidera un comportamento non predefinito nel codice di uscita 0, è necessario elencarlo in modo esplicito usando l'insieme exitCodes o exitCodeRanges.
exitCodeRanges	ExitCodeRangeMapping[]	Elenco di intervalli di codice di uscita dell'attività e modalità di risposta del servizio Batch.
exitCodes	ExitCodeMapping[]	Elenco dei singoli codici di uscita delle attività e del modo in cui il servizio Batch deve rispondere.
fileUploadError	ExitOptions	Risposta del servizio Batch se si verifica un errore di caricamento di file. Se l'attività è stata chiusa con un codice di uscita specificato tramite exitCodes o exitCodeRanges e quindi ha rilevato un errore di caricamento di file, l'azione specificata dal codice di uscita ha la precedenza.
preProcessingError	ExitOptions	Risposta del servizio Batch se l'attività non viene avviata a causa di un errore.

ExitOptions

Specifica come il servizio Batch risponde a una determinata condizione di uscita.

Nome	Tipo	Descrizione
dependencyAction	DependencyAction	Azione eseguita dal servizio Batch su Attività che dipendono da questa attività. I valori possibili sono "soddisfa" (consentendo alle attività dipendenti di procedere) e "blocca" (le attività dipendenti continuano ad attendere). Batch non supporta ancora l'annullamento delle attività dipendenti.
jobAction	JobAction	Un'azione da eseguire sul processo contenente l'attività, se l'attività viene completata con la condizione di uscita specificata e la proprietà onTaskFailed di Job è "performExitOptionsJobAction". Il valore predefinito non è predefinito per il codice di uscita 0 e termina per tutte le altre condizioni di uscita. Se la proprietà OnTaskFailed di Job è noaction, specificando questa proprietà restituisce un errore e la richiesta di aggiunta attività non riesce con un errore di valore di proprietà non valido; se si chiama direttamente l'API REST, il codice di stato HTTP è 400 (richiesta non valida).

HttpHeader

Coppia nome-valore intestazione HTTP

Nome	Tipo	Descrizione
name	string	Nome senza distinzione tra maiuscole e minuscole dell'intestazione da usare durante il caricamento dei file di output
value	string	Valore dell'intestazione da usare durante il caricamento dei file di output

JobAction

Azione da eseguire sul processo contenente l'attività, se l'attività viene completata con la condizione di uscita specificata e la proprietà onTaskFailed del processo è "performExitOptionsJobAction".

Nome	Tipo	Descrizione
disable	string	Disabilitare il processo. Equivale a chiamare l'API di disabilitazione del processo, con un valore disableTasks di accodamento.
none	string	Non eseguire alcuna azione.
terminate	string	Terminare il processo. TerminateReason in executionInfo del processo è impostato su "TaskFailed".

MultiInstanceSettings

Impostazioni che specificano come eseguire un'attività multiistanza.

Nome	Tipo	Descrizione
commonResourceFiles	ResourceFile[]	Elenco di file scaricati dal servizio Batch prima di eseguire la riga di comando di coordinamento. La differenza tra i file di risorse comuni e i file di risorse attività è che i file di risorse comuni vengono scaricati per tutte le sottotask, incluse le sottotask, mentre i file di risorse attività vengono scaricati solo per il primario. Si noti anche che questi file di risorse non vengono scaricati nella directory di lavoro attività, ma vengono scaricati nella directory radice dell'attività (una directory sopra la directory di lavoro). È disponibile una dimensione massima per l'elenco dei file di risorse. Quando la dimensione massima viene superata, la richiesta avrà esito negativo e il codice di errore della risposta sarà RequestEntityTooLarge. In questo caso, la raccolta di ResourceFiles deve essere ridotta in dimensioni. Ciò può essere ottenuto usando i file .zip, i pacchetti applicazione o i contenitori Docker.
coordinationCommandLine	string	Riga di comando da eseguire in tutti i nodi di calcolo per consentire loro di coordinare quando il comando principale esegue il comando Task principale. Una riga di comando di coordinamento tipica avvia un servizio in background e verifica che il servizio sia pronto per elaborare i messaggi tra nodi.
numberOfInstances	integer	Numero di nodi di calcolo richiesti dall'attività. Se omesso, il valore predefinito è 1.

NameValuePair

Rappresenta una coppia nome/valore.

Nome	Tipo	Descrizione
name	string	Nome nella coppia nome-valore.
value	string	Valore nella coppia nome-valore.

OutputFile

Specifica per il caricamento di file da un nodo di calcolo Azure Batch a un altro percorso dopo che il servizio Batch ha terminato l'esecuzione del processo attività.

Nome	Tipo	Descrizione
destination	OutputFileDestination	Destinazione dei file di output.
filePattern	string	Modello che indica quali file caricare. Sono supportati sia percorsi relativi che assoluti. I percorsi relativi sono relativi alla directory di lavoro attività. Sono supportati i caratteri jolly seguenti: * corrisponde a 0 o più caratteri (ad esempio pattern abc* corrisponderebbe a abc o abcdef), ** corrisponde a qualsiasi directory, ? corrisponde a qualsiasi carattere singolo, [abc] corrisponde a un carattere nelle parentesi quadre e [a-c] corrisponde a un carattere nell'intervallo. Le parentesi quadre possono includere una negazione per corrispondere a qualsiasi carattere non specificato (ad esempio [!abc] corrisponde a qualsiasi carattere ma a, b o c). Se un nome file inizia con "." viene ignorato per impostazione predefinita, ma può essere corrispondente specificandolo in modo esplicito (ad esempio .gif non corrisponderà a .a.gif, ma ..gif). Esempio semplice: **.txt corrisponde a qualsiasi file che non viene avviato in '.' e termina con .txt nella directory di lavoro attività o in qualsiasi sottodirectory. Se il nome del file contiene un carattere jolly, può essere eseguito l'escape usando parentesi quadre ( ad esempio abc[] corrisponderebbe a un file denominato abc. Si noti che sia \ che / vengono trattati come separatori di directory in Windows, ma solo / è in Linux. Le variabili di ambiente (%var% in Windows o $var in Linux) vengono espanse prima dell'applicazione del modello.
uploadOptions	OutputFileUploadOptions	Opzioni aggiuntive per l'operazione di caricamento, incluse le condizioni per eseguire il caricamento.

OutputFileBlobContainerDestination

Specifica una destinazione di caricamento file all'interno di un contenitore di archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
containerUrl	string	URL del contenitore all'interno di Archiviazione BLOB di Azure in cui caricare i file. Se non si usa un'identità gestita, l'URL deve includere una firma di accesso condiviso che concede le autorizzazioni di scrittura al contenitore.
identityReference	ComputeNodeIdentityReference	Riferimento all'identità assegnata dall'utente da usare per accedere a Archiviazione BLOB di Azure specificato da containerUrl L'identità deve avere accesso in scrittura al contenitore Archiviazione BLOB di Azure
path	string	BLOB di destinazione o directory virtuale all'interno del contenitore di Archiviazione di Azure. Se filePattern fa riferimento a un file specifico (ad esempio, non contiene caratteri jolly), il percorso è il nome del BLOB in cui caricare il file. Se filePattern contiene uno o più caratteri jolly (e pertanto può corrispondere a più file), il percorso è il nome della directory virtuale BLOB (che viene anteposto a ogni nome BLOB) in cui caricare i file. Se omesso, i file vengono caricati nella radice del contenitore con un nome BLOB corrispondente al nome del file.
uploadHeaders	HttpHeader[]	Elenco di coppie nome-valore per le intestazioni da usare nel caricamento dei file di output Queste intestazioni verranno specificate durante il caricamento di file in Archiviazione di Azure. Documento ufficiale sulle intestazioni consentite durante il caricamento di BLOB: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Destinazione a cui caricare un file.

Nome	Tipo	Descrizione
container	OutputFileBlobContainerDestination	Percorso nell'archiviazione BLOB di Azure a cui vengono caricati i file.

OutputFileUploadCondition

Condizioni in cui deve essere caricato un file o un set di file di output dell'attività.

Nome	Tipo	Descrizione
taskcompletion	string	Caricare i file dopo l'uscita dal processo attività, indipendentemente dal codice di uscita.
taskfailure	string	Caricare i file solo dopo la chiusura del processo attività con un codice di uscita diverso da zero.
tasksuccess	string	Caricare i file solo dopo la chiusura del processo attività con un codice di uscita pari a 0.

OutputFileUploadOptions

Informazioni dettagliate su un'operazione di caricamento dei file di output, incluse le condizioni per eseguire il caricamento.

Nome	Tipo	Descrizione
uploadCondition	OutputFileUploadCondition	Le condizioni in cui è necessario caricare il file di output dell'attività o il set di file. Il valore predefinito è taskcompletion.

ResourceFile

Un singolo file o più file da scaricare in un nodo di calcolo.

Nome	Tipo	Descrizione
autoStorageContainerName	string	Nome del contenitore di archiviazione nell'account di archiviazione automatica. Le proprietà autoStorageContainerName, storageContainerUrl e httpUrl sono reciprocamente esclusive e una di esse deve essere specificata.
blobPrefix	string	Prefisso BLOB da usare quando si scaricano BLOB da un contenitore di archiviazione di Azure. Verranno scaricati solo i BLOB i cui nomi iniziano con il prefisso specificato. La proprietà è valida solo quando viene usato autoStorageContainerName o storageContainerUrl. Questo prefisso può essere un nome file parziale o una sottodirectory. Se non viene specificato un prefisso, tutti i file nel contenitore verranno scaricati.
fileMode	string	Attributo della modalità di autorizzazione file in formato ottale. Questa proprietà si applica solo ai file scaricati nei nodi di calcolo Linux. Verrà ignorato se viene specificato per un resourceFile che verrà scaricato in un nodo di calcolo di Windows. Se questa proprietà non è specificata per un nodo di calcolo Linux, viene applicato un valore predefinito 0770 al file.
filePath	string	Percorso nel nodo di calcolo in cui scaricare i file rispetto alla directory di lavoro dell'attività. Se viene specificata la proprietà httpUrl, il filePath è obbligatorio e descrive il percorso in cui verrà scaricato il file, incluso il nome file. In caso contrario, se viene specificata la proprietà autoStorageContainerName o storageContainerUrl, filePath è facoltativo ed è la directory in cui scaricare i file. Nel caso in cui filePath venga usato come directory, qualsiasi struttura di directory già associata ai dati di input verrà mantenuta in modo completo e accodato alla directory filePath specificata. Il percorso relativo specificato non può uscire dalla directory di lavoro dell'attività, ad esempio usando '.'.
httpUrl	string	URL del file da scaricare. Le proprietà autoStorageContainerName, storageContainerUrl e httpUrl sono reciprocamente esclusive e una di esse deve essere specificata. Se l'URL punta a Archiviazione BLOB di Azure, deve essere leggibile dai nodi di calcolo. Esistono tre modi per ottenere tale URL per un BLOB nell'archiviazione di Azure: includere una firma di accesso condiviso (SAS) concedendole le autorizzazioni di lettura nel BLOB, usare un'identità gestita con autorizzazioni di lettura o impostare l'ACL per il BLOB o il relativo contenitore per consentire l'accesso pubblico.
identityReference	ComputeNodeIdentityReference	Riferimento all'identità assegnata dall'utente da usare per accedere Archiviazione BLOB di Azure specificato da storageContainerUrl o httpUrl Riferimento a un'identità assegnata dall'utente associata al pool batch che verrà usato da un nodo di calcolo.
storageContainerUrl	string	URL del contenitore BLOB all'interno di Archiviazione BLOB di Azure. Le proprietà autoStorageContainerName, storageContainerUrl e httpUrl sono reciprocamente esclusive e una di esse deve essere specificata. Questo URL deve essere leggibile e elencabile dai nodi di calcolo. Esistono tre modi per ottenere un URL di questo tipo per un contenitore nell'archiviazione di Azure: includere una firma di accesso condiviso (SAS) concedendole autorizzazioni di lettura e elenco nel contenitore, usare un'identità gestita con autorizzazioni di lettura e elenco o impostare l'ACL per il contenitore per consentire l'accesso pubblico.

TaskConstraints

Vincoli di esecuzione da applicare a un'attività.

Nome	Tipo	Descrizione
maxTaskRetryCount	integer	Numero massimo di tentativi di ripetizione dell'attività. Il servizio Batch esegue il tentativo di un'attività se il codice di uscita è diverso da zero. Si noti che questo valore controlla in modo specifico il numero di tentativi per il file eseguibile dell'attività a causa di un codice di uscita diverso da zero. Il servizio Batch tenterà 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 riprova l'attività dopo il primo tentativo. Se il numero massimo di tentativi è -1, il servizio Batch esegue il tentativo dell'attività senza limiti, ma non è consigliabile per un'attività di avvio o per qualsiasi attività. Il valore predefinito è 0, ovvero nessun tentativo.
maxWallClockTime	string	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	Tempo minimo per conservare la directory attività nel nodo di calcolo in cui è stata eseguita, dal momento in cui viene completata l'esecuzione. Dopo questa volta, 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.

TaskContainerExecutionInformation

Contiene informazioni sul contenitore in cui è in esecuzione un'attività.

Nome	Tipo	Descrizione
containerId	string	ID del contenitore.
error	string	Informazioni dettagliate sull'errore sul contenitore. Questa è la stringa di errore dettagliata del servizio Docker, se disponibile. Equivale al campo di errore restituito da "docker inspect".
state	string	Stato del contenitore. Questo è lo stato del contenitore in base al servizio Docker. Equivale al campo di stato restituito da "docker inspect".

TaskContainerSettings

Impostazioni del contenitore per un'attività.

Nome	Tipo	Descrizione
containerRunOptions	string	Opzioni aggiuntive per il comando create del contenitore. Queste opzioni aggiuntive vengono fornite come argomenti al comando "docker create", oltre a quelli controllati dal servizio Batch.
imageName	string	Immagine da usare per creare il contenitore in cui verrà eseguita l'attività. Questo è il riferimento completo all'immagine, come verrebbe specificato in "docker pull". Se non viene fornito alcun tag come parte del nome immagine, il tag ":latest" viene usato come valore predefinito.
registry	ContainerRegistry	Registro privato che contiene l'immagine del contenitore. Questa impostazione può essere omessa se è già stata specificata durante la creazione del pool.
workingDirectory	ContainerWorkingDirectory	Percorso della directory di lavoro attività contenitore. Il valore predefinito è 'taskWorkingDirectory'.

TaskDependencies

Specifica le dipendenze di un'attività. Qualsiasi attività specificata in modo esplicito o all'interno di un intervallo di dipendenze deve essere completata prima della pianificazione dell'attività dipendente.

Nome	Tipo	Descrizione
taskIdRanges	TaskIdRange[]	Elenco degli intervalli di ID attività a seconda di questa attività. Tutte le attività in tutti gli intervalli devono essere completate correttamente prima che l'attività dipendente possa essere pianificata.
taskIds	string[]	L'elenco degli ID attività a seconda di questa attività. Tutte le attività in questo elenco devono essere completate correttamente prima che l'attività dipendente possa essere pianificata. L'insieme taskIds è limitato a 64000 caratteri totali ,ad esempio la lunghezza combinata di tutti gli ID attività. Se l'insieme taskIds supera la lunghezza massima, la richiesta Aggiungi attività non riesce con il codice di errore TaskDependencyListTooLong. In questo caso si consideri invece l'uso degli intervalli ID attività.

TaskExecutionInformation

Informazioni sull'esecuzione di un'attività.

Nome	Tipo	Descrizione
containerInfo	TaskContainerExecutionInformation	Informazioni sul contenitore in cui è in esecuzione l'attività. Questa proprietà viene impostata solo se l'attività viene eseguita in un contesto del contenitore.
endTime	string	Ora in cui l'attività è stata completata. Questa proprietà viene impostata solo se l'attività è nello stato Complete.
exitCode	integer	Codice di uscita del programma specificato nella riga di comando Attività. Questa proprietà viene impostata solo se l'attività è nello stato completato. In generale, il codice di uscita per un processo riflette la convenzione specifica implementata dallo sviluppatore di applicazioni per tale processo. Se si usa il valore del codice di uscita per prendere decisioni nel codice, assicurarsi di conoscere la convenzione di uscita del codice utilizzata dal processo dell'applicazione. Tuttavia, se il servizio Batch termina l'attività (a causa del timeout o della terminazione dell'utente tramite l'API) potrebbe essere visualizzato un codice di uscita definito dal sistema operativo.
failureInfo	TaskFailureInformation	Informazioni che descrivono l'errore dell'attività, se presente. Questa proprietà viene impostata solo se l'attività è nello stato completato e ha rilevato un errore.
lastRequeueTime	string	L'ora più recente in cui l'attività è stata riquedata dal servizio Batch come risultato di una richiesta utente. Questa proprietà viene impostata solo se il requeueCount è diverso da zero.
lastRetryTime	string	Ora più recente in cui è stato avviato un nuovo tentativo dell'attività. Questo elemento è presente solo se l'oggetto Task è stato riprovato (ad esempio, retryCount è diverso da zero). Se presente, questa operazione è in genere uguale a startTime, ma può essere diversa se l'attività è stata riavviata per motivi diversi da quelli di ripetizione; Ad esempio, se il nodo di calcolo è stato riavviato durante un nuovo tentativo, l'avvioTime viene aggiornato ma l'ultimoRetryTime non è.
requeueCount	integer	Numero di volte in cui l'attività è stata riquecudata dal servizio Batch come risultato di una richiesta utente. Quando l'utente rimuove i nodi di calcolo da un pool (ridimensionando/compattando il pool) o quando il processo è disabilitato, l'utente può specificare che l'esecuzione di Attività nei nodi di calcolo viene riquedata per l'esecuzione. Questo conteggio tiene traccia del numero di volte in cui l'attività è stata riquedata per questi motivi.
result	TaskExecutionResult	Risultato dell'esecuzione dell'attività. Se il valore è "non riuscito", i dettagli dell'errore sono disponibili nella proprietà failureInfo.
retryCount	integer	Numero di tentativi di ripetizione dell'attività dal servizio Batch. Gli errori dell'applicazione attività (codice di uscita non zero) vengono riprovati, vengono rieseguati errori di pre-elaborazione (impossibile eseguire l'attività) e non vengono riprovati gli errori di caricamento dei file. Il servizio Batch ritenta l'attività fino al limite specificato dai vincoli.
startTime	string	Ora in cui è stata avviata l'esecuzione dell'attività. "In esecuzione" corrisponde allo stato in esecuzione, quindi se l'attività specifica i file di risorse o i pacchetti, l'ora di inizio riflette l'ora di inizio in cui l'attività ha avviato il download o la distribuzione di questi elementi. Se l'attività è stata riavviata o ritrita, questa è l'ora più recente in cui l'attività è stata avviata l'esecuzione. Questa proprietà è presente solo per Le attività che si trovano nello stato in esecuzione o completato.

TaskExecutionResult

Risultato dell'esecuzione dell'attività.

Nome	Tipo	Descrizione
failure	string	Errore durante l'elaborazione dell'attività. L'errore potrebbe essersi verificato prima dell'avvio del processo attività, durante l'esecuzione del processo attività o dopo l'uscita del processo attività.
success	string	L'attività è stata eseguita correttamente.

TaskFailureInformation

Informazioni su un errore dell'attività.

Nome	Tipo	Descrizione
category	ErrorCategory	Categoria dell'errore attività.
code	string	Identificatore per l'errore dell'attività. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	NameValuePair[]	Elenco di dettagli aggiuntivi relativi all'errore.
message	string	Messaggio che descrive l'errore dell'attività, che deve essere adatto per la visualizzazione in un'interfaccia utente.

TaskIdRange

Intervallo di ID attività da cui può dipendere un'attività. Tutte le attività con ID nell'intervallo devono essere completate correttamente prima che l'attività dipendente possa essere pianificata.

Nome	Tipo	Descrizione
end	integer	Ultimo ID attività nell'intervallo.
start	integer	Primo ID attività nell'intervallo.

TaskState

Stato dell'attività.

Nome	Tipo	Descrizione
active	string	L'attività è in coda e può essere eseguita, ma non è attualmente assegnata a un nodo di calcolo. Un'attività entra in questo stato quando viene creata, quando è abilitata dopo essere stata disabilitata o quando è in attesa di un nuovo tentativo dopo un'esecuzione non riuscita.
completed	string	L'attività non è più idonea per l'esecuzione, in genere perché l'attività è stata completata correttamente oppure l'attività è stata completata senza esito positivo e ha esaurito il limite di tentativi. Un'attività viene contrassegnata anche come completata se si è verificato un errore durante l'avvio dell'attività o quando l'attività è stata terminata.
preparing	string	L'attività è stata assegnata a un nodo di calcolo, ma è in attesa del completamento di un'attività di preparazione processo necessaria nel nodo di calcolo. Se l'attività di preparazione del processo ha esito positivo, l'attività passerà all'esecuzione. Se l'attività di preparazione del processo ha esito negativo, l'attività tornerà attiva e sarà idonea per essere assegnata a un nodo di calcolo diverso.
running	string	L'attività è in esecuzione in un nodo di calcolo. Ciò include la preparazione a livello di attività, ad esempio il download di file di risorse o la distribuzione di pacchetti specificati nell'attività, non significa necessariamente che la riga di comando attività abbia avviato l'esecuzione.

TaskStatistics

Statistiche sull'utilizzo delle risorse per un'attività.

Nome	Tipo	Descrizione
kernelCPUTime	string	Tempo di CPU in modalità kernel totale (sommato tra tutti i core e tutti i nodi di calcolo) utilizzato dall'attività.
lastUpdateTime	string	Ora in cui sono state aggiornate le statistiche. Tutte le statistiche sono limitate all'intervallo tra startTime e lastUpdateTime.
readIOGiB	number	I gibibyte totali letti dal disco dall'attività.
readIOps	integer	Numero totale di operazioni di lettura disco eseguite dall'attività.
startTime	string	Ora di inizio dell'intervallo di tempo coperto dalle statistiche.
url	string	URL delle statistiche.
userCPUTime	string	Tempo di CPU in modalità utente totale (sommato tra tutti i core e tutti i nodi di calcolo) utilizzato dall'attività.
waitTime	string	Tempo di attesa totale dell'attività. Il tempo di attesa per un'attività viene definito come tempo trascorso tra la creazione dell'attività e l'inizio dell'esecuzione dell'attività. Se l'attività viene riprovata a causa di errori, il tempo di attesa è l'ora dell'esecuzione dell'attività più recente.
wallClockTime	string	Ora totale dell'orologio a parete dell'attività. Il tempo dell'orologio a parete è il tempo trascorso da quando l'attività è stata avviata in esecuzione in un nodo di calcolo a quando è stata completata (o all'ultima volta che le statistiche sono state aggiornate, se l'attività non è stata completata da allora). Se l'attività è stata ritrita, questo include l'ora dell'orologio del muro di tutti i tentativi dell'attività.
writeIOGiB	number	I gibibyte totali scritti su disco dall'attività.
writeIOps	integer	Numero totale di operazioni di scrittura su disco eseguite dall'attività.

UserIdentity

Definizione dell'identità utente in cui viene eseguita l'attività.

Nome	Tipo	Descrizione
autoUser	AutoUserSpecification	Utente automatico in cui viene eseguita l'attività. Le proprietà userName e autoUser si escludono a vicenda; è necessario specificare uno ma non entrambi.
username	string	Nome dell'identità utente in cui viene eseguita l'attività. Le proprietà userName e autoUser si escludono a vicenda; è necessario specificare uno ma non entrambi.