Job - Add
Ajoute un travail au compte spécifié.
Le service Batch prend en charge deux façons de contrôler le travail effectué dans le cadre d’un travail. Dans la première approche, l’utilisateur spécifie une tâche du Gestionnaire de travaux. Le service Batch lance cette tâche lorsqu’il est prêt à démarrer le travail. La tâche du Gestionnaire de travaux contrôle toutes les autres tâches qui s’exécutent sous ce travail à l’aide des API de tâche. Dans la deuxième approche, l’utilisateur contrôle directement l’exécution des tâches sous un travail actif à l’aide des API de tâche. Notez également : lorsque vous nommez des travaux, évitez d’inclure des informations sensibles telles que des noms d’utilisateur ou des noms de projet secrets. Ces informations peuvent apparaître dans les journaux de télémétrie accessibles aux ingénieurs du support technique Microsoft.
POST {batchUrl}/jobs?api-version=2024-07-01.20.0
POST {batchUrl}/jobs?timeout={timeout}&api-version=2024-07-01.20.0
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
URL de base pour toutes les demandes de service Azure Batch. |
api-version
|
query | True |
string |
Version de l’API cliente. |
timeout
|
query |
integer int32 |
Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, la valeur par défaut est utilisée à la place. |
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Indique si le serveur doit retourner l’ID 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 de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST. |
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
id | True |
string |
Chaîne qui identifie de façon unique le travail dans le compte. |
poolInfo | True |
Pool sur lequel le service Batch exécute les tâches du travail. |
|
allowTaskPreemption |
boolean |
Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux à priorité élevée |
|
commonEnvironmentSettings |
Liste des paramètres courants des variables d’environnement. Ces variables d’environnement sont définies pour toutes les tâches du travail (y compris le Gestionnaire de travaux, la préparation du travail et les tâches de mise en production du travail). |
||
constraints |
Contraintes d’exécution pour un travail. |
||
displayName |
string |
Nom complet du travail. |
|
jobManagerTask |
Détails d’une tâche du Gestionnaire de travaux à lancer au démarrage du travail. |
||
jobPreparationTask |
Tâche de préparation du travail. |
||
jobReleaseTask |
Tâche de mise en production du travail. |
||
maxParallelTasks |
integer |
Nombre maximal de tâches qui peuvent être exécutées en parallèle pour le travail. |
|
metadata |
Liste des paires nom-valeur associées au travail en tant que métadonnées. |
||
networkConfiguration |
Configuration réseau du travail. |
||
onAllTasksComplete |
Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. |
||
onTaskFailure |
Action que le service Batch doit effectuer quand une tâche dans le travail échoue. |
||
priority |
integer |
Priorité du travail. |
|
usesTaskDependencies |
boolean |
Indique si les tâches du travail peuvent définir des dépendances entre elles. La valeur par défaut est false. |
Nom | Type | Description |
---|---|---|
201 Created |
La demande adressée au service Batch a réussi. En-têtes
|
|
Other Status Codes |
Erreur du service Batch. |
Flux de code d’authentification Microsoft Entra OAuth 2.0
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Type:
apiKey
Dans:
header
Exemple de requête
POST account.region.batch.azure.com/jobs?api-version=2024-07-01.20.0
{
"id": "jobId",
"priority": 0,
"poolInfo": {
"poolId": "poolId"
}
}
Exemple de réponse
Exemple de requête
POST account.region.batch.azure.com/jobs?api-version=2024-07-01.20.0
{
"id": "jobId",
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"jobManagerTask": {
"id": "taskId",
"commandLine": "myprogram.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
"filePath": "myprogram.exe"
},
{
"storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas",
"filePath": "datafolder"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": 0,
"retentionTime": "PT1H"
},
"requiredSlots": 2,
"killJobOnCompletion": false,
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"runExclusive": true
},
"poolInfo": {
"autoPoolSpecification": {
"autoPoolIdPrefix": "mypool",
"poolLifetimeOption": "job",
"pool": {
"vmSize": "STANDARD_D2S_V3",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
},
"nodePlacementConfiguration": {
"policy": "zonal"
}
},
"resizeTimeout": "PT15M",
"targetDedicatedNodes": 3,
"targetLowPriorityNodes": 0,
"taskSlotsPerNode": 2,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"enableAutoScale": false,
"enableInterNodeCommunication": true,
"startTask": {
"commandLine": "myprogram2.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
"filePath": "myprogram2.exe"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"maxTaskRetryCount": 2,
"waitForSuccess": true
},
"certificateReferences": [
{
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"thumbprintAlgorithm": "sha1",
"storeLocation": "localmachine",
"storeName": "Root",
"visibility": [
"task"
]
}
],
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
],
"targetNodeCommunicationMode": "default"
}
}
},
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
]
}
Exemple de réponse
Nom | Description |
---|---|
Access |
Ressources Batch auxquelles le jeton accorde l’accès. |
Application |
Référence à un package à déployer sur des 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. |
Automatic |
Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation. |
Auto |
Spécifie les caractéristiques d’un « pool automatique » temporaire. Le service Batch crée ce pool automatique lors de l’envoi du travail. |
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. |
Azure |
Informations utilisées pour se connecter à un conteneur de stockage Azure à l’aide d’Blobfuse. |
Azure |
Informations utilisées pour se connecter à un partage de fichiers Azure. |
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. |
Caching |
Type de mise en cache à activer pour le disque. |
Certificate |
Référence à un certificat à installer sur des nœuds de calcul dans un pool. |
Certificate |
Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. |
Certificate |
Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat. |
CIFSMount |
Informations utilisées pour se connecter à un système de fichiers CIFS. |
Compute |
Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. |
Compute |
Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera. |
Container |
Configuration des pools avec conteneur. |
Container |
Entrée du chemin d’accès et du mode montage que vous souhaitez monter dans le conteneur de tâches. |
Container |
Chemins d’accès qui seront montés sur le conteneur de la tâche de conteneur. |
Container |
Registre de conteneurs privé. |
Container |
Technologie de conteneur à utiliser. |
Container |
Emplacement du répertoire de travail de tâche de conteneur. |
Data |
Paramètres qui seront utilisés par les disques de données associés aux nœuds de calcul dans le pool. Lorsque vous utilisez des disques de données attachés, vous devez monter et mettre en forme les disques à partir d’une machine virtuelle pour les utiliser. |
Diff |
Spécifie le placement éphémère du disque du système d’exploitation pour tous les nœuds de calcul (machines virtuelles) du pool. |
Diff |
Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par le nœud de calcul (machine virtuelle). |
Disk |
Configuration de chiffrement de disque appliquée aux nœuds de calcul du pool. La configuration du chiffrement de disque n’est pas prise en charge sur le pool Linux créé avec l’image de la galerie de calcul Azure. |
Disk |
La liste des cibles de disque batch Service chiffre sur le nœud de calcul. |
Dynamic |
Étendue de l’attribution de réseau virtuel dynamique. |
Elevation |
Niveau d’élévation de l’utilisateur. |
Environment |
Variable d’environnement à définir sur un processus de tâche. |
Error |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
Http |
Paire nom-valeur d’en-tête HTTP |
Image |
Référence à une image de la Place de marché de machines virtuelles Azure ou à une image de galerie de calcul Azure. Pour obtenir la liste de toutes les références d’images de la Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ». |
Inbound |
Protocole du point de terminaison. |
Inbound |
Pool NAT entrant qui peut être utilisé pour traiter des ports spécifiques sur des nœuds de calcul dans un pool Batch en externe. |
IPAddress |
Type d’approvisionnement pour les adresses IP publiques pour le pool. |
Job |
Tâche Azure Batch à ajouter. |
Job |
Contraintes d’exécution pour un travail. |
Job |
Spécifie les détails d’une tâche du Gestionnaire de travaux. |
Job |
Configuration réseau du travail. |
Job |
Tâche de préparation du travail à exécuter avant toutes les tâches du travail sur un nœud de calcul donné. |
Job |
Tâche de mise en production du travail à exécuter sur n’importe quel nœud de calcul sur lequel le travail est exécuté. |
Linux |
Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Linux. |
Login |
Mode de connexion de l’utilisateur |
Managed |
|
Metadata |
Paire nom-valeur associée à une ressource de service Batch. |
Mount |
Système de fichiers à monter sur chaque nœud. |
Network |
Configuration réseau d’un pool. |
Network |
Règle de groupe de sécurité réseau à appliquer à un point de terminaison entrant. |
Network |
Action qui doit être effectuée pour une adresse IP, une plage de sous-réseaux ou une balise spécifiée. |
NFSMount |
Informations utilisées pour se connecter à un système de fichiers NFS. |
Node |
Détermine comment un pool communique avec le service Batch. |
Node |
Configuration de placement de nœud pour un pool. |
Node |
Stratégie de placement pour l’allocation de nœuds dans le pool. |
On |
Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. |
On |
Action que le service Batch doit effectuer quand une tâche dans le travail échoue. |
OSDisk |
Paramètres du disque du système d’exploitation du nœud de calcul (machine virtuelle). |
Output |
Spécification permettant de charger des fichiers à partir d’un nœud de calcul Azure Batch vers un autre emplacement une fois que le service Batch a terminé d’exécuter le processus de tâche. |
Output |
Spécifie une destination de chargement de fichier 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. |
Pool |
Configuration du point de terminaison pour un pool. |
Pool |
Spécifie comment un travail doit être affecté à un pool. |
Pool |
Durée de vie minimale des pools automatiques créés et comment plusieurs travaux sur une planification sont attribués aux pools. |
Pool |
Spécification pour la création d’un pool. |
Public |
Configuration d’adresse IP publique de la configuration réseau d’un pool. |
Resource |
Un seul fichier ou plusieurs fichiers à télécharger sur un nœud de calcul. |
Rolling |
Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée. |
Security |
Spécifie le EncryptionType du disque managé. Il est défini sur VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState. Remarque: elle peut être définie uniquement pour les machines virtuelles confidentielles et est requise lors de l’utilisation de machines virtuelles confidentielles. |
Security |
Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques. |
Security |
Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings. |
Service |
Spécifie l’ID de référence de l’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la version d’image la plus récente. |
Start |
Tâche exécutée lorsqu’un nœud joint un pool dans le service Azure Batch, ou lorsque le nœud de calcul est redémarré ou réinitialisé. |
Storage |
Type de compte de stockage à utiliser pour créer des disques de données ou un disque de système d’exploitation. |
Task |
Contraintes d’exécution à appliquer à une tâche. |
Task |
Paramètres de conteneur d’une tâche. |
Task |
Spécifie la façon dont les tâches doivent être distribuées entre les nœuds de calcul. |
Uefi |
Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. |
Upgrade |
Spécifie le mode d’une mise à niveau vers des machines virtuelles dans le groupe identique. |
Upgrade |
Décrit une stratégie de mise à niveau : automatique, manuelle ou propagée. |
User |
Propriétés utilisées pour créer un utilisateur utilisé pour exécuter des tâches sur un nœud de calcul Azure Batch. |
User |
Définition de l’identité de l’utilisateur sous laquelle la tâche est exécutée. |
Virtual |
Configuration des nœuds de calcul dans un pool en fonction de l’infrastructure des machines virtuelles Azure. |
VMDisk |
Spécifie les paramètres du profil de sécurité pour le disque managé. Remarque: elle ne peut être définie que pour les machines virtuelles confidentielles et requises lors de l’utilisation de machines virtuelles confidentielles. |
VMExtension |
Configuration des extensions de machine virtuelle. |
Windows |
Paramètres du système d’exploitation Windows à appliquer à la machine virtuelle. |
Windows |
Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Windows. |
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. |
Référence à un package à déployer sur des 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. |
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. |
Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation.
Nom | Type | Description |
---|---|---|
disableAutomaticRollback |
boolean |
Indique si la fonctionnalité de restauration d’image du système d’exploitation doit être désactivée. |
enableAutomaticOSUpgrade |
boolean |
Indique si les mises à niveau du système d’exploitation doivent être appliquées automatiquement aux instances de groupe identique de manière propagée lorsqu’une version plus récente de l’image du système d’exploitation devient disponible. |
osRollingUpgradeDeferral |
boolean |
Différer les mises à niveau du système d’exploitation sur les machines virtuelles si elles exécutent des tâches. |
useRollingUpgradePolicy |
boolean |
Indique si la stratégie de mise à niveau propagée doit être utilisée pendant la mise à niveau automatique du système d’exploitation. La mise à niveau automatique du système d’exploitation revient à la stratégie par défaut si aucune stratégie n’est définie sur vmSS. |
Spécifie les caractéristiques d’un « pool automatique » temporaire. Le service Batch crée ce pool automatique lors de l’envoi du travail.
Nom | Type | Description |
---|---|---|
autoPoolIdPrefix |
string |
Préfixe à ajouter à l’identificateur unique lorsqu’un pool est créé automatiquement. |
keepAlive |
boolean |
Indique s’il faut conserver un pool automatique actif après l’expiration de sa durée de vie. |
pool |
Spécification du pool pour le pool automatique. |
|
poolLifetimeOption |
Durée de vie minimale des pools automatiques créés et comment plusieurs travaux sur une planification sont attribués aux pools. |
É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 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. |
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 |
Informations utilisées pour se connecter à un conteneur de stockage Azure à l’aide d’Blobfuse.
Nom | Type | Description |
---|---|---|
accountKey |
string |
Clé de compte de stockage Azure. |
accountName |
string |
Nom du compte de stockage Azure. |
blobfuseOptions |
string |
Options de ligne de commande supplémentaires à passer à la commande de montage. |
containerName |
string |
Nom du conteneur stockage Blob Azure. |
identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à containerName |
|
relativeMountPath |
string |
Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté |
sasKey |
string |
Jeton SAP stockage Azure. |
Informations utilisées pour se connecter à un partage de fichiers Azure.
Nom | Type | Description |
---|---|---|
accountKey |
string |
Clé du compte stockage Azure. |
accountName |
string |
Nom du compte stockage Azure. |
azureFileUrl |
string |
URL Azure Files. |
mountOptions |
string |
Options de ligne de commande supplémentaires à passer à la commande de montage. |
relativeMountPath |
string |
Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté |
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 programme. |
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. |
É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. |
Type de mise en cache à activer pour le disque.
Nom | Type | Description |
---|---|---|
none |
string |
Le mode de mise en cache du disque n’est pas activé. |
readonly |
string |
Le mode de mise en cache du disque est en lecture seule. |
readwrite |
string |
Le mode de mise en cache du disque est en lecture et en écriture. |
Référence à un certificat à installer sur des nœuds de calcul dans un pool.
Nom | Type | Description |
---|---|---|
storeLocation |
Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. |
|
storeName |
string |
Nom du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. |
thumbprint |
string |
Empreinte numérique du certificat. |
thumbprintAlgorithm |
string |
Algorithme avec lequel l’empreinte numérique est associée. Cela doit être sha1. |
visibility |
Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat. |
Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat.
Nom | Type | Description |
---|---|---|
currentuser |
string |
Les certificats doivent être installés dans le magasin de certificats CurrentUser. |
localmachine |
string |
Les certificats doivent être installés dans le magasin de certificats LocalMachine. |
Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat.
Nom | Type | Description |
---|---|---|
remoteuser |
string |
Le certificat doit être visible pour les comptes d’utilisateur sous lesquels les utilisateurs accèdent à distance au nœud de calcul. |
starttask |
string |
Le certificat doit être visible pour le compte d’utilisateur sous lequel StartTask est exécuté. Notez que si l’étendue de l’utilisateur automatique est pool pour startTask et une tâche, ce certificat sera également visible pour la tâche. |
task |
string |
Le certificat doit être visible pour les comptes d’utilisateur sous lesquels les tâches de travail sont exécutées. |
Informations utilisées pour se connecter à un système de fichiers CIFS.
Nom | Type | Description |
---|---|---|
mountOptions |
string |
Options de ligne de commande supplémentaires à passer à la commande de montage. |
password |
string |
Mot de passe à utiliser pour l’authentification auprès du système de fichiers CIFS. |
relativeMountPath |
string |
Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté |
source |
string |
URI du système de fichiers à monter. |
username |
string |
Utilisateur à utiliser pour l’authentification auprès du système de fichiers CIFS. |
Comment les tâches sont distribuées entre les nœuds de calcul d’un pool.
Nom | Type | Description |
---|---|---|
pack |
string |
Autant de tâches que possible (taskSlotsPerNode) doivent être affectées à chaque nœud de calcul du pool avant que toutes les tâches ne soient affectées au nœud de calcul suivant dans le pool. |
spread |
string |
Les tâches doivent être affectées uniformément sur tous les nœuds de calcul du pool. |
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. |
Configuration des pools avec conteneur.
Nom | Type | Description |
---|---|---|
containerImageNames |
string[] |
Collection de noms d’images conteneur. |
containerRegistries |
Registres privés supplémentaires à partir desquels les conteneurs peuvent être extraits. |
|
type |
Technologie de conteneur à utiliser. |
Entrée du chemin d’accès et du mode montage que vous souhaitez monter dans le conteneur de tâches.
Nom | Type | Description |
---|---|---|
isReadOnly |
boolean |
Montez ce chemin source en mode lecture seule ou non. La valeur par défaut est false (mode lecture/écriture). |
source |
Le chemin d’accès à monter sur le client conteneur peut être sélectionné. |
Chemins d’accès qui seront montés sur le conteneur de la tâche de conteneur.
Nom | Type | Description |
---|---|---|
Applications |
string |
Chemin d’accès des applications. |
JobPrep |
string |
Chemin de la tâche de préparation du travail. |
Shared |
string |
Chemin d’accès de la tâche multi-instances pour partager leurs fichiers. |
Startup |
string |
Chemin d’accès de la tâche de démarrage. |
Task |
string |
Chemin d’accès de la tâche. |
VfsMounts |
string |
Le chemin d’accès contient tous les systèmes de fichiers virtuels sont montés sur ce nœud. |
Registre de conteneurs privé.
Nom | Type | Description |
---|---|---|
identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à azure Container Registry au lieu du nom d’utilisateur et du mot de passe. |
|
password |
string |
Mot de passe pour vous connecter au serveur de Registre. |
registryServer |
string |
URL du Registre. |
username |
string |
Nom d’utilisateur à connecter au serveur de Registre. |
Technologie de conteneur à utiliser.
Nom | Type | Description |
---|---|---|
criCompatible |
string |
Une technologie basée sur CRI sera utilisée pour lancer les conteneurs. |
dockerCompatible |
string |
Une technologie de conteneur compatible Docker sera utilisée pour lancer les conteneurs. |
Emplacement du répertoire de travail de tâche de 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 de tâche du service Batch standard, qui contiendra les fichiers de ressources de tâche renseignés par Batch. |
Paramètres qui seront utilisés par les disques de données associés aux nœuds de calcul dans le pool. Lorsque vous utilisez des disques de données attachés, vous devez monter et mettre en forme les disques à partir d’une machine virtuelle pour les utiliser.
Nom | Type | Description |
---|---|---|
caching |
Type de mise en cache à activer pour les disques de données. |
|
diskSizeGB |
integer |
Taille du disque initial en gigaoctets. |
lun |
integer |
Numéro d’unité logique. |
storageAccountType |
Type de compte de stockage à utiliser pour le disque de données. |
Spécifie le placement éphémère du disque du système d’exploitation pour tous les nœuds de calcul (machines virtuelles) du pool.
Nom | Type | Description |
---|---|---|
CacheDisk |
string |
Le disque de système d’exploitation éphémère est stocké sur le cache de la machine virtuelle. |
Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par le nœud de calcul (machine virtuelle).
Nom | Type | Description |
---|---|---|
placement |
Spécifie le placement éphémère du disque du système d’exploitation pour toutes les machines virtuelles du pool. |
Configuration de chiffrement de disque appliquée aux nœuds de calcul du pool. La configuration du chiffrement de disque n’est pas prise en charge sur le pool Linux créé avec l’image de la galerie de calcul Azure.
Nom | Type | Description |
---|---|---|
targets |
La liste des cibles de disque batch Service chiffre sur le nœud de calcul. |
La liste des cibles de disque batch Service chiffre sur le nœud de calcul.
Nom | Type | Description |
---|---|---|
osdisk |
string |
Le disque du système d’exploitation sur le nœud de calcul est chiffré. |
temporarydisk |
string |
Le disque temporaire sur le nœud de calcul est chiffré. Sur Linux, ce chiffrement s’applique à d’autres partitions (telles que celles sur des disques de données montés) lorsque le chiffrement se produit au moment du démarrage. |
Étendue de l’attribution de réseau virtuel dynamique.
Nom | Type | Description |
---|---|---|
job |
string |
L’attribution de réseau virtuel dynamique est effectuée par travail. |
none |
string |
Aucune attribution de réseau virtuel dynamique n’est activée. |
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é. |
Variable d’environnement à définir sur un processus de tâche.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la variable d’environnement. |
value |
string |
Valeur de la variable d’environnement. |
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. |
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 |
Référence à une image de la Place de marché de machines virtuelles Azure ou à une image de galerie de calcul Azure. Pour obtenir la liste de toutes les références d’images de la Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ».
Nom | Type | Description |
---|---|---|
communityGalleryImageId |
string |
Identificateur unique de l’image de la galerie de communautés |
exactVersion |
string |
Version spécifique de l’image de plateforme ou de la place de marché utilisée pour créer le nœud. Ce champ en lecture seule diffère de « version » uniquement si la valeur spécifiée pour « version » lorsque le pool a été créé était « latest ». |
offer |
string |
Type d’offre de l’image de la Place de marché des machines virtuelles Azure. |
publisher |
string |
Éditeur de l’image de la Place de marché des machines virtuelles Azure. |
sharedGalleryImageId |
string |
Identificateur unique de l’image de la galerie partagée |
sku |
string |
Référence SKU de l’image de la Place de marché des machines virtuelles Azure. |
version |
string |
Version de l’image de la Place de marché des machines virtuelles Azure. |
virtualMachineImageId |
string |
Identificateur de ressource ARM de l’image de la galerie de calcul Azure. Les nœuds de calcul du pool sont créés à l’aide de cet ID d’image. Il s’agit de la forme /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pour toujours la dernière version d’image. |
Protocole du point de terminaison.
Nom | Type | Description |
---|---|---|
tcp |
string |
Utilisez TCP pour le point de terminaison. |
udp |
string |
Utilisez UDP pour le point de terminaison. |
Pool NAT entrant qui peut être utilisé pour traiter des ports spécifiques sur des nœuds de calcul dans un pool Batch en externe.
Nom | Type | Description |
---|---|---|
backendPort |
integer |
Numéro de port sur le nœud de calcul. |
frontendPortRangeEnd |
integer |
Le dernier numéro de port de la plage de ports externes qui sera utilisé pour fournir un accès entrant au backendPort sur des nœuds de calcul individuels. |
frontendPortRangeStart |
integer |
Premier numéro de port dans la plage de ports externes qui seront utilisés pour fournir un accès entrant au backendPort sur des nœuds de calcul individuels. |
name |
string |
Nom du point de terminaison. |
networkSecurityGroupRules |
Liste des règles de groupe de sécurité réseau qui seront appliquées au point de terminaison. |
|
protocol |
Protocole du point de terminaison. |
Type d’approvisionnement pour les adresses IP publiques pour le pool.
Nom | Type | Description |
---|---|---|
batchmanaged |
string |
Une adresse IP publique sera créée et gérée par Batch. Il peut y avoir plusieurs adresses IP publiques en fonction de la taille du pool. |
nopublicipaddresses |
string |
Aucune adresse IP publique n’est créée. |
usermanaged |
string |
Les adresses IP publiques sont fournies par l’utilisateur et seront utilisées pour approvisionner les nœuds de calcul. |
Tâche Azure Batch à ajouter.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux à priorité élevée |
|
commonEnvironmentSettings |
Liste des paramètres courants des variables d’environnement. Ces variables d’environnement sont définies pour toutes les tâches du travail (y compris le Gestionnaire de travaux, la préparation du travail et les tâches de mise en production du travail). |
||
constraints |
Contraintes d’exécution pour un travail. |
||
displayName |
string |
Nom complet du travail. |
|
id |
string |
Chaîne qui identifie de façon unique le travail dans le compte. |
|
jobManagerTask |
Détails d’une tâche du Gestionnaire de travaux à lancer au démarrage du travail. |
||
jobPreparationTask |
Tâche de préparation du travail. |
||
jobReleaseTask |
Tâche de mise en production du travail. |
||
maxParallelTasks |
integer |
-1 |
Nombre maximal de tâches qui peuvent être exécutées en parallèle pour le travail. |
metadata |
Liste des paires nom-valeur associées au travail en tant que métadonnées. |
||
networkConfiguration |
Configuration réseau du travail. |
||
onAllTasksComplete |
Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. |
||
onTaskFailure |
Action que le service Batch doit effectuer quand une tâche dans le travail échoue. |
||
poolInfo |
Pool sur lequel le service Batch exécute les tâches du travail. |
||
priority |
integer |
Priorité du travail. |
|
usesTaskDependencies |
boolean |
Indique si les tâches du travail peuvent définir des dépendances entre elles. La valeur par défaut est false. |
Contraintes d’exécution pour un travail.
Nom | Type | Description |
---|---|---|
maxTaskRetryCount |
integer |
Le nombre maximal de fois où chaque tâche peut être retentée. Le service Batch retente une tâche si son code de sortie n’est pas différent de zéro. |
maxWallClockTime |
string |
Temps écoulé maximal pendant lequel le travail peut s’exécuter, mesuré à partir du moment où le travail est créé. |
Spécifie les détails d’une tâche du Gestionnaire de travaux.
Nom | Type | Description |
---|---|---|
allowLowPriorityNode |
boolean |
Indique si la tâche du Gestionnaire de travaux peut s’exécuter sur un nœud de calcul spot/basse priorité. |
applicationPackageReferences |
Liste des packages d’application que le service Batch déploie 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 du Gestionnaire de travaux. |
constraints |
Contraintes qui s’appliquent à la tâche du Gestionnaire de travaux. |
|
containerSettings |
Paramètres du conteneur sous lequel la tâche du Gestionnaire de travaux s’exécute. |
|
displayName |
string |
Nom complet de la tâche du Gestionnaire de travaux. |
environmentSettings |
Liste des paramètres de variable d’environnement pour la tâche du Gestionnaire de travaux. |
|
id |
string |
Chaîne qui identifie de façon unique la tâche du Gestionnaire de travaux dans le travail. |
killJobOnCompletion |
boolean |
Indique si l’achèvement de la tâche du Gestionnaire de travaux signifie l’achèvement de l’intégralité du travail. |
outputFiles |
Liste des fichiers que le service Batch charge à partir du nœud de calcul après avoir exécuté 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écharge sur le nœud de calcul avant d’exécuter la ligne de commande. |
|
runExclusive |
boolean |
Indique si la tâche du Gestionnaire de travaux nécessite une utilisation exclusive du nœud de calcul où elle s’exécute. |
userIdentity |
Identité de l’utilisateur sous laquelle la tâche du Gestionnaire de travaux s’exécute. |
Configuration réseau du travail.
Nom | Type | Description |
---|---|---|
skipWithdrawFromVNet |
boolean |
Supprimez ou supprimez les nœuds de calcul du réseau virtuel vers DNC lorsque le travail est arrêté ou supprimé. |
subnetId |
string |
Identificateur de ressource ARM du sous-réseau de réseau virtuel auquel les nœuds de calcul exécutant des tâches à partir du travail se joignent pendant la durée de la tâche. |
Tâche de préparation du travail à exécuter avant toutes les tâches du travail sur un nœud de calcul donné.
Nom | Type | Description |
---|---|---|
commandLine |
string |
Ligne de commande de la tâche de préparation du travail. |
constraints |
Contraintes qui s’appliquent à la tâche de préparation du travail. |
|
containerSettings |
Paramètres du conteneur sous lequel la tâche de préparation du travail s’exécute. |
|
environmentSettings |
Liste des paramètres de variable d’environnement pour la tâche de préparation du travail. |
|
id |
string |
Chaîne qui identifie de façon unique la tâche de préparation du travail dans le travail. |
rerunOnNodeRebootAfterSuccess |
boolean |
Indique si le service Batch doit réexécuter la tâche de préparation du travail après un redémarrage d’un nœud de calcul. |
resourceFiles |
Liste des fichiers que le service Batch télécharge sur le nœud de calcul avant d’exécuter la ligne de commande. |
|
userIdentity |
Identité de l’utilisateur sous laquelle la tâche de préparation du travail s’exécute. |
|
waitForSuccess |
boolean |
Indique si le service Batch doit attendre que la tâche de préparation du travail se termine correctement avant de planifier les autres tâches du travail sur le nœud de calcul. Une tâche de préparation du travail s’est terminée correctement si elle se termine avec le code de sortie 0. |
Tâche de mise en production du travail à exécuter sur n’importe quel nœud de calcul sur lequel le travail est exécuté.
Nom | Type | Description |
---|---|---|
commandLine |
string |
Ligne de commande de la tâche de mise en production du travail. |
containerSettings |
Paramètres du conteneur sous lequel la tâche de mise en production du travail s’exécute. |
|
environmentSettings |
Liste des paramètres de variable d’environnement pour la tâche de mise en production du travail. |
|
id |
string |
Chaîne qui identifie de façon unique la tâche de mise en production du travail dans le travail. |
maxWallClockTime |
string |
Durée maximale écoulée pendant laquelle la tâche de mise en production du travail peut s’exécuter sur un nœud de calcul donné, 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. La valeur par défaut est de 15 minutes. Vous ne pouvez pas spécifier un délai d’expiration de plus de 15 minutes. Si vous le faites, le service Batch le rejette avec une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). |
resourceFiles |
Liste des fichiers que le service Batch télécharge sur le nœud de calcul avant d’exécuter la ligne de commande. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la requête échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Pour ce faire, vous pouvez utiliser des fichiers .zip, des packages d’application ou des conteneurs Docker. |
|
retentionTime |
string |
Durée minimale de conservation du répertoire des tâches pour la tâche de mise en production du travail sur le nœud de calcul. Après cette période, le service Batch peut supprimer le répertoire des tâches et tout son contenu. |
userIdentity |
Identité de l’utilisateur sous laquelle la tâche de mise en production du travail s’exécute. |
Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Linux.
Nom | Type | Description |
---|---|---|
gid |
integer |
ID de groupe du compte d’utilisateur. |
sshPrivateKey |
string |
Clé privée SSH pour le compte d’utilisateur. |
uid |
integer |
ID d’utilisateur du compte d’utilisateur. |
Mode de connexion de l’utilisateur
Nom | Type | Description |
---|---|---|
batch |
string |
Mode de connexion Win32 LOGON32_LOGON_BATCH. Le mode de connexion par lots est recommandé pour les processus parallèles longs. |
interactive |
string |
Mode de connexion Win32 LOGON32_LOGON_INTERACTIVE. L’UAC est activée sur les pools Windows. Si cette option est utilisée avec une identité utilisateur avec élévation de privilèges dans un pool Windows, la session utilisateur n’est pas élevée, sauf si l’application exécutée par la ligne de commande de tâche est configurée pour toujours exiger des privilèges d’administration ou pour exiger toujours un privilège maximal. |
Nom | Type | Description |
---|---|---|
securityProfile |
Spécifie les paramètres du profil de sécurité pour le disque managé. |
|
storageAccountType |
Type de compte de stockage pour disque managé. |
Paire nom-valeur associée à une ressource de service Batch.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de l’élément de métadonnées. |
value |
string |
Valeur de l’élément de métadonnées. |
Système de fichiers à monter sur chaque nœud.
Nom | Type | Description |
---|---|---|
azureBlobFileSystemConfiguration |
Conteneur de stockage Azure à monter à l’aide de FUSE d’objet blob sur chaque nœud. |
|
azureFileShareConfiguration |
Partage de fichiers Azure à monter sur chaque nœud. |
|
cifsMountConfiguration |
Système de fichiers CIFS/SMB à monter sur chaque nœud. |
|
nfsMountConfiguration |
Système de fichiers NFS à monter sur chaque nœud. |
Configuration réseau d’un pool.
Nom | Type | Description |
---|---|---|
dynamicVNetAssignmentScope |
Étendue de l’attribution de réseau virtuel dynamique. |
|
enableAcceleratedNetworking |
boolean |
Indique si ce pool doit activer la mise en réseau accélérée. |
endpointConfiguration |
Configuration des points de terminaison sur les nœuds de calcul dans le pool Batch. |
|
publicIPAddressConfiguration |
Configuration IPAddress publique pour les nœuds de calcul dans le pool Batch. |
|
subnetId |
string |
Identificateur de ressource ARM du sous-réseau de réseau virtuel auquel les nœuds de calcul du pool se joignent. Il s’agit de la forme /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
Règle de groupe de sécurité réseau à appliquer à un point de terminaison entrant.
Nom | Type | Description |
---|---|---|
access |
Action qui doit être effectuée pour une adresse IP, une plage de sous-réseaux ou une balise spécifiée. |
|
priority |
integer |
Priorité de cette règle. |
sourceAddressPrefix |
string |
Préfixe ou balise d’adresse source à mettre en correspondance pour la règle. |
sourcePortRanges |
string[] |
Plages de ports sources à mettre en correspondance pour la règle. |
Action qui doit être effectuée pour une adresse IP, une plage de sous-réseaux ou une balise spécifiée.
Nom | Type | Description |
---|---|---|
allow |
string |
Autoriser l’accès. |
deny |
string |
Refuser l’accès. |
Informations utilisées pour se connecter à un système de fichiers NFS.
Nom | Type | Description |
---|---|---|
mountOptions |
string |
Options de ligne de commande supplémentaires à passer à la commande de montage. |
relativeMountPath |
string |
Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté |
source |
string |
URI du système de fichiers à monter. |
Détermine comment un pool communique avec le service Batch.
Nom | Type | Description |
---|---|---|
classic |
string |
Les nœuds utilisant le mode de communication classique nécessitent une communication TCP entrante sur les ports 29876 et 29877 à partir du « BatchNodeManagement ». Balise de service {region} » et communication TCP sortante sur le port 443 vers « Storage.region » et « BatchNodeManagement ». Balises de service {region}". |
default |
string |
Le mode de communication de nœud est automatiquement défini par le service Batch. |
simplified |
string |
Les nœuds utilisant le mode de communication simplifié nécessitent une communication TCP sortante sur le port 443 vers le « BatchNodeManagement ». Balise de service {region}". Aucun port entrant ouvert n’est requis. |
Configuration de placement de nœud pour un pool.
Nom | Type | Description |
---|---|---|
policy |
Type de stratégie de placement de nœud sur les pools Batch. |
Stratégie de placement pour l’allocation de nœuds dans le pool.
Nom | Type | Description |
---|---|---|
regional |
string |
Tous les nœuds du pool seront alloués dans la même région. |
zonal |
string |
Les nœuds du pool sont répartis entre différentes zones de disponibilité avec un équilibrage de l’effort optimal. |
Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé.
Nom | Type | Description |
---|---|---|
noaction |
string |
Ne fais rien. La tâche reste active, sauf si elle est arrêtée ou désactivée par d’autres moyens. |
terminatejob |
string |
Terminez le travail. L’élément terminateReason du travail est défini sur « AllTasksComplete ». |
Action que le service Batch doit effectuer quand une tâche dans le travail échoue.
Nom | Type | Description |
---|---|---|
noaction |
string |
Ne fais rien. La tâche reste active, sauf si elle est arrêtée ou désactivée par d’autres moyens. |
performexitoptionsjobaction |
string |
Effectuez l’action associée à la condition de sortie de tâche dans la collection exitConditions de la tâche. (Cela peut toujours entraîner l’absence d’action effectuée, si c’est ce que la tâche spécifie.) |
Paramètres du disque du système d’exploitation du nœud de calcul (machine virtuelle).
Nom | Type | Description |
---|---|---|
caching |
Spécifie les exigences de mise en cache. Les valeurs possibles sont : None, ReadOnly, ReadWrite. Les valeurs par défaut sont : Aucune pour le stockage Standard. ReadOnly pour le stockage Premium. |
|
diskSizeGB |
integer |
Taille initiale du disque en Go lors de la création d’un disque de système d’exploitation. |
ephemeralOSDiskSettings |
Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par le nœud de calcul (machine virtuelle). |
|
managedDisk |
Paramètres de disque managé. |
|
writeAcceleratorEnabled |
boolean |
Spécifie si writeAccelerator doit être activé ou désactivé sur le disque. |
Spécification permettant de charger des fichiers à partir d’un nœud de calcul Azure Batch vers un autre emplacement une fois que le service Batch a terminé d’exécuter le processus de tâche.
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. |
Spécifie une destination de chargement de fichier dans un conteneur de stockage d’objets blob Azure.
Nom | Type | Description |
---|---|---|
containerUrl |
string |
URL du conteneur dans Stockage Blob Azure vers lequel charger le ou les fichiers. |
identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder au stockage Blob Azure spécifié 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 de fichiers de sortie |
Destination vers laquelle un fichier doit être chargé.
Nom | Type | Description |
---|---|---|
container |
Emplacement dans stockage d’objets blob Azure vers lequel les fichiers sont chargés. |
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 de tâche terminé, quel que soit le code de sortie. |
taskfailure |
string |
Chargez le ou les fichiers uniquement une fois le processus de tâche terminé avec un code de sortie différent de zéro. |
tasksuccess |
string |
Chargez le ou les fichiers uniquement une fois le processus de tâche terminé avec un code de sortie de 0. |
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 doivent être chargés. |
Configuration du point de terminaison pour un pool.
Nom | Type | Description |
---|---|---|
inboundNATPools |
Liste des pools NAT entrants qui peuvent être utilisés pour traiter des ports spécifiques sur un nœud de calcul individuel en externe. |
Spécifie comment un travail doit être affecté à un pool.
Nom | Type | Description |
---|---|---|
autoPoolSpecification |
Caractéristiques d’un « pool automatique » temporaire. Le service Batch crée ce pool automatique lors de l’envoi du travail. |
|
poolId |
string |
ID d’un pool existant. Toutes les tâches du travail s’exécutent sur le pool spécifié. |
Durée de vie minimale des pools automatiques créés et comment plusieurs travaux sur une planification sont attribués aux pools.
Nom | Type | Description |
---|---|---|
job |
string |
Le pool existe pour la durée de vie du travail auquel il est dédié. Le service Batch crée le pool lorsqu’il crée le travail. Si l’option « job » est appliquée à une planification de travaux, le service Batch crée un pool automatique pour chaque travail créé à la planification. |
jobschedule |
string |
Le pool existe pendant toute la durée de vie de la planification du travail. Le service Batch crée le pool lorsqu’il crée le premier travail à la planification. Vous pouvez appliquer cette option uniquement aux planifications de travaux, et non aux travaux. |
Spécification pour la création d’un pool.
Nom | Type | Description |
---|---|---|
applicationPackageReferences |
Liste des packages à installer sur chaque nœud de calcul du pool. |
|
autoScaleEvaluationInterval |
string |
Intervalle de temps auquel ajuster automatiquement la taille du pool en fonction de la formule de mise à l’échelle automatique. |
autoScaleFormula |
string |
Formule pour le nombre souhaité de nœuds de calcul dans le pool. |
certificateReferences |
Liste des certificats à installer sur chaque nœud de calcul du pool. Avertissement : cette propriété est déconseillée et sera supprimée après février 2024. Utilisez plutôt l''extension Azure KeyVault. |
|
displayName |
string |
Nom complet du pool. |
enableAutoScale |
boolean |
Indique si la taille du pool doit être ajustée automatiquement au fil du temps. |
enableInterNodeCommunication |
boolean |
Indique si le pool autorise la communication directe entre les nœuds de calcul. |
metadata |
Liste des paires nom-valeur associées au pool en tant que métadonnées. |
|
mountConfiguration |
Liste des systèmes de fichiers à monter sur chaque nœud du pool. |
|
networkConfiguration |
Configuration réseau du pool. |
|
resizeTimeout |
string |
Délai d’expiration pour l’allocation de nœuds de calcul au pool. |
resourceTags |
object |
Balises spécifiées par l’utilisateur associées au pool. |
startTask |
Tâche à exécuter sur chaque nœud de calcul au fur et à mesure qu’elle rejoint le pool. La tâche s’exécute lorsque le nœud de calcul est ajouté au pool ou lorsque le nœud de calcul est redémarré. |
|
targetDedicatedNodes |
integer |
Nombre souhaité de nœuds de calcul dédiés dans le pool. |
targetLowPriorityNodes |
integer |
Nombre souhaité de nœuds de calcul Spot/Basse priorité dans le pool. |
targetNodeCommunicationMode |
Mode de communication de nœud souhaité pour le pool. |
|
taskSchedulingPolicy |
Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. |
|
taskSlotsPerNode |
integer |
Nombre d’emplacements de tâche qui peuvent être utilisés pour exécuter des tâches simultanées sur un nœud de calcul unique dans le pool. |
upgradePolicy |
Stratégie de mise à niveau pour le pool. |
|
userAccounts |
Liste des comptes d’utilisateur à créer sur chaque nœud de calcul du pool. |
|
virtualMachineConfiguration |
Configuration de la machine virtuelle pour le pool. |
|
vmSize |
string |
Taille des machines virtuelles dans le pool. Toutes les machines virtuelles d’un pool sont de la même taille. |
Configuration d’adresse IP publique de la configuration réseau d’un pool.
Nom | Type | Description |
---|---|---|
ipAddressIds |
string[] |
Liste des adresses IP publiques que le service Batch utilisera lors de l’approvisionnement de nœuds de calcul. |
provision |
Type d’approvisionnement pour les adresses IP publiques pour le pool. |
Un seul fichier 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 les noms commencent 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 au stockage Blob Azure spécifié par storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
URL du conteneur d’objets blob dans Stockage Blob Azure. |
Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée.
Nom | Type | Description |
---|---|---|
enableCrossZoneUpgrade |
boolean |
Autorisez VMSS à ignorer les limites AZ lors de la construction de lots de mise à niveau. Prenez en compte le domaine de mise à jour et maxBatchInstancePercent pour déterminer la taille du lot. Ce champ peut être défini sur true ou false uniquement lors de l’utilisation de NodePlacementConfiguration comme Zonal. |
maxBatchInstancePercent |
integer |
Pourcentage maximal d’instances de machines virtuelles totales qui seront mises à niveau simultanément par la mise à niveau propagée dans un lot. Comme il s’agit d’un nombre maximal d’instances non saines dans les lots précédents ou futurs, le pourcentage d’instances d’un lot peut diminuer pour garantir une fiabilité plus élevée. La valeur de ce champ doit être comprise entre 5 et 100, inclus. Si maxBatchInstancePercent et maxUnhealthyInstancePercent sont attribués avec la valeur, la valeur de maxBatchInstancePercent ne doit pas être supérieure à maxUnhealthyInstancePercent. |
maxUnhealthyInstancePercent |
integer |
Pourcentage maximal des instances de machine virtuelle totales dans le groupe identique qui peuvent être simultanément non saines, soit en raison d’une mise à niveau, soit en étant trouvées dans un état non sain par les vérifications d’intégrité de la machine virtuelle avant l’abandon de la mise à niveau propagée. Cette contrainte sera vérifiée avant de démarrer un lot. La valeur de ce champ doit être comprise entre 5 et 100, inclus. Si maxBatchInstancePercent et maxUnhealthyInstancePercent sont attribués avec la valeur, la valeur de maxBatchInstancePercent ne doit pas être supérieure à maxUnhealthyInstancePercent. |
maxUnhealthyUpgradedInstancePercent |
integer |
Pourcentage maximal d’instances de machine virtuelle mises à niveau qui peuvent être trouvées dans un état non sain. Cette vérification se produit après la mise à niveau de chaque lot. Si ce pourcentage est jamais dépassé, la mise à jour propagée abandonne. La valeur de ce champ doit être comprise entre 0 et 100, inclus. |
pauseTimeBetweenBatches |
string |
Délai d’attente entre la fin de la mise à jour pour toutes les machines virtuelles d’un lot et le démarrage du lot suivant. La durée doit être spécifiée au format ISO 8601. |
prioritizeUnhealthyInstances |
boolean |
Mettez à niveau toutes les instances non saines dans un groupe identique avant toutes les instances saines. |
rollbackFailedInstancesOnPolicyBreach |
boolean |
Échec de restauration des instances dans le modèle précédent si la stratégie de mise à niveau propagée est enfreinte. |
Spécifie le EncryptionType du disque managé. Il est défini sur VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState. Remarque: elle peut être définie uniquement pour les machines virtuelles confidentielles et est requise lors de l’utilisation de machines virtuelles confidentielles.
Nom | Type | Description |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques.
Nom | Type | Description |
---|---|---|
encryptionAtHost |
boolean |
Cette propriété peut être utilisée par l’utilisateur dans la demande pour activer ou désactiver le chiffrement de l’hôte pour la machine virtuelle ou le groupe de machines virtuelles identiques. Cela active le chiffrement pour tous les disques, y compris le disque Resource/Temp sur l’hôte lui-même. Pour plus d’informations sur le chiffrement aux exigences de l’hôte, reportez-vous à https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. |
securityType |
Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings. |
|
uefiSettings |
Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle. |
Spécifie le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer UefiSettings.
Nom | Type | Description |
---|---|---|
confidentialVM |
string |
L’informatique confidentielle Azure offre des machines virtuelles confidentielles pour les locataires avec des exigences de sécurité et de confidentialité élevées. Ces machines virtuelles fournissent une limite forte et matérielle appliquée pour répondre à vos besoins de sécurité. Vous pouvez utiliser des machines virtuelles confidentielles pour les migrations sans apporter de modifications à votre code, avec la plateforme protégeant l’état de votre machine virtuelle contre la lecture ou la modification. |
trustedLaunch |
string |
Le lancement approuvé protège contre les techniques d’attaque avancées et persistantes. |
Spécifie l’ID de référence de l’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la version d’image la plus récente.
Nom | Type | Description |
---|---|---|
id |
string |
ID de référence de l’artefact de service de ServiceArtifactReference |
Tâche exécutée lorsqu’un nœud joint un pool dans le service Azure Batch, ou lorsque le nœud de calcul est redémarré ou réinitialisé.
Nom | Type | Description |
---|---|---|
commandLine |
string |
Ligne de commande de StartTask. |
containerSettings |
Paramètres du conteneur sous lequel StartTask s’exécute. |
|
environmentSettings |
Liste des paramètres de variable d’environnement pour StartTask. |
|
maxTaskRetryCount |
integer |
Nombre maximal de nouvelles tentatives de la tâche. |
resourceFiles |
Liste des fichiers que le service Batch télécharge sur le nœud de calcul avant d’exécuter la ligne de commande. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la requête échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Pour ce faire, vous pouvez utiliser des fichiers .zip, des packages d’application ou des conteneurs Docker. |
|
userIdentity |
Identité de l’utilisateur sous laquelle StartTask s’exécute. |
|
waitForSuccess |
boolean |
Indique si le service Batch doit attendre que StartTask se termine correctement (autrement dit, pour quitter avec le code de sortie 0) avant de planifier des tâches sur le nœud de calcul. |
Type de compte de stockage à utiliser pour créer des disques de données ou un disque de système d’exploitation.
Nom | Type | Description |
---|---|---|
premium_lrs |
string |
Le disque de données/disque du système d’exploitation doit utiliser un stockage premium localement redondant. |
standard_lrs |
string |
Le disque de données/disque du système d’exploitation doit utiliser un stockage localement redondant standard. |
standardssd_lrs |
string |
Le disque de données/disque du système d’exploitation doit utiliser un stockage SSD standard localement redondant. |
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 n’est pas différent de zéro. |
maxWallClockTime |
string |
Durée maximale écoulée pendant laquelle la tâche peut s’exécuter, 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 de conservation du répertoire des tâches sur le nœud de calcul où elle s’est exécutée, à partir du moment où elle termine l’exécution. Après cette période, le service Batch peut supprimer le répertoire des tâches et tout son contenu. |
Paramètres de conteneur d’une tâche.
Nom | Type | Description |
---|---|---|
containerHostBatchBindMounts |
Chemins que vous souhaitez monter sur la tâche conteneur. |
|
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 tâche de conteneur. |
Spécifie la façon dont les tâches doivent être distribuées entre les nœuds de calcul.
Nom | Type | Description |
---|---|---|
nodeFillType |
Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. |
Spécifie les paramètres de sécurité tels que le démarrage sécurisé et vTPM utilisés lors de la création de la machine virtuelle.
Nom | Type | Description |
---|---|---|
secureBootEnabled |
boolean |
Spécifie si le démarrage sécurisé doit être activé sur la machine virtuelle. |
vTpmEnabled |
boolean |
Spécifie si vTPM doit être activé sur la machine virtuelle. |
Spécifie le mode d’une mise à niveau vers des machines virtuelles dans le groupe identique.
Les valeurs possibles sont les suivantes :
manuel : vous contrôlez l’application des mises à jour des machines virtuelles dans le groupe identique. Pour ce faire, utilisez l’action manualUpgrade.
automatique : toutes les machines virtuelles du groupe identique sont automatiquement mises à jour en même temps.
rolling - Le groupe identique effectue des mises à jour par lots avec une durée de pause facultative entre les deux.
Nom | Type | Description |
---|---|---|
automatic |
string |
Toutes les machines virtuelles du groupe identique sont automatiquement mises à jour en même temps. |
manual |
string |
Vous contrôlez l’application des mises à jour des machines virtuelles dans le groupe identique. Pour ce faire, utilisez l’action manualUpgrade. |
rolling |
string |
Les instances existantes d’un groupe identique sont supprimées par lots pour être mises à niveau. Une fois le lot mis à niveau terminé, les instances commencent à reprendre le trafic et le lot suivant commence. Cela se poursuit jusqu’à ce que toutes les instances ont apporté up-to-date. |
Décrit une stratégie de mise à niveau : automatique, manuelle ou propagée.
Nom | Type | Description |
---|---|---|
automaticOSUpgradePolicy |
Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation. |
|
mode |
Spécifie le mode d’une mise à niveau vers des machines virtuelles dans le groupe identique. |
|
rollingUpgradePolicy |
Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée. |
Propriétés utilisées pour créer un utilisateur utilisé pour exécuter des tâches sur un nœud de calcul Azure Batch.
Nom | Type | Description |
---|---|---|
elevationLevel |
Niveau d’élévation du compte d’utilisateur. |
|
linuxUserConfiguration |
Configuration utilisateur spécifique à Linux pour le compte d’utilisateur. |
|
name |
string |
Nom du compte d’utilisateur. Les noms peuvent contenir n’importe quel caractère Unicode jusqu’à une longueur maximale de 20. |
password |
string |
Mot de passe du compte d’utilisateur. |
windowsUserConfiguration |
Configuration utilisateur spécifique à Windows pour le compte d’utilisateur. |
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é utilisateur sous laquelle la tâche est exécutée. |
Configuration des nœuds de calcul dans un pool en fonction de l’infrastructure des machines virtuelles Azure.
Nom | Type | Description |
---|---|---|
containerConfiguration |
Configuration du conteneur pour le pool. |
|
dataDisks |
Data |
Configuration des disques de données attachés aux nœuds de calcul du pool. |
diskEncryptionConfiguration |
Configuration du chiffrement de disque pour le pool. |
|
extensions |
Extension de machine virtuelle pour le pool. |
|
imageReference |
Référence à l’image de la Place de marché des machines virtuelles Azure ou à l’image de machine virtuelle personnalisée à utiliser. |
|
licenseType |
string |
Type de licence locale à utiliser lors du déploiement du système d’exploitation. Windows_Server : la licence locale est destinée à Windows Server. Windows_Client : la licence locale est destinée au client Windows. |
nodeAgentSKUId |
string |
Référence (SKU) de l’agent Batch Compute Node à provisionner sur les nœuds de calcul du pool. |
nodePlacementConfiguration |
Configuration de placement de nœud pour le pool. |
|
osDisk |
Paramètres du disque du système d’exploitation de la machine virtuelle. |
|
securityProfile |
Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques. |
|
serviceArtifactReference |
Spécifie l’ID de référence de l’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la version d’image la plus récente. |
|
windowsConfiguration |
Paramètres du système d’exploitation Windows sur la machine virtuelle. |
Spécifie les paramètres du profil de sécurité pour le disque managé. Remarque: elle ne peut être définie que pour les machines virtuelles confidentielles et requises lors de l’utilisation de machines virtuelles confidentielles.
Nom | Type | Description |
---|---|---|
securityEncryptionType |
Spécifie le EncryptionType du disque managé. Il est défini sur VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState. Remarque: elle peut être définie uniquement pour les machines virtuelles confidentielles et est requise lors de l’utilisation de machines virtuelles confidentielles. |
Configuration des extensions de machine virtuelle.
Nom | Type | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Indique si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true. |
enableAutomaticUpgrade |
boolean |
Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension disponible. |
name |
string |
Nom de l’extension de machine virtuelle. |
protectedSettings |
object |
L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout. |
provisionAfterExtensions |
string[] |
Collection de noms d’extensions. |
publisher |
string |
Nom du serveur de publication du gestionnaire d’extensions. |
settings |
object |
Paramètres publics au format JSON pour l’extension. |
type |
string |
Type de l’extension. |
typeHandlerVersion |
string |
Version du gestionnaire de scripts. |
Paramètres du système d’exploitation Windows à appliquer à la machine virtuelle.
Nom | Type | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Indique si les mises à jour automatiques sont activées sur la machine virtuelle. |
Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Windows.
Nom | Type | Description |
---|---|---|
loginMode |
Mode de connexion de l’utilisateur |