Task - Add

Aggiunge un oggetto Task al processo specificato.
La durata massima di un'attività oltre al completamento è di 180 giorni. Se un'attività non è stata completata entro 180 giorni dall'aggiunta, verrà terminata dal servizio Batch e lasciato in qualsiasi stato in quel momento.

POST {batchUrl}/jobs/{jobId}/tasks?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/tasks?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 a cui aggiungere l'attività.

api-version
query True

string

Versione dell'API client.

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.

Corpo della richiesta

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

Nome Necessario Tipo Descrizione
commandLine True

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).

id True

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. L'ID mantiene la distinzione tra maiuscole e minuscole e non fa distinzione tra maiuscole e minuscole, ovvero potrebbe non avere due ID all'interno di un processo che differisce solo per caso.

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.

constraints

TaskConstraints

Vincoli di esecuzione che si applicano a questa attività.
Se non si specificano vincoli, maxTaskRetryCount è il valore maxTaskRetryCount specificato per job, maxWallClockTime è infinito e retentionTime è di 7 giorni.

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.

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. Se job non ha usesTaskDependencies impostato su true e questo elemento è presente, la richiesta ha esito negativo con codice di errore TaskDependenciesNotSpecifiedOnJob.

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.

environmentSettings

EnvironmentSetting[]

Elenco delle impostazioni delle variabili di ambiente per l'attività.

exitConditions

ExitConditions

Specifica la modalità di risposta del servizio Batch al termine dell'attività.
Risposta del servizio Batch al completamento 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.

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.

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.

userIdentity

UserIdentity

Identità utente con cui viene eseguita l'attività.
Se omesso, l'attività viene eseguita come utente non amministrativo univoco per l'attività.

Risposte

Nome Tipo Descrizione
201 Created

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 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

Add a basic task
Add a task with container settings
Add a task with exit conditions
Add a task with extra slot requirement

Add a basic task

Sample Request

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



{
  "id": "task1",
  "commandLine": "cmd /c echo task1"
}

Sample Response

Add a task with container settings

Sample Request

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



