Job - Update
Mises à jour les propriétés du travail spécifié.
Cela remplace entièrement toutes les propriétés pouvant être mises à jour du travail. Par exemple, si le travail a des contraintes associées et si les contraintes ne sont pas spécifiées avec cette demande, le service Batch supprime les contraintes existantes.
PUT {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0
PUT {batchUrl}/jobs/{jobId}?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 dont vous souhaitez mettre à jour les propriétés. |
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 d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement. |
|
If-Match |
string |
Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client. |
|
If-None-Match |
string |
Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client. |
|
If-Modified-Since |
string date-time-rfc1123 |
Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération est effectuée uniquement si la ressource sur le service a été modifiée depuis l’heure spécifiée. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée. |
Corps de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
poolInfo | True |
Pool sur lequel le service Batch exécute les tâches du travail. |
|
allowTaskPreemption |
boolean |
Si les tâches de ce travail peuvent être préemptées par d’autres travaux hautement prioritaires |
|
constraints |
Contraintes d’exécution pour le travail. |
||
maxParallelTasks |
integer |
Nombre maximal de tâches pouvant être exécutées en parallèle pour le travail. |
|
metadata |
Liste de paires nom-valeur associées au travail en tant que métadonnées. |
||
onAllTasksComplete |
Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont à l’état terminé. |
||
priority |
integer |
Priorité du travail. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La demande adressée au service Batch a réussi. En-têtes
|
|
Other Status Codes |
Erreur du service Batch. |
Sécurité
azure_auth
Microsoft Entra flux de code d’authentification OAuth 2.0
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Authorization
Type:
apiKey
Dans:
header
Exemples
Job update
Exemple de requête
PUT account.region.batch.azure.com/jobs/jobId?api-version=2023-11-01.18.0
{
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"poolInfo": {
"poolId": "poolId"
}
}
Exemple de réponse
Définitions
Nom | Description |
---|---|
Application |
Référence à un package à déployer sur des nœuds de calcul. |
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 de 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 incluses 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. |
Cloud |
Configuration des nœuds de calcul dans un pool basé sur la plateforme Azure Services cloud. |
Compute |
Comment les tâches sont distribuées entre les nœuds de calcul dans 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 |
Registre de conteneurs privé. |
Container |
Technologie de conteneur à utiliser. |
Container |
Emplacement du répertoire de travail de la tâche du 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 formater les disques à partir d'une machine virtuelle pour les utiliser. |
Diff |
Spécifie l’emplacement de disque éphémère pour le 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 Azure Compute Gallery Image. |
Disk |
La liste des cibles de disque batch Service chiffrera 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 Task. |
Error |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
Image |
Référence à une image de la Place de marché Azure Machines Virtuelles ou à une image Azure Compute Gallery. Pour obtenir la liste de toutes les références d’images 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 |
Contraintes d’exécution d’un travail. |
Job |
Ensemble de modifications à apporter à un travail. |
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éseau 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 du placement des nœuds 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 à l’état terminé. |
OSDisk |
Paramètres du disque du système d’exploitation du nœud de calcul. |
Pool |
Configuration du point de terminaison pour un pool. |
Pool |
Spécifie la façon dont un travail doit être affecté à un pool. |
Pool |
Durée de vie minimale des pools automatiques créés et comment plusieurs travaux selon une planification sont attribués aux pools. |
Pool |
Spécification pour la création d’un pool. |
Public |
Configuration de l’adresse IP publique de la configuration réseau d’un pool. |
Resource |
Fichier unique ou plusieurs fichiers à télécharger sur un nœud de calcul. |
Security |
Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le 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 dernière version d’image. |
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 dans la création de disques de données ou de disque de système d’exploitation. |
Task |
Paramètres de conteneur pour 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. |
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é utilisateur sous laquelle la tâche est exécutée. |
Virtual |
Configuration des nœuds de calcul dans un pool basé sur l’infrastructure Azure Machines Virtuelles. |
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. |
ApplicationPackageReference
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. |
AutoPoolSpecification
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 automatiquement créé. |
keepAlive |
boolean |
Indique s’il faut conserver un pool automatique en vie 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 selon une planification sont attribués aux pools. |
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 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 |
AzureBlobFileSystemConfiguration
Informations utilisées pour se connecter à un conteneur de stockage Azure à l’aide de 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 mount. |
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 SAS stockage Azure. |
AzureFileShareConfiguration
Informations utilisées pour se connecter à un partage de fichiers Azure.
Nom | Type | Description |
---|---|---|
accountKey |
string |
Clé de compte de 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 mount. |
relativeMountPath |
string |
Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté |
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 incluses 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. |
CachingType
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 lecture et écriture. |
CertificateReference
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 auquel l’empreinte numérique est associée. Il doit s’agir de sha1. |
visibility |
Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat. |
CertificateStoreLocation
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. |
CertificateVisibility
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 AutoUser Scope est pool à la fois 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. |
CIFSMountConfiguration
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 mount. |
password |
string |
Mot de passe à utiliser pour l’authentification sur le 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 sur le système de fichiers CIFS. |
CloudServiceConfiguration
Configuration des nœuds de calcul dans un pool basé sur la plateforme Azure Services cloud.
Nom | Type | Description |
---|---|---|
osFamily |
string |
Famille de systèmes d’exploitation invités Azure à installer sur les machines virtuelles du pool. |
osVersion |
string |
Version du système d’exploitation invité Azure à installer sur les machines virtuelles du pool. |
ComputeNodeFillType
Comment les tâches sont distribuées entre les nœuds de calcul dans un pool.
Nom | Type | Description |
---|---|---|
pack |
string |
Autant de tâches que possible (taskSlotsPerNode) doivent être affectées à chaque nœud de calcul dans le pool avant que les tâches ne soient affectées au nœud de calcul suivant dans le pool. |
spread |
string |
Les tâches doivent être attribuées uniformément sur tous les nœuds de calcul du pool. |
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. |
ContainerConfiguration
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. |
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. |
ContainerType
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 avec Docker sera utilisée pour lancer les conteneurs. |
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. |
DataDisk
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 formater 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 de disque initiale en gigaoctets. |
lun |
integer |
Numéro d’unité logique. |
storageAccountType |
Type de compte de stockage à utiliser pour le disque de données. |
DiffDiskPlacement
Spécifie l’emplacement de disque éphémère pour le 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. |
DiffDiskSettings
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 l’emplacement de disque éphémère pour le disque du système d’exploitation pour toutes les machines virtuelles du pool. |
DiskEncryptionConfiguration
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 Azure Compute Gallery Image.
Nom | Type | Description |
---|---|---|
targets |
La liste des cibles de disque batch Service chiffrera sur le nœud de calcul. |
DiskEncryptionTarget
La liste des cibles de disque batch Service chiffrera 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 les disques de données montés) lorsque le chiffrement se produit au moment du démarrage. |
DynamicVNetAssignmentScope
É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. |
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. |
ImageReference
Référence à une image de la Place de marché Azure Machines Virtuelles ou à une image Azure Compute Gallery. Pour obtenir la liste de toutes les références d’images Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ».
Nom | Type | Description |
---|---|---|
exactVersion |
string |
Version spécifique de l’image de plateforme ou de l’image 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 » lors de la création du pool était « latest ». |
offer |
string |
Type d’offre de l’image de la Place de marché Azure Machines Virtuelles. |
publisher |
string |
Éditeur de l’image de la Place de marché Azure Machines Virtuelles. |
sku |
string |
Référence SKU de l’image de la Place de marché Azure Machines Virtuelles. |
version |
string |
Version de l’image de la Place de marché Azure Machines Virtuelles. |
virtualMachineImageId |
string |
Identificateur de ressource ARM de l’image Azure Compute Gallery. Les nœuds de calcul dans le pool seront 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 utiliser la dernière version d’image par défaut. |
InboundEndpointProtocol
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. |
InboundNATPool
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 |
Dernier 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. |
frontendPortRangeStart |
integer |
Premier numéro de port dans la plage de ports externes qui seront utilisés pour fournir un accès entrant au back-endPort 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. |
IPAddressProvisioningType
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. |
JobConstraints
Contraintes d’exécution d’un travail.
Nom | Type | Description |
---|---|---|
maxTaskRetryCount |
integer |
Nombre maximal de fois que chaque tâche peut être retentée. Le service Batch retente une tâche si son code de sortie est différent de zéro. |
maxWallClockTime |
string |
Durée maximale écoulée que le travail peut exécuter, mesurée à partir du moment où le travail est créé. |
JobUpdateParameter
Ensemble de modifications à apporter à un travail.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
Si les tâches de ce travail peuvent être préemptées par d’autres travaux hautement prioritaires |
|
constraints |
Contraintes d’exécution pour le travail. |
||
maxParallelTasks |
integer |
-1 |
Nombre maximal de tâches pouvant être exécutées en parallèle pour le travail. |
metadata |
Liste de paires nom-valeur associées au travail en tant que métadonnées. |
||
onAllTasksComplete |
Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont à l’état terminé. |
||
poolInfo |
Pool sur lequel le service Batch exécute les tâches du travail. |
||
priority |
integer |
Priorité du travail. |
LinuxUserConfiguration
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 pour le compte d’utilisateur. |
sshPrivateKey |
string |
Clé privée SSH pour le compte d’utilisateur. |
uid |
integer |
ID d’utilisateur du compte d’utilisateur. |
LoginMode
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 de longue durée. |
interactive |
string |
Mode de connexion Win32 LOGON32_LOGON_INTERACTIVE. La UAC est activée sur les pools Windows VirtualMachineConfiguration. Si cette option est utilisée avec une identité d’utilisateur avec élévation de privilèges dans un pool Windows VirtualMachineConfiguration, la session utilisateur n’est pas élevée, sauf si l’application exécutée par la ligne de commande Task est configurée pour toujours exiger des privilèges d’administration ou pour toujours exiger un privilège maximal. |
ManagedDisk
Nom | Type | Description |
---|---|---|
storageAccountType |
Type de compte de stockage pour le disque managé. |
MetadataItem
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. |
MountConfiguration
Système de fichiers à monter sur chaque nœud.
Nom | Type | Description |
---|---|---|
azureBlobFileSystemConfiguration |
Conteneur de stockage Azure à monter à l’aide de fuse 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. |
NetworkConfiguration
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 vont se joindre. Il s’agit de la forme /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
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éseau ou une balise spécifiée. |
|
priority |
integer |
Priorité de cette règle. |
sourceAddressPrefix |
string |
Préfixe d’adresse source ou balise à mettre en correspondance pour la règle. |
sourcePortRanges |
string[] |
Plages de ports sources à faire correspondre pour la règle. |
NetworkSecurityGroupRuleAccess
Action qui doit être effectuée pour une adresse IP, une plage de sous-réseau ou une balise spécifiée.
Nom | Type | Description |
---|---|---|
allow |
string |
Autorise l'accès. |
deny |
string |
Refuse l'accès. |
NFSMountConfiguration
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 mount. |
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. |
NodeCommunicationMode
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 de « BatchNodeManagement . Balise de service {region} et communication TCP sortante sur le port 443 vers « Storage.region » et « BatchNodeManagement ». {region} » étiquettes de service. |
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 « BatchNodeManagement . {region} » balise de service. Aucun port d’entrée ouvert n’est requis. |
NodePlacementConfiguration
Configuration du placement des nœuds pour un pool.
Nom | Type | Description |
---|---|---|
policy |
Type de stratégie de placement de nœud sur les pools Batch. |
NodePlacementPolicyType
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 seront répartis entre différentes zones de disponibilité avec un meilleur équilibrage des efforts. |
OnAllTasksComplete
Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont à l’état terminé.
Nom | Type | Description |
---|---|---|
noaction |
string |
Ne rien faire. Le travail reste actif, sauf s’il est arrêté ou désactivé par d’autres moyens. |
terminatejob |
string |
Terminez le travail. Le paramètre terminateReason du travail est défini sur « AllTasksComplete ». |
OSDisk
Paramètres du disque du système d’exploitation du nœud de calcul.
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 de disque initiale 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 de système d’exploitation utilisé par le nœud de calcul (machine virtuelle). |
|
managedDisk |
Paramètres du disque managé. |
|
writeAcceleratorEnabled |
boolean |
Spécifie si writeAccelerator doit être activé ou désactivé sur le disque. |
PoolEndpointConfiguration
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. |
PoolInformation
Spécifie la façon dont 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é. |
PoolLifetimeOption
Durée de vie minimale des pools automatiques créés et comment plusieurs travaux selon une planification sont attribués aux pools.
Nom | Type | Description |
---|---|---|
job |
string |
Le pool existe pendant 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 travail, le service Batch crée un pool automatique pour chaque travail créé selon la planification. |
jobschedule |
string |
Le pool existe pendant la durée de vie de la planification des travaux. Le service Batch crée le pool lorsqu’il crée le premier travail selon la planification. Vous pouvez appliquer cette option uniquement aux planifications de travaux, et non aux travaux. |
PoolSpecification
Spécification pour la création d’un pool.
Nom | Type | Description |
---|---|---|
applicationLicenses |
string[] |
Liste des licences d’application que le service Batch mettra à disposition sur chaque nœud de calcul du pool. |
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 . |
|
cloudServiceConfiguration |
Configuration du service cloud pour le pool. |
|
displayName |
string |
Nom d’affichage du pool. |
enableAutoScale |
boolean |
Indique si la taille du pool doit s’ajuster automatiquement au fil du temps. |
enableInterNodeCommunication |
boolean |
Indique si le pool autorise la communication directe entre les nœuds de calcul. |
metadata |
Liste de 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 pour le pool. |
|
resizeTimeout |
string |
Délai d’attente 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 à mesure qu’il joint 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 dans un pool. |
|
taskSlotsPerNode |
integer |
Nombre d’emplacements de tâche utilisables pour exécuter des tâches simultanées sur un nœud de calcul unique au sein du 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 ont la même taille. |
PublicIPAddressConfiguration
Configuration de l’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 des nœuds de calcul. |
provision |
Type d’approvisionnement pour les adresses IP publiques pour le pool. |
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é seront 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. |
SecurityProfile
Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le 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 d’hôte pour la machine virtuelle ou le groupe de machines virtuelles identiques. Cela permet d’activer le chiffrement de tous les disques, y compris le disque de ressource/temporaire sur l’hôte lui-même. |
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. |
SecurityTypes
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 |
---|---|---|
trustedLaunch |
string |
Le lancement fiable protège contre les techniques d’attaque avancées et persistantes. |
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 dernière version d’image.
Nom | Type | Description |
---|---|---|
id |
string |
ID de référence d’artefact de service de ServiceArtifactReference |
StartTask
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 l’objet 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échargera 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 demande é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. Vous pouvez y parvenir à l’aide de fichiers .zip, de packages d’application ou de 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. |
StorageAccountType
Type de compte de stockage à utiliser dans la création de disques de données ou de disque de système d’exploitation.
Nom | Type | Description |
---|---|---|
premium_lrs |
string |
Le disque de données/le disque du système d’exploitation doit utiliser un stockage localement redondant Premium. |
standard_lrs |
string |
Le disque de données/disque de système d’exploitation doit utiliser un stockage localement redondant standard. |
standardssd_lrs |
string |
Le disque de données/disque de système d’exploitation doit utiliser un stockage SSD standard localement redondant. |
TaskContainerSettings
Paramètres de conteneur pour une tâche.
Nom | Type | Description |
---|---|---|
containerRunOptions |
string |
Options supplémentaires de 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. |
TaskSchedulingPolicy
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 dans un pool. |
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.
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. |
UserAccount
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 des caractères Unicode d’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. |
UserIdentity
Définition de l’identité 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. |
VirtualMachineConfiguration
Configuration des nœuds de calcul dans un pool basé sur l’infrastructure Azure Machines Virtuelles.
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 dans le 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é Azure Machines Virtuelles 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 de nœud de calcul Batch à provisionner sur les nœuds de calcul dans le pool. |
nodePlacementConfiguration |
Configuration du placement des nœuds 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é pour la machine virtuelle ou le groupe de machines virtuelles identiques. |
|
serviceArtifactReference |
Spécifie l’ID de référence d’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 dernière version de l’image. |
|
windowsConfiguration |
Paramètres du système d’exploitation Windows sur la machine virtuelle. |
VMExtension
Configuration des extensions de machine virtuelle.
Nom | Type | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Indique si l’extension doit utiliser une version mineure plus récente si une version est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur true. |
enableAutomaticUpgrade |
boolean |
Indique si l’extension doit être automatiquement mise à niveau par la plateforme si une version plus récente de l’extension est 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é. |
provisionAfterExtensions |
string[] |
Collection de noms d’extension. |
publisher |
string |
Nom de l’éditeur 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 script. |
WindowsConfiguration
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. |
WindowsUserConfiguration
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 |