Task - Add
Ajoute une tâche au travail spécifié.
La durée de vie maximale d’une tâche de l’addition à la fin est de 180 jours. Si une tâche n’est pas terminée dans les 180 jours suivant son ajout, elle est arrêtée par le service Batch et laissée dans l’état dans lequel elle se trouvait à ce moment-là.
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
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
URL de base pour toutes les demandes de service Azure Batch. |
job
|
path | True |
string |
ID du travail auquel la tâche doit être ajoutée. |
api-version
|
query | True |
string |
Version de l’API cliente. |
timeout
|
query |
integer int32 |
Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes. |
En-tête de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Indique si le serveur doit retourner le client-request-id dans la réponse. |
|
ocp-date |
string date-time-rfc1123 |
Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure actuelle de l’horloge système ; définissez-la explicitement si vous appelez directement l’API REST. |
Corps de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
commandLine | True |
string |
Ligne de commande de la tâche. |
id | True |
string |
Chaîne qui identifie de manière unique la tâche dans le travail. |
affinityInfo |
Indicateur de localité qui peut être utilisé par le service Batch pour sélectionner un nœud de calcul sur lequel démarrer la nouvelle tâche. |
||
applicationPackageReferences |
Liste des packages que le service Batch déploiera sur le nœud de calcul avant d’exécuter la ligne de commande. |
||
authenticationTokenSettings |
Paramètres d’un jeton d’authentification que la tâche peut utiliser pour effectuer des opérations de service Batch. |
||
constraints |
Contraintes d’exécution qui s’appliquent à cette tâche. |
||
containerSettings |
Paramètres du conteneur sous lequel la tâche s’exécute. |
||
dependsOn |
Tâches dont dépend cette tâche. |
||
displayName |
string |
Nom complet de la tâche. |
|
environmentSettings |
Liste des paramètres de variable d’environnement pour la tâche. |
||
exitConditions |
Spécifie la façon dont le service Batch doit répondre une fois la tâche terminée. |
||
multiInstanceSettings |
Objet qui indique que la tâche est une tâche multi-instance et contient des informations sur l’exécution de la tâche multi-instance. |
||
outputFiles |
Liste des fichiers que le service Batch chargera à partir du nœud de calcul après l’exécution de la ligne de commande. |
||
requiredSlots |
integer |
Nombre d’emplacements de planification nécessaires à l’exécution de la tâche. |
|
resourceFiles |
Liste des fichiers que le service Batch téléchargera sur le nœud de calcul avant d’exécuter la ligne de commande. |
||
userIdentity |
Identité de l’utilisateur sous laquelle la tâche s’exécute. |
Réponses
Nom | Type | Description |
---|---|---|
201 Created |
La demande adressée au service Batch a réussi. Headers
|
|
Other Status Codes |
Erreur du service Batch. |
Sécurité
azure_auth
flux de code d’authentification OAuth 2.0 Microsoft Entra
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Authorization
Type:
apiKey
In:
header
Exemples
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
Définitions
Nom | Description |
---|---|
Access |
Ressources Batch auxquelles le jeton accorde l’accès. |
Affinity |
Indicateur de localité qui peut être utilisé par le service Batch pour sélectionner un nœud de calcul sur lequel démarrer une tâche. |
Application |
Référence à un package à déployer sur les nœuds de calcul. |
Authentication |
Paramètres d’un jeton d’authentification que la tâche peut utiliser pour effectuer des opérations de service Batch. |
Auto |
Étendue de l’utilisateur automatique |
Auto |
Spécifie les paramètres de l’utilisateur automatique qui exécute une tâche sur le service Batch. |
Batch |
Réponse d’erreur reçue du service Azure Batch. |
Batch |
Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch. |
Compute |
Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera. |
Container |
Registre de conteneurs privé. |
Container |
Emplacement du répertoire de travail de la tâche du conteneur. |
Dependency |
Action que le service Batch effectue sur les tâches qui dépendent de cette tâche. |
Elevation |
Niveau d’élévation de l’utilisateur. |
Environment |
Variable d’environnement à définir sur un processus Task. |
Error |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
Exit |
Comment le service Batch doit répondre si une tâche se termine avec un code de sortie particulier. |
Exit |
Plage de codes de sortie et comment le service Batch doit répondre aux codes de sortie dans cette plage. |
Exit |
Spécifie la façon dont le service Batch doit répondre une fois la tâche terminée. |
Exit |
Spécifie la façon dont le service Batch répond à une condition de sortie particulière. |
Http |
Une paire nom-valeur d’en-tête HTTP |
Job |
Action à entreprendre sur le travail contenant la tâche, si la tâche se termine avec la condition de sortie donnée et que la propriété onTaskFailed du travail est « performExitOptionsJobAction ». |
Multi |
Paramètres qui spécifient comment exécuter une tâche multi-instance. |
Output |
Spécification pour le chargement de fichiers à partir d’un nœud de calcul Azure Batch vers un autre emplacement une fois que le service Batch a terminé l’exécution du processus Task. |
Output |
Spécifie une destination de chargement de fichiers dans un conteneur de stockage d’objets blob Azure. |
Output |
Destination vers laquelle un fichier doit être chargé. |
Output |
Conditions dans lesquelles un fichier de sortie de tâche ou un ensemble de fichiers doit être chargé. |
Output |
Détails sur une opération de chargement de fichier de sortie, y compris dans quelles conditions effectuer le chargement. |
Resource |
Fichier unique ou plusieurs fichiers à télécharger sur un nœud de calcul. |
Task |
Tâche Azure Batch à ajouter. |
Task |
Contraintes d’exécution à appliquer à une tâche. |
Task |
Paramètres de conteneur d’une tâche. |
Task |
Spécifie toutes les dépendances d’une tâche. Toute tâche spécifiée explicitement ou dans une plage de dépendances doit se terminer avant que la tâche dépendante soit planifiée. |
Task |
Plage d’ID de tâche dont une tâche peut dépendre. Toutes les tâches avec des ID dans la plage doivent se terminer correctement avant que la tâche dépendante puisse être planifiée. |
User |
Définition de l’identité de l’utilisateur sous laquelle la tâche est exécutée. |
AccessScope
Ressources Batch auxquelles le jeton accorde l’accès.
Nom | Type | Description |
---|---|---|
job |
string |
Accorde l’accès pour effectuer toutes les opérations sur le travail contenant la tâche. |
AffinityInformation
Indicateur de localité qui peut être utilisé par le service Batch pour sélectionner un nœud de calcul sur lequel démarrer une tâche.
Nom | Type | Description |
---|---|---|
affinityId |
string |
Chaîne opaque représentant l’emplacement d’un nœud de calcul ou d’une tâche exécutée précédemment. |
ApplicationPackageReference
Référence à un package à déployer sur les nœuds de calcul.
Nom | Type | Description |
---|---|---|
applicationId |
string |
ID de l’application à déployer. |
version |
string |
Version de l’application à déployer. En cas d’omission, la version par défaut est déployée. |
AuthenticationTokenSettings
Paramètres d’un jeton d’authentification que la tâche peut utiliser pour effectuer des opérations de service Batch.
Nom | Type | Description |
---|---|---|
access |
Ressources Batch auxquelles le jeton accorde l’accès. |
AutoUserScope
Étendue de l’utilisateur automatique
Nom | Type | Description |
---|---|---|
pool |
string |
Spécifie que la tâche s’exécute en tant que compte d’utilisateur automatique commun qui est créé sur chaque nœud de calcul d’un pool. |
task |
string |
Spécifie que le service doit créer un utilisateur pour la tâche. |
AutoUserSpecification
Spécifie les paramètres de l’utilisateur automatique qui exécute une tâche sur le service Batch.
Nom | Type | Description |
---|---|---|
elevationLevel |
Niveau d’élévation de l’utilisateur automatique. |
|
scope |
Étendue de l’utilisateur automatique |
BatchError
Réponse d’erreur reçue du service Azure Batch.
Nom | Type | Description |
---|---|---|
code |
string |
Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation. |
message |
Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur. |
|
values |
Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur. |
BatchErrorDetail
Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
Nom | Type | Description |
---|---|---|
key |
string |
Identificateur spécifiant la signification de la propriété Value. |
value |
string |
Informations supplémentaires incluses dans la réponse d’erreur. |
ComputeNodeIdentityReference
Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
Nom | Type | Description |
---|---|---|
resourceId |
string |
ID de ressource ARM de l’identité affectée par l’utilisateur. |
ContainerRegistry
Registre de conteneurs privé.
Nom | Type | Description |
---|---|---|
identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à un Azure Container Registry au lieu du nom d’utilisateur et du mot de passe. |
|
password |
string |
Mot de passe pour se connecter au serveur de Registre. |
registryServer |
string |
L’URL du registre. |
username |
string |
Nom d’utilisateur à connecter au serveur du Registre. |
ContainerWorkingDirectory
Emplacement du répertoire de travail de la tâche du conteneur.
Nom | Type | Description |
---|---|---|
containerImageDefault |
string |
Utilisez le répertoire de travail défini dans l’image conteneur. Veillez à ce que ce répertoire ne contienne pas les fichiers de ressources téléchargés par Batch. |
taskWorkingDirectory |
string |
Utilisez le répertoire de travail des tâches du service Batch standard, qui contiendra les fichiers de ressources des tâches renseignés par Batch. |
DependencyAction
Action que le service Batch effectue sur les tâches qui dépendent de cette tâche.
Nom | Type | Description |
---|---|---|
block |
string |
Bloque les tâches en attente de cette tâche, ce qui les empêche d’être planifiées. |
satisfy |
string |
Satisfaire les tâches en attente de cette tâche ; Une fois que toutes les dépendances sont satisfaites, l’exécution de la tâche est planifiée. |
ElevationLevel
Niveau d’élévation de l’utilisateur.
Nom | Type | Description |
---|---|---|
admin |
string |
L’utilisateur est un utilisateur disposant d’un accès élevé et fonctionne avec des autorisations d’administrateur complètes. |
nonadmin |
string |
L’utilisateur est un utilisateur standard sans accès élevé. |
EnvironmentSetting
Variable d’environnement à définir sur un processus Task.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la variable d’environnement. |
value |
string |
Valeur de la variable d’environnement. |
ErrorMessage
Message d’erreur reçu dans une réponse d’erreur Azure Batch.
Nom | Type | Description |
---|---|---|
lang |
string |
Code de langue du message d’erreur |
value |
string |
Texte du message. |
ExitCodeMapping
Comment le service Batch doit répondre si une tâche se termine avec un code de sortie particulier.
Nom | Type | Description |
---|---|---|
code |
integer |
Code de sortie de processus. |
exitOptions |
Comment le service Batch doit répondre si la tâche se termine avec ce code de sortie. |
ExitCodeRangeMapping
Plage de codes de sortie et comment le service Batch doit répondre aux codes de sortie dans cette plage.
Nom | Type | Description |
---|---|---|
end |
integer |
Dernier code de sortie de la plage. |
exitOptions |
Comment le service Batch doit répondre si la tâche se termine avec un code de sortie dans la plage de début à fin (inclus). |
|
start |
integer |
Premier code de sortie de la plage. |
ExitConditions
Spécifie la façon dont le service Batch doit répondre une fois la tâche terminée.
Nom | Type | Description |
---|---|---|
default |
Comment le service Batch doit répondre en cas d’échec de la tâche avec une condition de sortie non couverte par l’une des autres propriétés. |
|
exitCodeRanges |
Liste des plages de code de sortie des tâches et de la façon dont le service Batch doit y répondre. |
|
exitCodes |
Liste des codes de sortie de tâche individuels et de la façon dont le service Batch doit y répondre. |
|
fileUploadError |
Comment le service Batch doit répondre si une erreur de chargement de fichier se produit. |
|
preProcessingError |
Comment le service Batch doit répondre si la tâche ne parvient pas à démarrer en raison d’une erreur. |
ExitOptions
Spécifie la façon dont le service Batch répond à une condition de sortie particulière.
Nom | Type | Description |
---|---|---|
dependencyAction |
Action que le service Batch effectue sur les tâches qui dépendent de cette tâche. |
|
jobAction |
Action à entreprendre sur le travail contenant la tâche, si la tâche se termine avec la condition de sortie donnée et si la propriété onTaskFailed du travail est « performExitOptionsJobAction ». |
HttpHeader
Une paire nom-valeur d’en-tête HTTP
Nom | Type | Description |
---|---|---|
name |
string |
Nom non sensible à la casse de l’en-tête à utiliser lors du chargement des fichiers de sortie |
value |
string |
Valeur de l’en-tête à utiliser lors du chargement des fichiers de sortie |
JobAction
Action à entreprendre sur le travail contenant la tâche, si la tâche se termine avec la condition de sortie donnée et que la propriété onTaskFailed du travail est « performExitOptionsJobAction ».
Nom | Type | Description |
---|---|---|
disable |
string |
Désactivez le travail. Cela revient à appeler l’API disable Job, avec une valeur disableTasks de requeue. |
none |
string |
N’effectuez aucune action. |
terminate |
string |
Arrêtez le travail. La valeur terminateReason dans executionInfo du travail est définie sur « TaskFailed ». |
MultiInstanceSettings
Paramètres qui spécifient comment exécuter une tâche multi-instance.
Nom | Type | Description |
---|---|---|
commonResourceFiles |
Liste des fichiers que le service Batch téléchargera avant d’exécuter la ligne de commande de coordination. |
|
coordinationCommandLine |
string |
Ligne de commande à exécuter sur tous les nœuds de calcul pour leur permettre de se coordonner lorsque le serveur principal exécute la commande main Tâche. |
numberOfInstances |
integer |
Nombre de nœuds de calcul requis par la tâche. |
OutputFile
Spécification pour le chargement de fichiers à partir d’un nœud de calcul Azure Batch vers un autre emplacement une fois que le service Batch a terminé l’exécution du processus Task.
Nom | Type | Description |
---|---|---|
destination |
Destination du ou des fichiers de sortie. |
|
filePattern |
string |
Modèle indiquant le ou les fichiers à charger. |
uploadOptions |
Options supplémentaires pour l’opération de chargement, notamment dans quelles conditions effectuer le chargement. |
OutputFileBlobContainerDestination
Spécifie une destination de chargement de fichiers dans un conteneur de stockage d’objets blob Azure.
Nom | Type | Description |
---|---|---|
containerUrl |
string |
URL du conteneur dans Stockage Blob Azure vers laquelle charger le ou les fichiers. |
identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder Stockage Blob Azure spécifiée par containerUrl |
|
path |
string |
Objet blob de destination ou répertoire virtuel dans le conteneur stockage Azure. |
uploadHeaders |
Liste des paires nom-valeur pour les en-têtes à utiliser dans le chargement des fichiers de sortie |
OutputFileDestination
Destination vers laquelle un fichier doit être chargé.
Nom | Type | Description |
---|---|---|
container |
Emplacement dans le stockage Blob Azure vers lequel les fichiers sont chargés. |
OutputFileUploadCondition
Conditions dans lesquelles un fichier de sortie de tâche ou un ensemble de fichiers doit être chargé.
Nom | Type | Description |
---|---|---|
taskcompletion |
string |
Chargez le ou les fichiers une fois le processus Task terminé, quel que soit le code de sortie. |
taskfailure |
string |
Chargez le ou les fichiers uniquement après la fin du processus Task avec un code de sortie différent de zéro. |
tasksuccess |
string |
Chargez le ou les fichiers uniquement après la fin du processus Task avec un code de sortie de 0. |
OutputFileUploadOptions
Détails sur une opération de chargement de fichier de sortie, y compris dans quelles conditions effectuer le chargement.
Nom | Type | Description |
---|---|---|
uploadCondition |
Conditions dans lesquelles le fichier de sortie de tâche ou l’ensemble de fichiers doit être chargé. |
ResourceFile
Fichier unique ou plusieurs fichiers à télécharger sur un nœud de calcul.
Nom | Type | Description |
---|---|---|
autoStorageContainerName |
string |
Nom du conteneur de stockage dans le compte de stockage automatique. |
blobPrefix |
string |
Préfixe d’objet blob à utiliser lors du téléchargement d’objets blob à partir d’un conteneur stockage Azure. Seuls les objets blob dont le nom commence par le préfixe spécifié sont téléchargés. |
fileMode |
string |
Attribut du mode d’autorisation de fichier au format octal. |
filePath |
string |
Emplacement sur le nœud de calcul vers lequel télécharger le ou les fichiers, par rapport au répertoire de travail de la tâche. |
httpUrl |
string |
URL du fichier à télécharger. |
identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à Stockage Blob Azure spécifiée par storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
URL du conteneur d’objets blob dans Stockage Blob Azure. |
TaskAddParameter
Tâche Azure Batch à ajouter.
Nom | Type | Description |
---|---|---|
affinityInfo |
Indicateur de localisation qui peut être utilisé par le service Batch pour sélectionner un nœud de calcul sur lequel démarrer la nouvelle tâche. |
|
applicationPackageReferences |
Liste des packages que le service Batch déploiera sur le nœud de calcul avant d’exécuter la ligne de commande. |
|
authenticationTokenSettings |
Paramètres d’un jeton d’authentification que la tâche peut utiliser pour effectuer des opérations de service Batch. |
|
commandLine |
string |
Ligne de commande de la tâche. |
constraints |
Contraintes d’exécution qui s’appliquent à cette tâche. |
|
containerSettings |
Paramètres du conteneur sous lequel la tâche s’exécute. |
|
dependsOn |
Tâches dont dépend cette tâche. |
|
displayName |
string |
Nom d’affichage de la tâche. |
environmentSettings |
Liste des paramètres de variable d’environnement pour la tâche. |
|
exitConditions |
Spécifie la façon dont le service Batch doit répondre une fois la tâche terminée. |
|
id |
string |
Chaîne qui identifie de manière unique la tâche dans le travail. |
multiInstanceSettings |
Objet qui indique que la tâche est une tâche multi-instance et qui contient des informations sur l’exécution de la tâche multi-instance. |
|
outputFiles |
Liste des fichiers que le service Batch chargera à partir du nœud de calcul après avoir exécuté la ligne de commande. |
|
requiredSlots |
integer |
Nombre d’emplacements de planification que la tâche a requis pour s’exécuter. |
resourceFiles |
Liste des fichiers que le service Batch téléchargera sur le nœud de calcul avant d’exécuter la ligne de commande. |
|
userIdentity |
Identité utilisateur sous laquelle la tâche s’exécute. |
TaskConstraints
Contraintes d’exécution à appliquer à une tâche.
Nom | Type | Description |
---|---|---|
maxTaskRetryCount |
integer |
Nombre maximal de nouvelles tentatives de la tâche. Le service Batch retente une tâche si son code de sortie est différent de zéro. |
maxWallClockTime |
string |
Durée maximale d’exécution de la tâche, mesurée à partir du moment où la tâche démarre. Si la tâche ne se termine pas dans le délai imparti, le service Batch l’arrête. |
retentionTime |
string |
Durée minimale pour conserver le répertoire Task sur le nœud de calcul où il s’est exécuté, à partir du moment où il termine l’exécution. Passé ce délai, le service Batch peut supprimer le répertoire Task et tout son contenu. |
TaskContainerSettings
Paramètres de conteneur d’une tâche.
Nom | Type | Description |
---|---|---|
containerRunOptions |
string |
Options supplémentaires pour la commande de création de conteneur. |
imageName |
string |
Image à utiliser pour créer le conteneur dans lequel la tâche s’exécutera. |
registry |
Registre privé qui contient l’image conteneur. |
|
workingDirectory |
Emplacement du répertoire de travail de la tâche du conteneur. |
TaskDependencies
Spécifie toutes les dépendances d’une tâche. Toute tâche spécifiée explicitement ou dans une plage de dépendances doit se terminer avant que la tâche dépendante soit planifiée.
Nom | Type | Description |
---|---|---|
taskIdRanges |
Liste des plages d’ID de tâche dont dépend cette tâche. Toutes les tâches de toutes les plages doivent se terminer correctement avant que la tâche dépendante puisse être planifiée. |
|
taskIds |
string[] |
Liste des ID de tâche dont dépend cette tâche. Toutes les tâches de cette liste doivent se terminer correctement avant que la tâche dépendante puisse être planifiée. |
TaskIdRange
Plage d’ID de tâche dont une tâche peut dépendre. Toutes les tâches avec des ID dans la plage doivent se terminer correctement avant que la tâche dépendante puisse être planifiée.
Nom | Type | Description |
---|---|---|
end |
integer |
Dernier ID de tâche dans la plage. |
start |
integer |
Premier ID de tâche dans la plage. |
UserIdentity
Définition de l’identité de l’utilisateur sous laquelle la tâche est exécutée.
Nom | Type | Description |
---|---|---|
autoUser |
Utilisateur automatique sous lequel la tâche est exécutée. |
|
username |
string |
Nom de l’identité d’utilisateur sous laquelle la tâche est exécutée. |