{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerRunOptions": "--rm"
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with exit conditions

Sample Request

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



{
  "id": "taskId",
  "commandLine": "cmd /c exit 3",
  "exitConditions": {
    "exitCodeRanges": [
      {
        "start": 2,
        "end": 4,
        "exitOptions": {
          "jobAction": "terminate"
        }
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with extra slot requirement

Sample Request

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



{
  "id": "task1",
  "requiredSlots": 2,
  "commandLine": "cmd /c echo task1"
}

Sample Response

Definizioni

Nome Descrizione
AccessScope

Risorse batch a cui il token concede l'accesso.

AffinityInformation

Hint di località 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.

ComputeNodeIdentityReference

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

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 task.

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à a più istanze.

OutputFile

Specifica per il caricamento di file da un nodo di calcolo Azure Batch in un'altra posizione dopo che il servizio Batch ha completato l'esecuzione del processo attività.

OutputFileBlobContainerDestination

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

OutputFileDestination

Destinazione in cui deve essere caricato 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.

TaskAddParameter

Oggetto Azure Batch Attività da aggiungere.

TaskConstraints

Vincoli di esecuzione da applicare a 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.

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.

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 località 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'affinityId 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à soft. 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 il valore Task se è necessario un isolamento più rigoroso tra le attività. Ad esempio, se l'attività modifica il Registro di sistema in un modo che potrebbe 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 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 di errore.

ComputeNodeIdentityReference

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

Nome Tipo Descrizione
resourceId

string

ID risorsa ARM dell'identità assegnata dall'utente.

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 task.

Nome Tipo Descrizione
name

string

Nome della variabile di ambiente.

value

string

Valore della variabile di ambiente.

ErrorMessage

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

Nome Tipo Descrizione
lang

string

Codice linguistico 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 l'avanzamento delle attività dipendenti) 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 è nessuno 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à viene restituito un errore e la richiesta di aggiunta attività ha esito negativo con un errore di valore della 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à a più istanze.

Nome Tipo Descrizione
commonResourceFiles

ResourceFile[]

Elenco di file che il servizio Batch scaricherà 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 sottoattività, tra cui il database primario, mentre i file di risorse attività vengono scaricati solo per il database primario. Si noti anche che questi file di risorse non vengono scaricati nella directory di lavoro Attività, ma vengono invece scaricati nella directory radice dell'attività (una directory sopra la directory di lavoro). 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 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 primario esegue il comando Task principale.
Una tipica riga di comando di coordinamento 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.

OutputFile

Specifica per il caricamento di file da un nodo di calcolo Azure Batch in un'altra posizione dopo che il servizio Batch ha completato l'esecuzione del processo attività.

Nome Tipo Descrizione
destination

OutputFileDestination

Destinazione dei file di output.

filePattern

string

Modello che indica i file da caricare.
Sono supportati sia i 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, il modello abc* corrisponde a abc o abcdef), ** corrisponde a qualsiasi directory, ? corrisponde a qualsiasi carattere singolo, [abc] corrisponde a un carattere tra parentesi quadre e [a-c] corrisponde a un carattere nell'intervallo. Le parentesi quadre possono includere una negazione in modo che corrisponda 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 inizia in '.' e termina con .txt nella directory di lavoro attività o in qualsiasi sottodirectory. Se il nome file contiene un carattere jolly, può essere preceduto da un carattere di escape usando parentesi quadre (ad esempio abc[] corrisponderebbe a un file denominato abc. Si noti che sia \ che / vengono considerati 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 in cui deve essere caricato un file.

Nome Tipo Descrizione
container

OutputFileBlobContainerDestination

Percorso nell'archivio BLOB di Azure in 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

Condizioni in cui deve essere caricato il file o il set di file di output dell'attività.
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 si escludono a vicenda e una di esse deve essere specificata.

blobPrefix

string

Prefisso BLOB da usare durante il download di 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 si usa autoStorageContainerName o storageContainerUrl. Questo prefisso può essere un nome file parziale o una sottodirectory. Se non viene specificato un prefisso, verranno scaricati tutti i file nel contenitore.

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 Windows. Se questa proprietà non viene specificata per un nodo di calcolo Linux, al file viene applicato il valore predefinito 0770.

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, 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, tutte le strutture di directory già associate ai dati di input verranno mantenute complete e aggiunte alla directory filePath specificata. Il percorso relativo specificato non può uscire dalla directory di lavoro dell'attività, ad esempio utilizzando '.'.

httpUrl

string

URL del file da scaricare.
Le proprietà autoStorageContainerName, storageContainerUrl e httpUrl si escludono a vicenda 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 che concede le autorizzazioni di lettura per il BLOB, usare un'identità gestita con autorizzazione 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 ai Archiviazione BLOB di Azure specificati da storageContainerUrl o httpUrl
Riferimento a un'identità assegnata dall'utente associata al pool di 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 si escludono a vicenda e una di esse deve essere specificata. Questo URL deve essere leggibile ed elencabile dai nodi di calcolo. Esistono tre modi per ottenere tale URL per un contenitore in Archiviazione di Azure: includere una firma di accesso condiviso che concede autorizzazioni di lettura ed elenco per il contenitore, usare un'identità gestita con autorizzazioni di lettura ed elenco o impostare l'ACL per il contenitore per consentire l'accesso pubblico.

TaskAddParameter

Oggetto Azure Batch Attività da aggiungere.

Nome Tipo Descrizione
affinityInfo

AffinityInformation

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

applicationPackageReferences

ApplicationPackageReference[]

Elenco dei pacchetti distribuiti dal servizio Batch 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 o controllare lo stato del processo o di altre attività nel processo.

commandLine

string

Riga di comando dell'attività.
Per attività a più istanze, la riga di comando viene eseguita come attività primaria, dopo che l'attività primaria e tutte le sottotask 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 (rispetto 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à.
Se non si specificano vincoli, il maxTaskRetryCount è il valore maxTaskRetryCount specificato per il processo, il valore maxWallClockTime è infinito e la conservazioneTime è di 7 giorni.

containerSettings

TaskContainerSettings

Impostazioni per il contenitore in cui viene eseguita l'attività.
Se il pool che eseguirà questa attività dispone del set di contenitoriConfiguration, è necessario impostare anche questo oggetto. Se il pool che eseguirà questa attività non dispone del set di contenitoriConfiguration, 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 di Azure Batch nel nodo) vengono mappate nel contenitore, tutte le variabili di ambiente attività vengono mappate nel contenitore e la riga di comando attività viene eseguita nel contenitore. I file generati nel contenitore all'esterno di AZ_BATCH_NODE_ROOT_DIR potrebbero non essere riflessi nel disco host, ovvero le API file batch non potranno accedere a tali file.

dependsOn

TaskDependencies

Le attività a seconda di questa attività.
Questa attività non verrà pianificata fino a quando tutte le attività a seconda del completamento. Se una di queste attività ha esito negativo e esaurisce i conteggi dei tentativi, questa attività non verrà mai pianificata. Se il processo non dispone di usesTaskDependencies impostato su true e questo elemento è presente, la richiesta non riesce con il codice di errore TaskDependenciesNotSpecifiedOnJob.

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.

environmentSettings

EnvironmentSetting[]

Elenco delle impostazioni delle variabili di ambiente per l'attività.

exitConditions

ExitConditions

Specifica il modo in cui il servizio Batch deve rispondere al completamento dell'attività.
Come il servizio Batch deve rispondere 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. L'ID è senza distinzione tra maiuscole e minuscole( ovvero, potrebbe non avere due ID all'interno di un processo che differisce solo in base al caso).

multiInstanceSettings

MultiInstanceSettings

Oggetto che indica che l'attività è un'attività multiistanza e contiene informazioni su come eseguire l'attività multiistanza.
Le attività multiistanza vengono comunemente usate per supportare attività MPI. Nel caso MPI, se una delle sottotask ha esito negativo ,ad esempio a causa dell'uscita con un codice di uscita diverso da zero, l'intera attività multiistanza ha esito negativo. L'attività multiistanza viene quindi terminata e riprovata, fino al limite di ripetizione dei tentativi.

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 più istanze, i file verranno caricati solo dal nodo di calcolo in cui viene eseguita l'attività primaria.

requiredSlots

integer

Numero di slot di pianificazione necessari per l'esecuzione dell'attività.
Il valore predefinito è 1. Un'attività può essere pianificata solo in un nodo di calcolo se il nodo dispone di slot di pianificazione gratuiti sufficienti. Per le attività multiistanza, questa operazione deve essere 1.

resourceFiles

ResourceFile[]

Elenco di file scaricati dal servizio Batch nel nodo di calcolo prima di eseguire la riga di comando.
Per attività multiistanza, i file di risorse verranno scaricati solo nel nodo di calcolo in cui viene eseguita l'attività primaria. È 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.

userIdentity

UserIdentity

Identità utente in cui viene eseguita l'attività.
Se omesso, l'attività viene eseguita come utente non amministrativo univoco per l'attività.

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

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 dell'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à.

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.

UserIdentity

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

Nome Tipo Descrizione
autoUser

AutoUserSpecification

Utente automatico con cui viene eseguita l'attività.
Le proprietà userName e autoUser si escludono a vicenda; è necessario specificarne 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 specificarne uno, ma non entrambi.