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 |
---|---|---|---|---|
batch
|
path | True |
string |
URL di base per tutte le richieste di servizio Azure Batch. |
job
|
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à. |
id | True |
string |
Stringa che identifica in modo univoco l'attività all'interno del processo. |
affinityInfo |
Hint di località che può essere usato dal servizio Batch per selezionare un nodo di calcolo in cui avviare la nuova attività. |
||
applicationPackageReferences |
Elenco di pacchetti che il servizio Batch distribuirà nel nodo di calcolo prima di eseguire la riga di comando. |
||
authenticationTokenSettings |
Impostazioni per un token di autenticazione che l'attività può usare per eseguire operazioni del servizio Batch. |
||
constraints |
Vincoli di esecuzione che si applicano a questa attività. |
||
containerSettings |
Impostazioni per il contenitore in cui viene eseguita l'attività. |
||
dependsOn |
Attività da cui dipende questa attività. |
||
displayName |
string |
Nome visualizzato per l'attività. |
|
environmentSettings |
Elenco delle impostazioni delle variabili di ambiente per l'attività. |
||
exitConditions |
Specifica la modalità di risposta del servizio Batch al termine dell'attività. |
||
multiInstanceSettings |
Oggetto che indica che l'attività è un'attività a istanze multipla e contiene informazioni su come eseguire l'attività a istanze multipla. |
||
outputFiles |
Elenco di file che il servizio Batch caricherà dal nodo di calcolo dopo l'esecuzione della riga di comando. |
||
requiredSlots |
integer |
Numero di slot di pianificazione necessari per l'esecuzione dell'attività. |
|
resourceFiles |
Elenco di file che il servizio Batch scaricherà nel nodo di calcolo prima di eseguire la riga di comando. |
||
userIdentity |
Identità utente con cui viene eseguita l'attività. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
201 Created |
La richiesta al servizio Batch ha avuto esito positivo. Intestazioni
|
|
Other Status Codes |
Errore del servizio Batch. |
Sicurezza
azure_auth
Microsoft Entra flusso del codice di autenticazione OAuth 2.0
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | Rappresentare l'account utente |
Authorization
Tipo:
apiKey
In:
header
Esempio
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
Esempio di richiesta
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0
{
"id": "task1",
"commandLine": "cmd /c echo task1"
}
Risposta di esempio
Add a task with container settings
Esempio di richiesta
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"
}
}
}
Risposta di esempio
Add a task with exit conditions
Esempio di richiesta
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"
}
}
}
Risposta di esempio
Add a task with extra slot requirement
Esempio di richiesta
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"
}
Risposta di esempio
Definizioni
Nome | Descrizione |
---|---|
Access |
Risorse batch a cui il token concede l'accesso. |
Affinity |
Hint di località che può essere usato dal servizio Batch per selezionare un nodo di calcolo in cui avviare un'attività. |
Application |
Riferimento a un pacchetto da distribuire nei nodi di calcolo. |
Authentication |
Impostazioni per un token di autenticazione che l'attività può usare per eseguire operazioni del servizio Batch. |
Auto |
Ambito dell'utente automatico |
Auto |
Specifica i parametri per l'utente automatico che esegue un'attività nel servizio Batch. |
Batch |
Risposta di errore ricevuta dal servizio Azure Batch. |
Batch |
Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch. |
Compute |
Riferimento a un'identità assegnata dall'utente associata al pool di Batch che verrà usato da un nodo di calcolo. |
Container |
Registro contenitori privati. |
Container |
Percorso della directory di lavoro attività contenitore. |
Dependency |
Azione eseguita dal servizio Batch su Attività che dipendono da questa attività. |
Elevation |
Livello di elevazione dell'utente. |
Environment |
Variabile di ambiente da impostare in un processo task. |
Error |
Messaggio di errore ricevuto in una risposta di errore Azure Batch. |
Exit |
Come il servizio Batch deve rispondere se un'attività viene chiusa con un determinato codice di uscita. |
Exit |
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. |
Exit |
Specifica la modalità di risposta del servizio Batch al termine dell'attività. |
Exit |
Specifica come il servizio Batch risponde a una determinata condizione di uscita. |
Http |
Coppia nome-valore intestazione HTTP |
Job |
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". |
Multi |
Impostazioni che specificano come eseguire un'attività a più istanze. |
Output |
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à. |
Output |
Specifica una destinazione di caricamento file all'interno di un contenitore di archiviazione BLOB di Azure. |
Output |
Destinazione in cui deve essere caricato un file. |
Output |
Condizioni in cui deve essere caricato un file o un set di file di output dell'attività. |
Output |
Informazioni dettagliate su un'operazione di caricamento dei file di output, incluse le condizioni per eseguire il caricamento. |
Resource |
Un singolo file o più file da scaricare in un nodo di calcolo. |
Task |
Oggetto Azure Batch Attività da aggiungere. |
Task |
Vincoli di esecuzione da applicare a un'attività. |
Task |
Impostazioni del contenitore per un'attività. |
Task |
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. |
Task |
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. |
User |
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. |
ApplicationPackageReference
Riferimento a un pacchetto da distribuire nei nodi di calcolo.
Nome | Tipo | Descrizione |
---|---|---|
applicationId |
string |
ID dell'applicazione da distribuire. |
version |
string |
Versione dell'applicazione da distribuire. Se omesso, viene distribuita la versione predefinita. |
AuthenticationTokenSettings
Impostazioni per un token di autenticazione che l'attività può usare per eseguire operazioni del servizio Batch.
Nome | Tipo | Descrizione |
---|---|---|
access |
Risorse Batch a cui il token concede l'accesso. |
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 |
Livello di elevazione dell'utente automatico. |
|
scope |
Ambito dell'utente automatico |
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 |
Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente. |
|
values |
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 |
Riferimento all'identità assegnata dall'utente da usare per accedere a un Registro Azure Container anziché al nome utente e alla password. |
|
password |
string |
Password per accedere al server del Registro di sistema. |
registryServer |
string |
URL del Registro di sistema. |
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 |
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 |
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 |
Modalità di risposta del servizio Batch se l'attività ha esito negativo con una condizione di uscita non coperta da altre proprietà. |
|
exitCodeRanges |
Elenco di intervalli di codice di uscita dell'attività e modalità di risposta del servizio Batch. |
|
exitCodes |
Elenco dei singoli codici di uscita delle attività e del modo in cui il servizio Batch deve rispondere. |
|
fileUploadError |
Risposta del servizio Batch se si verifica un errore di caricamento di file. |
|
preProcessingError |
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 |
Azione eseguita dal servizio Batch su Attività che dipendono da questa attività. |
|
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". |
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 |
Elenco di file che il servizio Batch scaricherà prima di eseguire la riga di comando di coordinamento. |
|
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. |
numberOfInstances |
integer |
Numero di nodi di calcolo richiesti dall'attività. |
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 |
Destinazione dei file di output. |
|
filePattern |
string |
Modello che indica i file da caricare. |
uploadOptions |
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. |
identityReference |
Riferimento all'identità assegnata dall'utente da usare per accedere a Archiviazione BLOB di Azure specificato da containerUrl |
|
path |
string |
BLOB di destinazione o directory virtuale all'interno del contenitore di Archiviazione di Azure. |
uploadHeaders |
Elenco di coppie nome-valore per le intestazioni da usare nel caricamento dei file di output |
OutputFileDestination
Destinazione in cui deve essere caricato un file.
Nome | Tipo | Descrizione |
---|---|---|
container |
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 |
Condizioni in cui deve essere caricato il file o il set di file di output dell'attività. |
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. |
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. |
fileMode |
string |
Attributo della modalità di autorizzazione file in formato ottale. |
filePath |
string |
Percorso nel nodo di calcolo in cui scaricare i file rispetto alla directory di lavoro dell'attività. |
httpUrl |
string |
URL del file da scaricare. |
identityReference |
Riferimento all'identità assegnata dall'utente da usare per accedere ai Archiviazione BLOB di Azure specificati da storageContainerUrl o httpUrl |
|
storageContainerUrl |
string |
URL del contenitore BLOB all'interno di Archiviazione BLOB di Azure. |
TaskAddParameter
Oggetto Azure Batch Attività da aggiungere.
Nome | Tipo | Descrizione |
---|---|---|
affinityInfo |
Hint di localizzazione che può essere usato dal servizio Batch per selezionare un nodo di calcolo in cui avviare la nuova attività. |
|
applicationPackageReferences |
Elenco dei pacchetti distribuiti dal servizio Batch nel nodo di calcolo prima di eseguire la riga di comando. |
|
authenticationTokenSettings |
Impostazioni per un token di autenticazione che l'attività può usare per eseguire operazioni del servizio Batch. |
|
commandLine |
string |
Riga di comando dell'attività. |
constraints |
Vincoli di esecuzione che si applicano a questa attività. |
|
containerSettings |
Impostazioni per il contenitore in cui viene eseguita l'attività. |
|
dependsOn |
Le attività a seconda di questa attività. |
|
displayName |
string |
Nome visualizzato per l'attività. |
environmentSettings |
Elenco delle impostazioni delle variabili di ambiente per l'attività. |
|
exitConditions |
Specifica il modo in cui il servizio Batch deve rispondere al completamento dell'attività. |
|
id |
string |
Stringa che identifica in modo univoco l'attività all'interno del processo. |
multiInstanceSettings |
Oggetto che indica che l'attività è un'attività multiistanza e contiene informazioni su come eseguire l'attività multiistanza. |
|
outputFiles |
Elenco di file che il servizio Batch caricherà dal nodo di calcolo dopo l'esecuzione della riga di comando. |
|
requiredSlots |
integer |
Numero di slot di pianificazione necessari per l'esecuzione dell'attività. |
resourceFiles |
Elenco di file scaricati dal servizio Batch nel nodo di calcolo prima di eseguire la riga di comando. |
|
userIdentity |
Identità utente in cui viene eseguita 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. |
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. |
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. |
TaskContainerSettings
Impostazioni del contenitore per un'attività.
Nome | Tipo | Descrizione |
---|---|---|
containerRunOptions |
string |
Opzioni aggiuntive per il comando create del contenitore. |
imageName |
string |
Immagine da usare per creare il contenitore in cui verrà eseguita l'attività. |
registry |
Registro privato che contiene l'immagine del contenitore. |
|
workingDirectory |
Percorso della directory di lavoro dell'attività contenitore. |
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 |
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. |
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 |
Utente automatico con cui viene eseguita l'attività. |
|
username |
string |
Nome dell'identità utente in cui viene eseguita l'attività. |