Job - Get

Service:

Batch Service

Version d'API:

2024-07-01.20.0

Obtient des informations sur le travail spécifié.

GET {batchUrl}/jobs/{jobId}?api-version=2024-07-01.20.0

Avec des paramètres facultatifs:

GET {batchUrl}/jobs/{jobId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2024-07-01.20.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
jobId	path	True	string	ID du travail.
api-version	query	True	string	Version de l’API cliente.
$expand	query		string	Clause $expand OData.
$select	query		string	Clause OData $select.
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.

En-tête de la demande

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.
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 dernière modification de la ressource connue du client. L’opération n’est effectuée que 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 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.

Réponses

Nom	Type	Description
200 OK	CloudJob	Réponse contenant le travail. En-têtes client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Erreur du service Batch.

Sécurité

azure_auth

Flux de code d’authentification Microsoft Entra 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 get

Exemple de requête

HTTP

GET account.region.batch.azure.com/jobs/jobId?api-version=2024-07-01.20.0

Exemple de réponse

Code d’état:

200

{
  "id": "jobId",
  "url": "https://account.region.batch.azure.com/jobs/jobId",
  "eTag": "0x8D4100FC49F0278",
  "lastModified": "2016-11-19T00:05:27.5391608Z",
  "creationTime": "2016-11-19T00:05:25.311915Z",
  "state": "completed",
  "stateTransitionTime": "2016-11-19T00:05:27.578581Z",
  "previousState": "active",
  "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z",
  "priority": 0,
  "maxParallelTasks": -1,
  "allowTaskPreemption": false,
  "usesTaskDependencies": false,
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "poolInfo": {
    "poolId": "poolId"
  },
  "executionInfo": {
    "startTime": "2016-11-19T00:05:25.3309105Z",
    "endTime": "2016-11-19T00:05:27.578581Z",
    "poolId": "poolId",
    "terminateReason": "UserTerminate"
  },
  "onAllTasksComplete": "noaction",
  "onTaskFailure": "noaction"
}

Définitions

Nom	Description
AccessScope	Ressources Batch auxquelles le jeton accorde l’accès.
ApplicationPackageReference	Référence à un package à déployer sur des nœuds de calcul.
AuthenticationTokenSettings	Paramètres d’un jeton d’authentification que la tâche peut utiliser pour effectuer des opérations de service Batch.
AutomaticOSUpgradePolicy	Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation.
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.
AutoUserScope	Étendue de l’utilisateur automatique
AutoUserSpecification	Spécifie les paramètres de l’utilisateur automatique qui exécute une tâche sur le service Batch.
AzureBlobFileSystemConfiguration	Informations utilisées pour se connecter à un conteneur de stockage Azure à l’aide d’Blobfuse.
AzureFileShareConfiguration	Informations utilisées pour se connecter à un partage de fichiers Azure.
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
CachingType	Type de mise en cache à activer pour le disque.
CertificateReference	Référence à un certificat à installer sur des nœuds de calcul dans un pool.
CertificateStoreLocation	Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat.
CertificateVisibility	Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat.
CIFSMountConfiguration	Informations utilisées pour se connecter à un système de fichiers CIFS.
CloudJob	Tâche Azure Batch.
ComputeNodeFillType	Comment les tâches sont distribuées entre les nœuds de calcul d’un pool.
ComputeNodeIdentityReference	Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
ContainerConfiguration	Configuration des pools avec conteneur.
ContainerHostBatchBindMountEntry	Entrée du chemin d’accès et du mode montage que vous souhaitez monter dans le conteneur de tâches.
ContainerHostDataPath	Chemins d’accès qui seront montés sur le conteneur de la tâche de conteneur.
ContainerRegistry	Registre de conteneurs privé.
ContainerType	Technologie de conteneur à utiliser.
ContainerWorkingDirectory	Emplacement du répertoire de travail de tâche de conteneur.
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 mettre en forme les disques à partir d’une machine virtuelle pour les utiliser.
DiffDiskPlacement	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.
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).
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 l’image de la galerie de calcul Azure.
DiskEncryptionTarget	La liste des cibles de disque batch Service chiffre sur le nœud de calcul.
DynamicVNetAssignmentScope	Étendue de l’attribution de réseau virtuel dynamique.
ElevationLevel	Niveau d’élévation de l’utilisateur.
EnvironmentSetting	Variable d’environnement à définir sur un processus de tâche.
ErrorCategory	Catégorie de l’erreur.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
HttpHeader	Paire nom-valeur d’en-tête HTTP
ImageReference	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 ».
InboundEndpointProtocol	Protocole du 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.
IPAddressProvisioningType	Type d’approvisionnement pour les adresses IP publiques pour le pool.
JobConstraints	Contraintes d’exécution pour un travail.
JobExecutionInformation	Contient des informations sur l’exécution d’un travail dans le service Azure Batch.
JobManagerTask	Spécifie les détails d’une tâche du Gestionnaire de travaux.
JobNetworkConfiguration	Configuration réseau du travail.
JobPreparationTask	Tâche de préparation du travail à exécuter avant toutes les tâches du travail sur un nœud de calcul donné.
JobReleaseTask	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é.
JobSchedulingError	Erreur rencontrée par le service Batch lors de la planification d’un travail.
JobState	État du travail.
JobStatistics	Statistiques d’utilisation des ressources pour un travail.
LinuxUserConfiguration	Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Linux.
LoginMode	Mode de connexion de l’utilisateur
ManagedDisk
MetadataItem	Paire nom-valeur associée à une ressource de service Batch.
MountConfiguration	Système de fichiers à monter sur chaque nœud.
NameValuePair	Représente une paire nom-valeur.
NetworkConfiguration	Configuration réseau d’un pool.
NetworkSecurityGroupRule	Règle de groupe de sécurité réseau à appliquer à un point de terminaison entrant.
NetworkSecurityGroupRuleAccess	Action qui doit être effectuée pour une adresse IP, une plage de sous-réseaux ou une balise spécifiée.
NFSMountConfiguration	Informations utilisées pour se connecter à un système de fichiers NFS.
NodeCommunicationMode	Détermine comment un pool communique avec le service Batch.
NodePlacementConfiguration	Configuration de placement de nœud pour un pool.
NodePlacementPolicyType	Stratégie de placement pour l’allocation de nœuds dans le pool.
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.
OSDisk	Paramètres du disque du système d’exploitation du nœud de calcul (machine virtuelle).
OutputFile	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.
OutputFileBlobContainerDestination	Spécifie une destination de chargement de fichier dans un conteneur de stockage d’objets blob Azure.
OutputFileDestination	Destination vers laquelle un fichier doit être chargé.
OutputFileUploadCondition	Conditions dans lesquelles un fichier de sortie de tâche ou un ensemble de fichiers doit être chargé.
OutputFileUploadOptions	Détails sur une opération de chargement de fichier de sortie, y compris dans quelles conditions effectuer le chargement.
PoolEndpointConfiguration	Configuration du point de terminaison pour un pool.
PoolInformation	Spécifie comment un travail doit être affecté à un pool.
PoolLifetimeOption	Durée de vie minimale des pools automatiques créés et comment plusieurs travaux sur une planification sont attribués aux pools.
PoolSpecification	Spécification pour la création d’un pool.
PublicIPAddressConfiguration	Configuration d’adresse IP publique de la configuration réseau d’un pool.
ResourceFile	Un seul fichier ou plusieurs fichiers à télécharger sur un nœud de calcul.
RollingUpgradePolicy	Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée.
SecurityEncryptionTypes	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.
SecurityProfile	Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques.
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.
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.
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é.
StorageAccountType	Type de compte de stockage à utiliser pour créer des disques de données ou un disque de système d’exploitation.
TaskConstraints	Contraintes d’exécution à appliquer à une tâche.
TaskContainerSettings	Paramètres de conteneur d’une tâche.
TaskSchedulingPolicy	Spécifie la façon dont les tâches doivent être distribuées entre les nœuds de calcul.
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.
UpgradeMode	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.
UpgradePolicy	Décrit une stratégie de mise à niveau : automatique, manuelle ou propagée.
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.
UserIdentity	Définition de l’identité de l’utilisateur sous laquelle la tâche est exécutée.
VirtualMachineConfiguration	Configuration des nœuds de calcul dans un pool en fonction de l’infrastructure des machines virtuelles Azure.
VMDiskSecurityProfile	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.
WindowsConfiguration	Paramètres du système d’exploitation Windows à appliquer à la machine virtuelle.
WindowsUserConfiguration	Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Windows.

AccessScope

Ressources Batch auxquelles le jeton accorde l’accès.

Nom	Type	Description
job	string	Accorde l’accès pour effectuer toutes les opérations sur le travail contenant la tâche.

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. Lors de la création d’un pool, l’ID d’application du package doit être complet (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Version de l’application à déployer. En cas d’omission, la version par défaut est déployée. Si cela est omis sur un pool et qu’aucune version par défaut n’est spécifiée pour cette application, la requête échoue avec le code d’erreur InvalidApplicationPackageReferences et le code d’état HTTP 409. Si cela est omis sur une tâche et qu’aucune version par défaut n’est spécifiée pour cette application, la tâche échoue avec une erreur de prétraitement.

AuthenticationTokenSettings

Paramètres d’un jeton d’authentification que la tâche peut utiliser pour effectuer des opérations de service Batch.

Nom	Type	Description
access	AccessScope[]	Ressources Batch auxquelles le jeton accorde l’accès. Le jeton d’authentification accorde l’accès à un ensemble limité d’opérations de service Batch. Actuellement, la seule valeur prise en charge pour la propriété d’accès est « job », ce qui accorde l’accès à toutes les opérations liées au travail qui contient la tâche.

AutomaticOSUpgradePolicy

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. Si cette valeur est définie sur true pour les pools Windows, WindowsConfiguration.enableAutomaticUpdates ne peut pas être définie sur true.
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.

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 créé automatiquement. Le service Batch affecte à chaque pool automatique un identificateur unique lors de la création. Pour distinguer les pools créés à des fins différentes, vous pouvez spécifier cet élément pour ajouter un préfixe à l’ID affecté. Le préfixe peut comporter jusqu’à 20 caractères.
keepAlive	boolean	Indique s’il faut conserver un pool automatique actif après l’expiration de sa durée de vie. Si la valeur est false, le service Batch supprime le pool une fois sa durée de vie (comme déterminé par le paramètre poolLifetimeOption) expire ; c’est-à-dire lorsque la planification du travail ou du travail est terminée. Si la valeur est true, le service Batch ne supprime pas automatiquement le pool. Il incombe à l’utilisateur de supprimer les pools automatiques créés avec cette option.
pool	PoolSpecification	Spécification du pool pour le pool automatique.
poolLifetimeOption	PoolLifetimeOption	Durée de vie minimale des pools automatiques créés et comment plusieurs travaux sur 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	ElevationLevel	Niveau d’élévation de l’utilisateur automatique. La valeur par défaut n’est pasAdmin.
scope	AutoUserScope	Étendue de l’utilisateur automatique La valeur par défaut est pool. Si le pool exécute Windows, une valeur de tâche doit être spécifiée si une isolation plus stricte entre les tâches est requise. Par exemple, si la tâche mute le Registre d’une manière qui peut avoir un impact sur d’autres tâches, ou si des certificats ont été spécifiés sur le pool qui ne doit pas être accessible par les tâches normales, mais qu’il doit être accessible par StartTasks.

AzureBlobFileSystemConfiguration

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. Cette propriété s’exclue mutuellement avec sasKey et l’identité ; exactement un doit être spécifié.
accountName	string	Nom du compte de stockage Azure.
blobfuseOptions	string	Options de ligne de commande supplémentaires à passer à la commande de montage. Il s’agit des options « net use » dans les options Windows et « mount » dans Linux.
containerName	string	Nom du conteneur stockage Blob Azure.
identityReference	ComputeNodeIdentityReference	Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à containerName Cette propriété s’exclue mutuellement avec accountKey et sasKey ; exactement un doit être spécifié.
relativeMountPath	string	Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté Tous les systèmes de fichiers sont montés par rapport au répertoire de montage Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR.
sasKey	string	Jeton SAP stockage Azure. Cette propriété s’exclue mutuellement avec accountKey et l’identité ; exactement un doit être spécifié.

AzureFileShareConfiguration

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. Il s’agit de la forme « https://{account}.file.core.windows.net/ ».
mountOptions	string	Options de ligne de commande supplémentaires à passer à la commande de montage. Il s’agit des options « net use » dans les options Windows et « mount » dans Linux.
relativeMountPath	string	Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté Tous les systèmes de fichiers sont montés par rapport au répertoire de montage Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR.

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 programme.
message	ErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

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 en lecture et en écriture.

CertificateReference

Référence à un certificat à installer sur des nœuds de calcul dans un pool.

Nom	Type	Description
storeLocation	CertificateStoreLocation	Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. La valeur par défaut est currentuser. Cette propriété s’applique uniquement aux pools configurés avec des nœuds de calcul Windows. Pour les nœuds de calcul Linux, les certificats sont stockés dans un répertoire à l’intérieur du répertoire de travail de tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour interroger cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certificats » est créé dans le répertoire d’accueil de l’utilisateur (par exemple, /home/{user-name}/certs) et les certificats sont placés dans ce répertoire.
storeName	string	Nom du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. Cette propriété s’applique uniquement aux pools configurés avec des nœuds de calcul Windows. Les noms de magasin courants sont : My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mais tout nom de magasin personnalisé peut également être utilisé. La valeur par défaut est My.
thumbprint	string	Empreinte numérique du certificat.
thumbprintAlgorithm	string	Algorithme avec lequel l’empreinte numérique est associée. Cela doit être sha1.
visibility	CertificateVisibility[]	Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat. Vous pouvez spécifier plusieurs visibilités dans cette collection. La valeur par défaut est tous les comptes.

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

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 de montage. Il s’agit des options « net use » dans les options Windows et « mount » dans Linux.
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é Tous les systèmes de fichiers sont montés par rapport au répertoire de montage Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR.
source	string	URI du système de fichiers à monter.
username	string	Utilisateur à utiliser pour l’authentification auprès du système de fichiers CIFS.

CloudJob

Tâche Azure Batch.

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 Si la valeur est définie sur True, les autres travaux à priorité élevée soumis au système sont prioritaires et peuvent requeuler des tâches à partir de ce travail. Vous pouvez mettre à jour l’autorisation allowTaskPreemption d’un travail après sa création à l’aide de l’API de travail de mise à jour.
commonEnvironmentSettings	EnvironmentSetting[]		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). Les tâches individuelles peuvent remplacer un paramètre d’environnement spécifié ici en spécifiant le même nom de paramètre avec une valeur différente.
constraints	JobConstraints		Contraintes d’exécution pour le travail.
creationTime	string		Heure de création du travail.
displayName	string		Nom complet du travail.
eTag	string		ETag du travail. Il s’agit d’une chaîne opaque. Vous pouvez l’utiliser pour détecter si le travail a changé entre les demandes. En particulier, vous pouvez passer l’ETag lors de la mise à jour d’un travail pour spécifier que vos modifications doivent prendre effet uniquement si personne d’autre n’a modifié le travail en attendant.
executionInfo	JobExecutionInformation		Informations d’exécution pour le travail.
id	string		Chaîne qui identifie de façon unique le travail dans le compte. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID au sein d’un compte qui diffèrent uniquement par cas).
jobManagerTask	JobManagerTask		Détails d’une tâche du Gestionnaire de travaux à lancer au démarrage du travail. La tâche du Gestionnaire de travaux est automatiquement démarrée lors de la création du travail. Le service Batch tente de planifier la tâche du Gestionnaire de travaux avant toute autre tâche du travail. Lors de la réduction d’un pool, le service Batch tente de conserver les nœuds dans lesquels les tâches du Gestionnaire de travaux s’exécutent aussi longtemps que possible (autrement dit, les nœuds de calcul exécutant des tâches « normales » sont supprimées avant que les nœuds de calcul n’exécutent les tâches du Gestionnaire de travaux). Lorsqu’une tâche du Gestionnaire de travaux échoue et doit être redémarrée, le système tente de le planifier en priorité la plus élevée. S’il n’existe aucun nœud de calcul inactif disponible, le système peut mettre fin à l’une des tâches en cours d’exécution dans le pool et le retourner à la file d’attente pour que la tâche du Gestionnaire de travaux redémarre. Notez qu’une tâche du Gestionnaire de travaux dans un travail n’a pas de priorité sur les tâches dans d’autres travaux. Parmi les travaux, seules les priorités au niveau du travail sont observées. Par exemple, si un gestionnaire de travaux dans une priorité 0 travail doit être redémarré, il ne déplace pas les tâches d’un travail prioritaire 1. Batch réessaye les tâches lorsqu’une opération de récupération est déclenchée sur un nœud. Les exemples d’opérations de récupération incluent (mais ne sont pas limités) lorsqu’un nœud non sain est redémarré ou qu’un nœud de calcul a disparu en raison d’une défaillance de l’hôte. Les nouvelles tentatives en raison d’opérations de récupération sont indépendantes et ne sont pas comptabilisées par rapport au maxTaskRetryCount. Même si maxTaskRetryCount est 0, une nouvelle tentative interne en raison d’une opération de récupération peut se produire. En raison de cela, toutes les tâches doivent être idempotentes. Cela signifie que les tâches doivent tolérer l’interruption et le redémarrage sans provoquer d’altération ou de doublon des données. La meilleure pratique pour les tâches longues consiste à utiliser une forme de point de contrôle.
jobPreparationTask	JobPreparationTask		Tâche de préparation du travail. La tâche de préparation du travail est une tâche spéciale exécutée sur chaque nœud de calcul avant toute autre tâche du travail.
jobReleaseTask	JobReleaseTask		Tâche de mise en production du travail. La tâche de mise en production du travail est une tâche spéciale exécutée à la fin du travail sur chaque nœud de calcul qui a exécuté toute autre tâche du travail.
lastModified	string		Heure de dernière modification du travail. Il s’agit de la dernière fois où les données au niveau du travail, telles que l’état ou la priorité du travail, ont changé. Elle ne prend pas en compte les modifications au niveau des tâches, telles que l’ajout de nouvelles tâches ou le changement d’état des tâches.
maxParallelTasks	integer	-1	Nombre maximal de tâches qui peuvent être exécutées en parallèle pour le travail. La valeur de maxParallelTasks doit être -1 ou supérieure à 0 si spécifiée. Si elle n’est pas spécifiée, la valeur par défaut est -1, ce qui signifie qu’il n’existe aucune limite au nombre de tâches qui peuvent être exécutées simultanément. Vous pouvez mettre à jour maxParallelTasks d’un travail après sa création à l’aide de l’API de travail de mise à jour.
metadata	MetadataItem[]		Liste des paires nom-valeur associées au travail en tant que métadonnées. Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.
networkConfiguration	JobNetworkConfiguration		Configuration réseau du travail.
onAllTasksComplete	OnAllTasksComplete		Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. La valeur par défaut est noaction.
onTaskFailure	OnTaskFailure		Action que le service Batch doit effectuer quand une tâche dans le travail échoue. Une tâche est considérée comme ayant échoué en cas d’échec. Un failureInfo est défini si la tâche se termine avec un code de sortie autre que zéro après avoir épuisé son nombre de nouvelles tentatives, ou s’il y a eu une erreur lors du démarrage de la tâche, par exemple en raison d’une erreur de téléchargement de fichier de ressources. La valeur par défaut est noaction.
poolInfo	PoolInformation		Paramètres du pool associés au travail.
previousState	JobState		État précédent du travail. Cette propriété n’est pas définie si le travail est dans son état actif initial.
previousStateTransitionTime	string		Heure à laquelle le travail a entré son état précédent. Cette propriété n’est pas définie si le travail est dans son état actif initial.
priority	integer		Priorité du travail. Les valeurs de priorité peuvent aller de -1000 à 1 000, avec -1000 étant la priorité la plus basse et 1000 étant la priorité la plus élevée. La valeur par défaut est 0.
state	JobState		État actuel du travail.
stateTransitionTime	string		Heure à laquelle le travail a entré son état actuel.
stats	JobStatistics		Statistiques d’utilisation des ressources pour toute la durée de vie du travail. Cette propriété est remplie uniquement si CloudJob a été récupéré avec une clause expand incluant l’attribut « stats » ; sinon, il s’agit de null. Les statistiques peuvent ne pas être immédiatement disponibles. Le service Batch effectue un cumul périodique des statistiques. Le délai classique est d’environ 30 minutes.
url	string		URL 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.

ComputeNodeFillType

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.

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. Il s’agit de la référence d’image complète, comme indiqué dans « docker pull ». Une image est source du registre Docker par défaut, sauf si l’image est entièrement qualifiée avec un autre registre.
containerRegistries	ContainerRegistry[]	Registres privés supplémentaires à partir desquels les conteneurs peuvent être extraits. Si des images doivent être téléchargées à partir d’un registre privé qui nécessite des informations d’identification, ces informations d’identification doivent être fournies ici.
type	ContainerType	Technologie de conteneur à utiliser.

ContainerHostBatchBindMountEntry

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). Pour Linux, si vous montez ce chemin en mode lecture/écriture, cela ne signifie pas que tous les utilisateurs du conteneur disposent de l’accès en lecture/écriture pour le chemin d’accès, cela dépend de l’accès dans la machine virtuelle hôte. Si ce chemin d’accès est monté en lecture seule, tous les utilisateurs du conteneur ne pourront pas modifier le chemin d’accès.
source	ContainerHostDataPath	Le chemin d’accès à monter sur le client conteneur peut être sélectionné.

ContainerHostDataPath

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.

ContainerRegistry

Registre de conteneurs privé.

Nom	Type	Description
identityReference	ComputeNodeIdentityReference	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. Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
password	string	Mot de passe pour vous connecter au serveur de Registre.
registryServer	string	URL du Registre. S’il est omis, la valeur par défaut est « docker.io ».
username	string	Nom d’utilisateur à connecter au serveur de 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 Docker sera utilisée pour lancer les conteneurs.

ContainerWorkingDirectory

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.

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 mettre en forme les disques à partir d’une machine virtuelle pour les utiliser.

Nom	Type	Description
caching	CachingType	Type de mise en cache à activer pour les disques de données. La valeur par défaut de la mise en cache est readwrite. Pour plus d’informations sur les options de mise en cache, consultez : https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	Taille du disque initial en gigaoctets.
lun	integer	Numéro d’unité logique. Le lun est utilisé pour identifier de manière unique chaque disque de données. Si vous attachez plusieurs disques, chacun doit avoir un lun distinct. La valeur doit être comprise entre 0 et 63, inclus.
storageAccountType	StorageAccountType	Type de compte de stockage à utiliser pour le disque de données. S’il est omis, la valeur par défaut est « standard_lrs ».

DiffDiskPlacement

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.

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	DiffDiskPlacement	Spécifie le placement éphémère du disque du système d’exploitation pour toutes les machines virtuelles du pool. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement, par exemple, mettre en cache l’espace disque pour l’approvisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences de taille de disque de système d’exploitation éphémère, reportez-vous à la configuration requise pour la taille de disque du système d’exploitation éphémère pour les machines virtuelles Windows à https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et les machines virtuelles Linux à https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

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 l’image de la galerie de calcul Azure.

Nom	Type	Description
targets	DiskEncryptionTarget[]	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.

DiskEncryptionTarget

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.

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 de tâche.

Nom	Type	Description
name	string	Nom de la variable d’environnement.
value	string	Valeur de la variable d’environnement.

ErrorCategory

Catégorie de l’erreur.

Nom	Type	Description
servererror	string	L’erreur est due à un problème de serveur interne.
usererror	string	L’erreur est due à un problème d’utilisateur, tel que la configuration incorrecte.

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.

HttpHeader

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

ImageReference

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 Cette propriété s’exclue mutuellement avec d’autres propriétés et peut être extraite de l’appel GET de la galerie 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. Par exemple, UbuntuServer ou WindowsServer.
publisher	string	Éditeur de l’image de la Place de marché des machines virtuelles Azure. Par exemple, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId	string	Identificateur unique de l’image de la galerie partagée Cette propriété s’exclue mutuellement avec d’autres propriétés et peut être extraite de l’appel GET de l’image de galerie partagée.
sku	string	Référence SKU de l’image de la Place de marché des machines virtuelles Azure. Par exemple, 18.04-LTS ou 2019-Datacenter.
version	string	Version de l’image de la Place de marché des machines virtuelles Azure. Vous pouvez spécifier la valeur « latest » pour sélectionner la dernière version d’une image. S’il est omis, la valeur par défaut est « latest ».
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. Cette propriété s’exclue mutuellement avec d’autres propriétés ImageReference. L’image de la galerie de calcul Azure doit avoir des réplicas dans la même région et doit se trouver dans le même abonnement que le compte Azure Batch. Si la version de l’image n’est pas spécifiée dans l’id d’image, la dernière version sera utilisée. Pour plus d’informations sur les paramètres de pare-feu de l’agent de nœud de calcul Batch pour communiquer avec le service Batch, consultez https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

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. Cela doit être unique dans un pool Batch. Les valeurs acceptables sont comprises entre 1 et 65535, sauf pour 29876 et 29877, car elles sont réservées. Si des valeurs réservées sont fournies, la requête échoue avec le code d’état HTTP 400.
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. Les valeurs acceptables sont comprises entre 1 et 65534, à l’exception des ports compris entre 5 000 et 55 000, qui sont réservés par le service Batch. Toutes les plages d’un pool doivent être distinctes et ne peuvent pas se chevaucher. Chaque plage doit contenir au moins 40 ports. Si des valeurs réservées ou superposées sont fournies, la requête échoue avec le code d’état HTTP 400.
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. Les valeurs acceptables sont comprises entre 1 et 65534, à l’exception des ports compris entre 50000 et 55000, qui sont réservés. Toutes les plages d’un pool doivent être distinctes et ne peuvent pas se chevaucher. Chaque plage doit contenir au moins 40 ports. Si des valeurs réservées ou superposées sont fournies, la requête échoue avec le code d’état HTTP 400.
name	string	Nom du point de terminaison. Le nom doit être unique dans un pool Batch, peut contenir des lettres, des chiffres, des traits de soulignement, des points et des traits d’union. Les noms doivent commencer par une lettre ou un nombre, doivent se terminer par une lettre, un nombre ou un trait de soulignement, et ne peuvent pas dépasser 77 caractères. Si des valeurs non valides sont fournies, la requête échoue avec le code d’état HTTP 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	Liste des règles de groupe de sécurité réseau qui seront appliquées au point de terminaison. Le nombre maximal de règles qui peuvent être spécifiées sur tous les points de terminaison d’un pool Batch est de 25. Si aucune règle de groupe de sécurité réseau n’est spécifiée, une règle par défaut est créée pour autoriser l’accès entrant au backendPort spécifié. Si le nombre maximal de règles de groupe de sécurité réseau est dépassé, la requête échoue avec le code d’état HTTP 400.
protocol	InboundEndpointProtocol	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 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. Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives. Le service Batch essaie chaque tâche une fois, puis peut réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est égal à 3, Batch tente une tâche jusqu’à 4 fois (une tentative initiale et 3 nouvelles tentatives). Si le nombre maximal de nouvelles tentatives est égal à 0, le service Batch n’effectue pas de nouvelles tentatives. Si le nombre maximal de nouvelles tentatives est -1, le service Batch retente les tâches sans limite. La valeur par défaut est 0 (aucune nouvelle tentative).
maxWallClockTime	string	Temps écoulé maximal pendant lequel le travail peut s’exécuter, mesuré à partir du moment où le travail est créé. Si le travail ne se termine pas dans le délai imparti, le service Batch l’arrête et toutes les tâches qui sont toujours en cours d’exécution. Dans ce cas, la raison de l’arrêt est MaxWallClockTimeExpiry. Si cette propriété n’est pas spécifiée, il n’existe aucune limite de temps sur la durée pendant laquelle le travail peut s’exécuter.

JobExecutionInformation

Contient des informations sur l’exécution d’un travail dans le service Azure Batch.

Nom	Type	Description
endTime	string	Heure d’achèvement du travail. Cette propriété est définie uniquement si le travail est dans l’état terminé.
poolId	string	ID du pool auquel ce travail est affecté. Cet élément contient le pool réel où le travail est affecté. Lorsque vous obtenez les détails du travail à partir du service, ils contiennent également un élément poolInfo, qui contient les données de configuration du pool à partir du moment où le travail a été ajouté ou mis à jour. Cet élément poolInfo peut également contenir un élément poolId. Si c’est le cas, les deux ID sont identiques. Si ce n’est pas le cas, cela signifie que le travail est exécuté sur un pool automatique, et cette propriété contient l’ID de ce pool automatique.
schedulingError	JobSchedulingError	Détails de toute erreur rencontrée par le service lors du démarrage du travail. Cette propriété n’est pas définie s’il n’y a pas eu d’erreur lors du démarrage du travail.
startTime	string	Heure de début du travail. Il s’agit de l’heure à laquelle le travail a été créé.
terminateReason	string	Chaîne décrivant la raison pour laquelle le travail s’est terminé. Cette propriété est définie uniquement si le travail est dans l’état terminé. Si le service Batch termine le travail, il définit la raison suivante : JMComplete : tâche du Gestionnaire de travaux terminée et killJobOnCompletion a été définie sur true. MaxWallClockTimeExpiry : le travail a atteint sa contrainte maxWallClockTime. TerminateJobSchedule : le travail s’est exécuté dans le cadre d’une planification et la planification s’est arrêtée. AllTasksComplete : l’attribut onAllTasksComplete du travail est défini sur terminatejob et toutes les tâches du travail sont terminées. TaskFailed : l’attribut onTaskFailure du travail est défini sur performExitOptionsJobAction et une tâche dans le travail a échoué avec une condition de sortie qui a spécifié une jobAction de terminatejob. Toute autre chaîne est une raison définie par l’utilisateur spécifiée dans un appel à l’opération « Terminer un travail ».

JobManagerTask

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é. La valeur par défaut est true.
applicationPackageReferences	ApplicationPackageReference[]	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. Les packages d’application sont téléchargés et déployés dans un répertoire partagé, et non dans le répertoire de travail des tâches. Par conséquent, si un package d’application référencé est déjà sur le nœud de calcul et qu’il est à jour, il n’est pas redéployé ; la copie existante sur le nœud de calcul est utilisée. Si un package d’application référencé ne peut pas être installé, par exemple parce que le package a été supprimé ou parce que le téléchargement a échoué, la tâche échoue.
authenticationTokenSettings	AuthenticationTokenSettings	Paramètres d’un jeton d’authentification que la tâche peut utiliser pour effectuer des opérations de service Batch. Si cette propriété est définie, le service Batch fournit à la tâche un jeton d’authentification qui peut être utilisé pour authentifier les opérations de service Batch sans nécessiter de clé d’accès au compte. Le jeton est fourni via la variable d’environnement AZ_BATCH_AUTHENTICATION_TOKEN. Les opérations que la tâche peut effectuer à l’aide du jeton dépendent des paramètres. Par exemple, une tâche peut demander des autorisations de travail pour ajouter d’autres tâches au travail, ou vérifier l’état du travail ou d’autres tâches sous le travail.
commandLine	string	Ligne de commande de la tâche du Gestionnaire de travaux. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	Contraintes qui s’appliquent à la tâche du Gestionnaire de travaux.
containerSettings	TaskContainerSettings	Paramètres du conteneur sous lequel la tâche du Gestionnaire de travaux s’exécute. Si le pool qui exécutera cette tâche a un conteneurConfiguration défini, il doit également être défini. Si le pool qui exécutera cette tâche n’a pas de conteneurConfiguration défini, il ne doit pas être défini. Lorsque cela est spécifié, tous les répertoires sont récursifs sous le AZ_BATCH_NODE_ROOT_DIR (la racine des répertoires Azure Batch sur le nœud) sont mappés dans le conteneur, toutes les variables d’environnement de tâche sont mappées au conteneur et la ligne de commande Task est exécutée dans le conteneur. Les fichiers produits dans le conteneur en dehors de AZ_BATCH_NODE_ROOT_DIR peuvent ne pas être répercutés sur le disque hôte, ce qui signifie que les API de fichier Batch ne pourront pas accéder à ces fichiers.
displayName	string	Nom complet de la tâche du Gestionnaire de travaux. Il n’a pas besoin d’être unique et peut contenir des caractères Unicode pouvant atteindre une longueur maximale de 1024.
environmentSettings	EnvironmentSetting[]	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. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement et ne peut pas contenir plus de 64 caractères.
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. Si la valeur est true, lorsque la tâche du Gestionnaire de travaux est terminée, le service Batch marque le travail comme terminé. Si des tâches sont toujours en cours d’exécution pour l’instant (autres que la version du travail), ces tâches sont arrêtées. Si la valeur est false, l’achèvement de la tâche du Gestionnaire de travaux n’affecte pas l’état du travail. Dans ce cas, vous devez utiliser l’attribut onAllTasksComplete pour terminer le travail, ou avoir un client ou un utilisateur terminant explicitement le travail. Par exemple, si le Gestionnaire de travaux crée un ensemble de tâches, mais ne prend pas de rôle supplémentaire dans son exécution. La valeur par défaut est true. Si vous utilisez les attributs onAllTasksComplete et onTaskFailure pour contrôler la durée de vie du travail et que vous utilisez la tâche du Gestionnaire de travaux uniquement pour créer les tâches pour le travail (pas pour surveiller la progression), il est important de définir killJobOnCompletion sur false.
outputFiles	OutputFile[]	Liste des fichiers que le service Batch charge à partir du nœud de calcul après avoir exécuté la ligne de commande. Pour les tâches multi-instances, les fichiers sont chargés uniquement à partir du nœud de calcul sur lequel la tâche principale est exécutée.
requiredSlots	integer	Nombre d’emplacements de planification nécessaires à l’exécution de la tâche. La valeur par défaut est 1. Une tâche peut uniquement être planifiée pour s’exécuter sur un nœud de calcul si le nœud dispose de suffisamment d’emplacements de planification gratuits disponibles. Pour les tâches multi-instances, cette propriété n’est pas prise en charge et ne doit pas être spécifiée.
resourceFiles	ResourceFile[]	Liste des fichiers que le service Batch télécharge sur le nœud de calcul avant d’exécuter la ligne de commande. Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. 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.
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. Si la valeur est true, aucune autre tâche ne s’exécute sur le même nœud tant que le Gestionnaire de travaux est en cours d’exécution. Si la valeur est false, d’autres tâches peuvent s’exécuter simultanément avec le Gestionnaire de travaux sur un nœud de calcul. La tâche du Gestionnaire de travaux compte normalement par rapport à la limite de tâches simultanées du nœud de calcul. Cela n’est donc pertinent que si le nœud de calcul autorise plusieurs tâches simultanées. La valeur par défaut est true.
userIdentity	UserIdentity	Identité de l’utilisateur sous laquelle la tâche du Gestionnaire de travaux s’exécute. Si elle est omise, la tâche s’exécute en tant qu’utilisateur non administratif unique à la tâche.

JobNetworkConfiguration

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é. Si la valeur est true, les nœuds restent joints au réseau virtuel à DNC. Si la valeur est false, les nœuds se retirent automatiquement lorsque le travail se termine. La valeur par défaut est false.
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. Le réseau virtuel doit se trouver dans la même région et dans le même abonnement que le compte Azure Batch. Le sous-réseau spécifié doit avoir suffisamment d’adresses IP libres pour prendre en charge le nombre de nœuds de calcul qui exécutent des tâches à partir du travail. Cela peut être jusqu’au nombre de nœuds de calcul dans le pool. Le principal de service « MicrosoftAzureBatch » doit avoir le rôle « Contributeur de machine virtuelle classique » Role-Based contrôle d’accès (RBAC) pour le réseau virtuel spécifié afin que le service Azure Batch puisse planifier des tâches sur les nœuds. Cela peut être vérifié en vérifiant si le réseau virtuel spécifié a des groupes de sécurité réseau (NSG) associés. Si la communication aux nœuds dans le sous-réseau spécifié est refusée par un groupe de sécurité réseau, le service Batch définit l’état des nœuds de calcul sur inutilisable. Il s’agit de la forme /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Si le réseau virtuel spécifié a des groupes de sécurité réseau (NSG) associés, quelques ports système réservés doivent être activés pour la communication entrante à partir du service Azure Batch. Pour les pools créés avec une configuration de machine virtuelle, activez les ports 29876 et 29877, ainsi que le port 22 pour Linux et le port 3389 pour Windows. Le port 443 doit également être ouvert pour les connexions sortantes pour les communications vers stockage Azure. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

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. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	Contraintes qui s’appliquent à la tâche de préparation du travail.
containerSettings	TaskContainerSettings	Paramètres du conteneur sous lequel la tâche de préparation du travail s’exécute. Lorsque cela est spécifié, tous les répertoires sont récursifs sous le AZ_BATCH_NODE_ROOT_DIR (la racine des répertoires Azure Batch sur le nœud) sont mappés dans le conteneur, toutes les variables d’environnement de tâche sont mappées au conteneur et la ligne de commande Task est exécutée dans le conteneur. Les fichiers produits dans le conteneur en dehors de AZ_BATCH_NODE_ROOT_DIR peuvent ne pas être répercutés sur le disque hôte, ce qui signifie que les API de fichier Batch ne pourront pas accéder à ces fichiers.
environmentSettings	EnvironmentSetting[]	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. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement et ne peut pas contenir plus de 64 caractères. Si vous ne spécifiez pas cette propriété, le service Batch attribue une valeur par défaut « jobpreparation ». Aucune autre tâche dans le travail ne peut avoir le même ID que la tâche de préparation du travail. Si vous essayez d’envoyer une tâche avec le même ID, le service Batch rejette la requête avec le code d’erreur TaskIdSameAsJobPreparationTask ; si vous appelez directement l’API REST, le code d’état HTTP est 409 (Conflit).
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. La tâche de préparation du travail est toujours réexécutée si un nœud de calcul est réinitialisé ou si la tâche de préparation du travail n’a pas terminé (par exemple, parce que le redémarrage s’est produit pendant l’exécution de la tâche). Par conséquent, vous devez toujours écrire une tâche de préparation du travail pour qu’elle soit idempotente et se comporter correctement si elle est exécutée plusieurs fois. La valeur par défaut est true.
resourceFiles	ResourceFile[]	Liste des fichiers que le service Batch télécharge sur le nœud de calcul avant d’exécuter la ligne de commande. Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. 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	UserIdentity	Identité de l’utilisateur sous laquelle la tâche de préparation du travail s’exécute. Si elle est omise, la tâche s’exécute en tant qu’utilisateur non administratif unique à la tâche sur les nœuds de calcul Windows, ou un utilisateur non administratif unique au pool sur les nœuds de calcul Linux.
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. Si la valeur est true et que la tâche de préparation du travail échoue sur un nœud, le service Batch retente la tâche de préparation du travail jusqu’à son nombre maximal de nouvelles tentatives (comme spécifié dans l’élément contraintes). Si la tâche n’est toujours pas terminée après toutes les nouvelles tentatives, le service Batch ne planifie pas les tâches du travail sur le nœud. Le nœud reste actif et éligible pour exécuter des tâches d’autres travaux. Si la valeur est false, le service Batch n’attend pas la fin de la tâche de préparation du travail. Dans ce cas, d’autres tâches du travail peuvent commencer à s’exécuter sur le nœud de calcul pendant que la tâche de préparation du travail est toujours en cours d’exécution ; et même si la tâche de préparation du travail échoue, les nouvelles tâches continueront d’être planifiées sur le nœud de calcul. La valeur par défaut est true.

JobReleaseTask

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. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Paramètres du conteneur sous lequel la tâche de mise en production du travail s’exécute. Lorsque cela est spécifié, tous les répertoires sont récursifs sous le AZ_BATCH_NODE_ROOT_DIR (la racine des répertoires Azure Batch sur le nœud) sont mappés dans le conteneur, toutes les variables d’environnement de tâche sont mappées au conteneur et la ligne de commande Task est exécutée dans le conteneur. Les fichiers produits dans le conteneur en dehors de AZ_BATCH_NODE_ROOT_DIR peuvent ne pas être répercutés sur le disque hôte, ce qui signifie que les API de fichier Batch ne pourront pas accéder à ces fichiers.
environmentSettings	EnvironmentSetting[]	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. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement et ne peut pas contenir plus de 64 caractères. Si vous ne spécifiez pas cette propriété, le service Batch attribue une valeur par défaut « jobrelease ». Aucune autre tâche dans le travail ne peut avoir le même ID que la tâche de mise en production du travail. Si vous essayez d’envoyer une tâche avec le même ID, le service Batch rejette la requête avec le code d’erreur TaskIdSameAsJobReleaseTask ; si vous appelez directement l’API REST, le code d’état HTTP est 409 (Conflit).
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	ResourceFile[]	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. Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche.
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. La valeur par défaut est de 7 jours, c’est-à-dire que le répertoire des tâches est conservé pendant 7 jours, sauf si le nœud de calcul est supprimé ou si le travail est supprimé.
userIdentity	UserIdentity	Identité de l’utilisateur sous laquelle la tâche de mise en production du travail s’exécute. Si elle est omise, la tâche s’exécute en tant qu’utilisateur non administratif unique à la tâche.

JobSchedulingError

Erreur rencontrée par le service Batch lors de la planification d’un travail.

Nom	Type	Description
category	ErrorCategory	Catégorie de l’erreur de planification du travail.
code	string	Identificateur de l’erreur de planification du travail. Les codes sont invariants et sont destinés à être consommés par programme.
details	NameValuePair[]	Liste des détails d’erreur supplémentaires liés à l’erreur de planification.
message	string	Message décrivant l’erreur de planification du travail, destiné à être adapté à l’affichage dans une interface utilisateur.

JobState

État du travail.

Nom	Type	Description
active	string	Le travail est disponible pour que les tâches soient planifiées.
completed	string	Toutes les tâches ont été arrêtées et le système n’accepte plus de tâches ni aucune modification supplémentaire du travail.
deleting	string	Un utilisateur a demandé que le travail soit supprimé, mais que l’opération de suppression est toujours en cours d’exécution (par exemple, car le système termine toujours les tâches en cours d’exécution).
disabled	string	Un utilisateur a désactivé le travail. Aucune tâche n’est en cours d’exécution et aucune nouvelle tâche n’est planifiée.
disabling	string	Un utilisateur a demandé que le travail soit désactivé, mais que l’opération de désactivation est toujours en cours (par exemple, en attente de la fin des tâches).
enabling	string	Un utilisateur a demandé que le travail soit activé, mais que l’opération d’activation est toujours en cours.
terminating	string	Le travail est sur le point de se terminer, soit parce qu’une tâche du Gestionnaire de travaux est terminée, soit parce que l’utilisateur a terminé le travail, mais que l’opération d’arrêt est toujours en cours d’exécution (par exemple, parce que les tâches de mise en production du travail sont en cours d’exécution).

JobStatistics

Statistiques d’utilisation des ressources pour un travail.

Nom	Type	Description
kernelCPUTime	string	Temps processeur total en mode noyau (additionné sur tous les cœurs et tous les nœuds de calcul) consommé par toutes les tâches du travail.
lastUpdateTime	string	Heure à laquelle les statistiques ont été mises à jour pour la dernière fois. Toutes les statistiques sont limitées à la plage entre startTime et lastUpdateTime.
numFailedTasks	integer	Nombre total de tâches dans le travail qui ont échoué pendant l’intervalle de temps donné. Une tâche échoue si elle épuise son nombre maximal de nouvelles tentatives sans retourner le code de sortie 0.
numSucceededTasks	integer	Nombre total de tâches effectuées avec succès dans le travail pendant l’intervalle de temps donné. Une tâche s’exécute correctement si elle retourne le code de sortie 0.
numTaskRetries	integer	Nombre total de nouvelles tentatives sur toutes les tâches du travail pendant l’intervalle de temps donné.
readIOGiB	number	Quantité totale de données en Gio lues à partir du disque par toutes les tâches du travail.
readIOps	integer	Nombre total d’opérations de lecture de disque effectuées par toutes les tâches du travail.
startTime	string	Heure de début de l’intervalle de temps couvert par les statistiques.
url	string	URL des statistiques.
userCPUTime	string	Temps processeur total en mode utilisateur (additionné sur tous les cœurs et tous les nœuds de calcul) consommé par toutes les tâches du travail.
waitTime	string	Temps d’attente total de toutes les tâches du travail. Le temps d’attente d’une tâche est défini comme le temps écoulé entre la création de la tâche et le début de l’exécution de la tâche. (Si la tâche est retentée en raison d’échecs, le temps d’attente est le temps d’exécution de la tâche la plus récente.) Cette valeur est signalée uniquement dans les statistiques de durée de vie du compte ; elle n’est pas incluse dans les statistiques du travail.
wallClockTime	string	Durée totale de l’horloge murale de toutes les tâches dans le travail. L’heure de l’horloge du mur est la durée écoulée entre le moment où la tâche a commencé à s’exécuter sur un nœud de calcul jusqu’à sa fin (ou jusqu’à la dernière fois que les statistiques ont été mises à jour, si la tâche n’avait pas terminé par la suite). Si une tâche a été retentée, cela inclut l’heure du mur de toutes les nouvelles tentatives de tâche.
writeIOGiB	number	Quantité totale de données en Gio écrites sur disque par toutes les tâches du travail.
writeIOps	integer	Nombre total d’opérations d’écriture de disque effectuées par toutes les tâches dans le 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 du compte d’utilisateur. Les propriétés uid et gid doivent être spécifiées ensemble ou pas du tout. Si le système d’exploitation sous-jacent n’est pas spécifié, le gid est sélectionné.
sshPrivateKey	string	Clé privée SSH pour le compte d’utilisateur. La clé privée ne doit pas être protégée par mot de passe. La clé privée est utilisée pour configurer automatiquement l’authentification basée sur une clé asymétrique pour SSH entre les nœuds de calcul dans un pool Linux lorsque la propriété enableInterNodeCommunication du pool est true (elle est ignorée si enableInterNodeCommunication est false). Pour ce faire, placez la paire de clés dans le répertoire .ssh de l’utilisateur. S’il n’est pas spécifié, ssh sans mot de passe n’est pas configuré entre les nœuds de calcul (aucune modification du répertoire .ssh de l’utilisateur n’est effectuée).
uid	integer	ID d’utilisateur du compte d’utilisateur. Les propriétés uid et gid doivent être spécifiées ensemble ou pas du tout. S’il n’est pas spécifié, le système d’exploitation sous-jacent sélectionne l’interface 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 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.

ManagedDisk

Nom	Type	Description
securityProfile	VMDiskSecurityProfile	Spécifie les paramètres du profil de sécurité pour le disque managé. 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.
storageAccountType	StorageAccountType	Type de compte de stockage pour 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	AzureBlobFileSystemConfiguration	Conteneur de stockage Azure à monter à l’aide de FUSE d’objet blob sur chaque nœud. Cette propriété s’exclue mutuellement avec toutes les autres propriétés.
azureFileShareConfiguration	AzureFileShareConfiguration	Partage de fichiers Azure à monter sur chaque nœud. Cette propriété s’exclue mutuellement avec toutes les autres propriétés.
cifsMountConfiguration	CIFSMountConfiguration	Système de fichiers CIFS/SMB à monter sur chaque nœud. Cette propriété s’exclue mutuellement avec toutes les autres propriétés.
nfsMountConfiguration	NFSMountConfiguration	Système de fichiers NFS à monter sur chaque nœud. Cette propriété s’exclue mutuellement avec toutes les autres propriétés.

NameValuePair

Représente une paire nom-valeur.

Nom	Type	Description
name	string	Nom de la paire nom-valeur.
value	string	Valeur de la paire nom-valeur.

NetworkConfiguration

Configuration réseau d’un pool.

Nom	Type	Description
dynamicVNetAssignmentScope	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. La mise en réseau accélérée permet une virtualisation d’E/S racine unique (SR-IOV) vers une machine virtuelle, ce qui peut entraîner une amélioration des performances réseau. Pour plus d’informations, consultez : https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration	PoolEndpointConfiguration	Configuration des points de terminaison sur les nœuds de calcul dans le pool Batch.
publicIPAddressConfiguration	PublicIPAddressConfiguration	Configuration IPAddress publique pour les nœuds de calcul dans le pool Batch. Configuration d’adresse IP publique de la configuration réseau d’un pool.
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}. Le réseau virtuel doit se trouver dans la même région et dans le même abonnement que le compte Azure Batch. Le sous-réseau spécifié doit avoir suffisamment d’adresses IP libres pour prendre en charge le nombre de nœuds de calcul dans le pool. Si le sous-réseau n’a pas suffisamment d’adresses IP gratuites, le pool alloue partiellement des nœuds et une erreur de redimensionnement se produit. Le principal de service « MicrosoftAzureBatch » doit avoir le rôle « Contributeur de machine virtuelle classique » Role-Based Contrôle d’accès (RBAC) pour le réseau virtuel spécifié. Le sous-réseau spécifié doit autoriser la communication du service Azure Batch à planifier des tâches sur les nœuds. Cela peut être vérifié en vérifiant si le réseau virtuel spécifié a des groupes de sécurité réseau (NSG) associés. Si la communication aux nœuds dans le sous-réseau spécifié est refusée par un groupe de sécurité réseau, le service Batch définit l’état des nœuds de calcul sur inutilisable. Seuls les réseaux virtuels ARM ('Microsoft.Network/virtualNetworks') sont pris en charge. Si le réseau virtuel spécifié a des groupes de sécurité réseau (NSG) associés, quelques ports système réservés doivent être activés pour la communication entrante, y compris les ports 29876 et 29877. Activez également les connexions sortantes au stockage Azure sur le port 443. Pour plus d’informations, consultez : https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Règle de groupe de sécurité réseau à appliquer à un point de terminaison entrant.

Nom	Type	Description
access	NetworkSecurityGroupRuleAccess	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. Les priorités au sein d’un pool doivent être uniques et sont évaluées par ordre de priorité. Plus le nombre est faible, plus la priorité est élevée. Par exemple, les règles peuvent être spécifiées avec des numéros de commande de 150, 250 et 350. La règle avec le numéro d’ordre de 150 est prioritaire sur la règle dont l’ordre est de 250. Les priorités autorisées sont de 150 à 4096. Si des valeurs réservées ou dupliquées sont fournies, la requête échoue avec le code d’état HTTP 400.
sourceAddressPrefix	string	Préfixe ou balise d’adresse source à mettre en correspondance pour la règle. Les valeurs valides sont une seule adresse IP (c’est-à-dire 10.10.10.10), un sous-réseau IP (par exemple, 192.168.1.0/24), une balise par défaut ou * (pour toutes les adresses). Si d’autres valeurs sont fournies, la requête échoue avec le code d’état HTTP 400.
sourcePortRanges	string[]	Plages de ports sources à mettre en correspondance pour la règle. Les valeurs valides sont «» (pour tous les ports 0 - 65535), un port spécifique (c’est-à-dire 22) ou une plage de ports (c’est-à-dire 100-200). Les ports doivent être comprises entre 0 et 65535. Chaque entrée de cette collection ne doit pas chevaucher une autre entrée (une plage ou un port individuel). Si d’autres valeurs sont fournies, la requête échoue avec le code d’état HTTP 400. La valeur par défaut est ''.

NetworkSecurityGroupRuleAccess

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.

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 de montage. Il s’agit des options « net use » dans les options Windows et « mount » dans Linux.
relativeMountPath	string	Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté Tous les systèmes de fichiers sont montés par rapport au répertoire de montage Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR.
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 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.

NodePlacementConfiguration

Configuration de placement de nœud pour un pool.

Nom	Type	Description
policy	NodePlacementPolicyType	Type de stratégie de placement de nœud sur les pools Batch. Stratégie d’allocation utilisée par le service Batch pour approvisionner les nœuds. S’il n’est pas spécifié, Batch utilise la stratégie régionale.

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 sont répartis entre différentes zones de disponibilité avec un équilibrage de l’effort optimal.

OnAllTasksComplete

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

OnTaskFailure

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

OSDisk

Paramètres du disque du système d’exploitation du nœud de calcul (machine virtuelle).

Nom	Type	Description
caching	CachingType	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. La valeur par défaut de la mise en cache n’est pas. Pour plus d’informations sur les options de mise en cache, consultez : https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	Taille initiale du disque en Go lors de la création d’un disque de système d’exploitation.
ephemeralOSDiskSettings	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).
managedDisk	ManagedDisk	Paramètres de disque managé.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

OutputFile

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	OutputFileDestination	Destination du ou des fichiers de sortie.
filePattern	string	Modèle indiquant le ou les fichiers à charger. Les chemins relatifs et absolus sont pris en charge. Les chemins relatifs sont relatifs au répertoire de travail de tâche. Les caractères génériques suivants sont pris en charge : * correspond à 0 caractères ou plus (par exemple, le modèle abc* correspond à abc ou abcdef), ** correspond à n’importe quel répertoire ? correspond à n’importe quel caractère unique, [abc] correspond à un caractère entre crochets et [a-c] correspond à un caractère de la plage. Les crochets peuvent inclure une négation pour correspondre à n’importe quel caractère non spécifié (par exemple [ !abc] correspond à n’importe quel caractère, mais a, b ou c). Si un nom de fichier commence par « ». Il est ignoré par défaut, mais peut être mis en correspondance en le spécifiant explicitement (par exemple, .gif ne correspond pas à .a.gif, mais ..gif le sera). Exemple simple : ***.txt correspond à un fichier qui ne démarre pas dans '.' et se termine par .txt dans le répertoire de travail de la tâche ou tout sous-répertoire. Si le nom de fichier contient un caractère générique, il peut être placé entre crochets (par exemple abc[] correspond à un fichier nommé abc). Notez que \ et / sont traités comme des séparateurs de répertoires sur Windows, mais uniquement / est sur Linux. Les variables d’environnement (%var% sur Windows ou $var sur Linux) sont développées avant l’application du modèle.
uploadOptions	OutputFileUploadOptions	Options supplémentaires pour l’opération de chargement, notamment dans quelles conditions effectuer le chargement.

OutputFileBlobContainerDestination

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. Si vous n’utilisez pas d’identité managée, l’URL doit inclure une signature d’accès partagé (SAP) accordant des autorisations d’écriture au conteneur.
identityReference	ComputeNodeIdentityReference	Référence à l’identité affectée par l’utilisateur à utiliser pour accéder au stockage Blob Azure spécifié par containerUrl L’identité doit avoir un accès en écriture au conteneur Stockage Blob Azure
path	string	Objet blob de destination ou répertoire virtuel dans le conteneur Stockage Azure. Si filePattern fait référence à un fichier spécifique (c’est-à-dire qu’il ne contient pas de caractères génériques), le chemin d’accès est le nom de l’objet blob dans lequel charger ce fichier. Si filePattern contient un ou plusieurs caractères génériques (et peut donc correspondre à plusieurs fichiers), le chemin d’accès est le nom du répertoire virtuel d’objet blob (qui est ajouté à chaque nom d’objet blob) auquel charger le ou les fichiers. En cas d’omission, les fichiers sont chargés à la racine du conteneur avec un nom d’objet blob correspondant à leur nom de fichier.
uploadHeaders	HttpHeader[]	Liste des paires nom-valeur pour les en-têtes à utiliser dans le chargement de fichiers de sortie Ces en-têtes sont spécifiés lors du chargement de fichiers dans Stockage Azure. Document officiel sur les en-têtes autorisés lors du chargement d’objets blob : https://docs.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Destination vers laquelle un fichier doit être chargé.

Nom	Type	Description
container	OutputFileBlobContainerDestination	Emplacement dans stockage d’objets blob Azure vers lequel les fichiers sont chargés.

OutputFileUploadCondition

Conditions dans lesquelles un fichier de sortie de tâche ou un ensemble de fichiers doit être chargé.

Nom	Type	Description
taskcompletion	string	Chargez le ou les fichiers une fois le processus 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.

OutputFileUploadOptions

Détails sur une opération de chargement de fichier de sortie, y compris dans quelles conditions effectuer le chargement.

Nom	Type	Description
uploadCondition	OutputFileUploadCondition	Conditions dans lesquelles le fichier de sortie de tâche ou l’ensemble de fichiers doivent être chargés. La valeur par défaut est taskcompletion.

PoolEndpointConfiguration

Configuration du point de terminaison pour un pool.

Nom	Type	Description
inboundNATPools	InboundNATPool[]	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. Le nombre maximal de pools NAT entrants par pool Batch est de 5. Si le nombre maximal de pools NAT entrants est dépassé, la requête échoue avec le code d’état HTTP 400. Cela ne peut pas être spécifié si IPAddressProvisioningType est NoPublicIPAddresses.

PoolInformation

Spécifie comment un travail doit être affecté à un pool.

Nom	Type	Description
autoPoolSpecification	AutoPoolSpecification	Caractéristiques d’un « pool automatique » temporaire. Le service Batch crée ce pool automatique lors de l’envoi du travail. Si la création automatique du pool échoue, le service Batch déplace le travail vers un état terminé et l’erreur de création du pool est définie dans la propriété d’erreur de planification du travail. Le service Batch gère la durée de vie (à la fois la création et, sauf si keepAlive est spécifié, suppression) du pool automatique. Toutes les actions utilisateur qui affectent la durée de vie du pool automatique pendant que le travail est actif entraînent un comportement inattendu. Vous devez spécifier l’ID du pool ou la spécification du pool automatique, mais pas les deux.
poolId	string	ID d’un pool existant. Toutes les tâches du travail s’exécutent sur le pool spécifié. Vous devez vous assurer que le pool référencé par cette propriété existe. Si le pool n’existe pas au moment où le service Batch tente de planifier un travail, aucune tâche du travail ne s’exécute tant que vous n’avez pas créé un pool avec cet ID. Notez que le service Batch ne rejette pas la demande de travail ; il n’exécute simplement pas les tâches tant que le pool n’existe pas. Vous devez spécifier l’ID du pool ou la spécification du pool automatique, mais pas les deux.

PoolLifetimeOption

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.

PoolSpecification

Spécification pour la création d’un pool.

Nom	Type	Description
applicationPackageReferences	ApplicationPackageReference[]	Liste des packages à installer sur chaque nœud de calcul du pool. Lors de la création d’un pool, l’ID d’application du package doit être complet (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Les modifications apportées aux références de package affectent tous les nouveaux nœuds qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réinitialisé. Il existe un maximum de 10 références de package sur un pool donné.
autoScaleEvaluationInterval	string	Intervalle de temps auquel ajuster automatiquement la taille du pool en fonction de la formule de mise à l’échelle automatique. La valeur par défaut est de 15 minutes. La valeur minimale et maximale est de 5 minutes et 168 heures respectivement. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch rejette la demande avec une erreur de valeur de propriété non valide ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).
autoScaleFormula	string	Formule pour le nombre souhaité de nœuds de calcul dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur false. Elle est requise si enableAutoScale a la valeur true. La formule est vérifiée pour la validité avant la création du pool. Si la formule n’est pas valide, le service Batch rejette la demande avec des informations d’erreur détaillées.
certificateReferences	CertificateReference[]	Liste des certificats à installer sur chaque nœud de calcul du pool. Pour les nœuds Windows, le service Batch installe les certificats dans le magasin de certificats et l’emplacement spécifiés. Pour les nœuds de calcul Linux, les certificats sont stockés dans un répertoire à l’intérieur du répertoire de travail de tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour interroger cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certificats » est créé dans le répertoire d’accueil de l’utilisateur (par exemple, /home/{user-name}/certs) et les certificats sont placés dans ce répertoire. 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. Le nom complet n’a pas besoin d’être unique et peut contenir des caractères Unicode pouvant atteindre une longueur maximale de 1024.
enableAutoScale	boolean	Indique si la taille du pool doit être ajustée automatiquement au fil du temps. Si la valeur est false, au moins un des targetDedicatedNodes et targetLowPriorityNodes doivent être spécifiés. Si la valeur est true, l’élément autoScaleFormula est requis. Le pool se redimensionne automatiquement en fonction de la formule. La valeur par défaut est false.
enableInterNodeCommunication	boolean	Indique si le pool autorise la communication directe entre les nœuds de calcul. L’activation de la communication entre nœuds limite la taille maximale du pool en raison de restrictions de déploiement sur les nœuds de calcul du pool. Cela peut entraîner le fait que le pool n’atteigne pas sa taille souhaitée. La valeur par défaut est false.
metadata	MetadataItem[]	Liste des paires nom-valeur associées au pool en tant que métadonnées. Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.
mountConfiguration	MountConfiguration[]	Liste des systèmes de fichiers à monter sur chaque nœud du pool. Cela prend en charge Azure Files, NFS, CIFS/SMB et Blobfuse.
networkConfiguration	NetworkConfiguration	Configuration réseau du pool. Configuration réseau d’un pool.
resizeTimeout	string	Délai d’expiration pour l’allocation de nœuds de calcul au pool. Ce délai d’expiration s’applique uniquement à la mise à l’échelle manuelle ; elle n’a aucun effet quand enableAutoScale a la valeur true. La valeur par défaut est de 15 minutes. La valeur minimale est de 5 minutes. Si vous spécifiez une valeur inférieure à 5 minutes, le service Batch rejette la demande avec une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).
resourceTags	object	Balises spécifiées par l’utilisateur associées au pool. Balises définies par l’utilisateur à associer au pool Azure Batch. Quand elles sont spécifiées, ces balises sont propagées aux ressources Azure de stockage associées au pool. Cette propriété ne peut être spécifiée que lorsque le compte Batch a été créé avec la propriété poolAllocationMode définie sur « UserSubscription ».
startTask	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é. Batch réessaye les tâches lorsqu’une opération de récupération est déclenchée sur un nœud. Les exemples d’opérations de récupération incluent (mais ne sont pas limités) lorsqu’un nœud non sain est redémarré ou qu’un nœud de calcul a disparu en raison d’une défaillance de l’hôte. Les nouvelles tentatives en raison d’opérations de récupération sont indépendantes et ne sont pas comptabilisées par rapport au maxTaskRetryCount. Même si maxTaskRetryCount est 0, une nouvelle tentative interne en raison d’une opération de récupération peut se produire. En raison de cela, toutes les tâches doivent être idempotentes. Cela signifie que les tâches doivent tolérer l’interruption et le redémarrage sans provoquer d’altération ou de doublon des données. La meilleure pratique pour les tâches longues consiste à utiliser une forme de point de contrôle. Dans certains cas, startTask peut être réexécuter même si le nœud de calcul n’a pas été redémarré. Vous devez veiller à éviter les tâches StartTask qui créent un processus d’arrêt ou installent/lancent des services à partir du répertoire de travail StartTask, car cela empêche Batch de pouvoir réexécuter l’objet StartTask.
targetDedicatedNodes	integer	Nombre souhaité de nœuds de calcul dédiés dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur true. Si enableAutoScale a la valeur false, vous devez définir targetDedicatedNodes, targetLowPriorityNodes ou les deux.
targetLowPriorityNodes	integer	Nombre souhaité de nœuds de calcul Spot/Basse priorité dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur true. Si enableAutoScale a la valeur false, vous devez définir targetDedicatedNodes, targetLowPriorityNodes ou les deux.
targetNodeCommunicationMode	NodeCommunicationMode	Mode de communication de nœud souhaité pour le pool. Si elle est omise, la valeur par défaut est Default.
taskSchedulingPolicy	TaskSchedulingPolicy	Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. S’il n’est pas spécifié, la valeur par défaut est répartie.
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. La valeur par défaut est 1. La valeur maximale est la plus petite de 4 fois le nombre de cœurs de la vmSize du pool ou 256.
upgradePolicy	UpgradePolicy	Stratégie de mise à niveau pour le pool. Décrit une stratégie de mise à niveau : automatique, manuelle ou propagée.
userAccounts	UserAccount[]	Liste des comptes d’utilisateur à créer sur chaque nœud de calcul du pool.
virtualMachineConfiguration	VirtualMachineConfiguration	Configuration de la machine virtuelle pour le pool. Cette propriété doit être spécifiée.
vmSize	string	Taille des machines virtuelles dans le pool. Toutes les machines virtuelles d’un pool sont de la même taille. Pour plus d’informations sur les tailles disponibles de machines virtuelles dans les pools, consultez Choisir une taille de machine virtuelle pour les nœuds de calcul dans un pool Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

PublicIPAddressConfiguration

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. Le nombre d’adresses IP spécifiées ici limite la taille maximale du pool - 100 nœuds dédiés ou 100 nœuds Spot/Basse priorité peuvent être alloués pour chaque adresse IP publique. Par exemple, un pool nécessitant 250 machines virtuelles dédiées aurait besoin d’au moins 3 adresses IP publiques spécifiées. Chaque élément de cette collection est de la forme : /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision	IPAddressProvisioningType	Type d’approvisionnement pour les adresses IP publiques pour le pool. La valeur par défaut est BatchManaged.

ResourceFile

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. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée.
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. La propriété est valide uniquement lorsque autoStorageContainerName ou storageContainerUrl est utilisé. Ce préfixe peut être un nom de fichier partiel ou un sous-répertoire. Si aucun préfixe n’est spécifié, tous les fichiers du conteneur sont téléchargés.
fileMode	string	Attribut du mode d’autorisation de fichier au format octal. Cette propriété s’applique uniquement aux fichiers téléchargés sur des nœuds de calcul Linux. Elle sera ignorée si elle est spécifiée pour un resourceFile qui sera téléchargé sur un nœud de calcul Windows. Si cette propriété n’est pas spécifiée pour un nœud de calcul Linux, la valeur par défaut 0770 est appliquée au fichier.
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. Si la propriété httpUrl est spécifiée, filePath est requis et décrit le chemin vers lequel le fichier sera téléchargé, y compris le nom de fichier. Sinon, si la propriété autoStorageContainerName ou storageContainerUrl est spécifiée, filePath est facultatif et est le répertoire dans lequel télécharger les fichiers. Dans le cas où filePath est utilisé comme répertoire, toute structure de répertoires déjà associée aux données d’entrée sera conservée dans son intégralité et ajoutée au répertoire filePath spécifié. Le chemin d’accès relatif spécifié ne peut pas sortir du répertoire de travail de la tâche (par exemple à l’aide de '..').
httpUrl	string	URL du fichier à télécharger. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée. Si l’URL pointe vers stockage Blob Azure, elle doit être lisible à partir de nœuds de calcul. Il existe trois façons d’obtenir cette URL pour un objet blob dans le stockage Azure : incluez une signature d’accès partagé (SAP) accordant des autorisations de lecture sur l’objet blob, utilisez une identité managée avec une autorisation de lecture ou définissez la liste de contrôle d’accès pour l’objet blob ou son conteneur afin d’autoriser l’accès public.
identityReference	ComputeNodeIdentityReference	Référence à l’identité affectée par l’utilisateur à utiliser pour accéder au stockage Blob Azure spécifié par storageContainerUrl ou httpUrl Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
storageContainerUrl	string	URL du conteneur d’objets blob dans Stockage Blob Azure. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée. Cette URL doit être lisible et listable à partir de nœuds de calcul. Il existe trois façons d’obtenir une telle URL pour un conteneur dans le stockage Azure : inclure une signature d’accès partagé (SAP) accordant des autorisations de lecture et de liste sur le conteneur, utiliser une identité managée avec des autorisations de lecture et de liste, ou définir la liste de contrôle d’accès pour le conteneur afin d’autoriser l’accès public.

RollingUpgradePolicy

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.

SecurityEncryptionTypes

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

SecurityProfile

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

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.

Nom	Type	Description
id	string	ID de référence de l’artefact de service de ServiceArtifactReference ID de référence de l’artefact de service sous la forme de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

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 StartTask. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Paramètres du conteneur sous lequel StartTask s’exécute. Lorsque cela est spécifié, tous les répertoires sont récursifs sous le AZ_BATCH_NODE_ROOT_DIR (la racine des répertoires Azure Batch sur le nœud) sont mappés dans le conteneur, toutes les variables d’environnement de tâche sont mappées au conteneur et la ligne de commande Task est exécutée dans le conteneur. Les fichiers produits dans le conteneur en dehors de AZ_BATCH_NODE_ROOT_DIR peuvent ne pas être répercutés sur le disque hôte, ce qui signifie que les API de fichier Batch ne pourront pas accéder à ces fichiers.
environmentSettings	EnvironmentSetting[]	Liste des paramètres de variable d’environnement pour StartTask.
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. Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives. Le service Batch essaiera la tâche une seule fois et peut ensuite réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est égal à 3, Batch tente la tâche jusqu’à 4 fois (une tentative initiale et 3 nouvelles tentatives). Si le nombre maximal de nouvelles tentatives est égal à 0, le service Batch ne réessaye pas la tâche. Si le nombre maximal de nouvelles tentatives est -1, le service Batch retente la tâche sans limite, mais cela n’est pas recommandé pour une tâche de démarrage ou une tâche. La valeur par défaut est 0 (aucune nouvelle tentative).
resourceFiles	ResourceFile[]	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. Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche.
userIdentity	UserIdentity	Identité de l’utilisateur sous laquelle StartTask s’exécute. Si elle est omise, la tâche s’exécute en tant qu’utilisateur non administratif unique à la tâche.
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. Si la valeur est true et que StartTask échoue sur un nœud, le service Batch retente la tâche StartTask jusqu’à son nombre maximal de nouvelles tentatives (maxTaskRetryCount). Si la tâche n’est toujours pas terminée après toutes les nouvelles tentatives, le service Batch marque le nœud inutilisable et ne planifie pas les tâches. Cette condition peut être détectée via les détails de l’état du nœud de calcul et des informations d’échec. Si la valeur est false, le service Batch n’attend pas la fin de l’opération StartTask. Dans ce cas, d’autres tâches peuvent commencer à s’exécuter sur le nœud de calcul pendant l’exécution de StartTask ; et même si StartTask échoue, les nouvelles tâches continuent d’être planifiées sur le nœud de calcul. La valeur par défaut est true.

StorageAccountType

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.

TaskConstraints

Contraintes d’exécution à appliquer à une tâche.

Nom	Type	Description
maxTaskRetryCount	integer	Nombre maximal de nouvelles tentatives de la tâche. Le service Batch retente une tâche si son code de sortie n’est pas différent de zéro. Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives pour l’exécutable de tâche en raison d’un code de sortie différent de zéro. Le service Batch essaiera la tâche une seule fois et peut ensuite réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est égal à 3, Batch tente la tâche jusqu’à 4 fois (une tentative initiale et 3 nouvelles tentatives). Si le nombre maximal de nouvelles tentatives est égal à 0, le service Batch ne réessaye pas la tâche après la première tentative. Si le nombre maximal de nouvelles tentatives est -1, le service Batch retente la tâche sans limite, mais cela n’est pas recommandé pour une tâche de démarrage ou une tâche. La valeur par défaut est 0 (aucune nouvelle tentative).
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. S’il n’est pas spécifié, il n’existe aucune limite de temps sur la durée pendant laquelle la tâche peut s’exécuter.
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. La valeur par défaut est de 7 jours, c’est-à-dire que le répertoire des tâches est conservé pendant 7 jours, sauf si le nœud de calcul est supprimé ou si le travail est supprimé.

TaskContainerSettings

Paramètres de conteneur d’une tâche.

Nom	Type	Description
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Chemins que vous souhaitez monter sur la tâche conteneur. Si ce tableau est null ou n’est pas présent, la tâche de conteneur monte l’intégralité du lecteur de disque temporaire dans windows (ou AZ_BATCH_NODE_ROOT_DIR sous Linux). Il ne monte aucun chemin de données dans un conteneur si ce tableau est défini comme vide.
containerRunOptions	string	Options supplémentaires pour la commande de création de conteneur. Ces options supplémentaires sont fournies en tant qu’arguments de la commande « docker create », en plus de celles contrôlées par le service Batch.
imageName	string	Image à utiliser pour créer le conteneur dans lequel la tâche s’exécutera. Il s’agit de la référence d’image complète, comme indiqué dans « docker pull ». Si aucune balise n’est fournie dans le cadre du nom de l’image, la balise « :latest » est utilisée comme valeur par défaut.
registry	ContainerRegistry	Registre privé qui contient l’image conteneur. Ce paramètre peut être omis s’il a déjà été fourni lors de la création du pool.
workingDirectory	ContainerWorkingDirectory	Emplacement du répertoire de travail de tâche de conteneur. La valeur par défaut est « taskWorkingDirectory ».

TaskSchedulingPolicy

Spécifie la façon dont les tâches doivent être distribuées entre les nœuds de calcul.

Nom	Type	Description
nodeFillType	ComputeNodeFillType	Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. S’il n’est pas spécifié, la valeur par défaut est répartie.

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.

UpgradeMode

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.

UpgradePolicy

Décrit une stratégie de mise à niveau : automatique, manuelle ou propagée.

Nom	Type	Description
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation. Paramètres de configuration utilisés pour effectuer la mise à niveau automatique du système d’exploitation.
mode	UpgradeMode	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.
rollingUpgradePolicy	RollingUpgradePolicy	Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée. Paramètres de configuration utilisés lors de l’exécution d’une mise à niveau propagée.

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	ElevationLevel	Niveau d’élévation du compte d’utilisateur. La valeur par défaut n’est pasAdmin.
linuxUserConfiguration	LinuxUserConfiguration	Configuration utilisateur spécifique à Linux pour le compte d’utilisateur. Cette propriété est ignorée si elle est spécifiée sur un pool Windows. S’il n’est pas spécifié, l’utilisateur est créé avec les options par défaut.
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	WindowsUserConfiguration	Configuration utilisateur spécifique à Windows pour le compte d’utilisateur. Cette propriété ne peut être spécifiée que si l’utilisateur se trouve sur un pool Windows. S’il n’est pas spécifié et sur un pool Windows, l’utilisateur est créé avec les options par défaut.

UserIdentity

Définition de l’identité de l’utilisateur sous laquelle la tâche est exécutée.

Nom	Type	Description
autoUser	AutoUserSpecification	Utilisateur automatique sous lequel la tâche est exécutée. Les propriétés userName et autoUser s’excluent mutuellement ; vous devez en spécifier un, mais pas les deux.
username	string	Nom de l’identité utilisateur sous laquelle la tâche est exécutée. Les propriétés userName et autoUser s’excluent mutuellement ; vous devez en spécifier un, mais pas les deux.

VirtualMachineConfiguration

Configuration des nœuds de calcul dans un pool en fonction de l’infrastructure des machines virtuelles Azure.

Nom	Type	Description
containerConfiguration	ContainerConfiguration	Configuration du conteneur pour le pool. S’il est spécifié, le programme d’installation est effectué sur chaque nœud de calcul du pool pour autoriser l’exécution des tâches dans des conteneurs. Toutes les tâches régulières et les tâches du gestionnaire de travaux s’exécutent sur ce pool doivent spécifier la propriété containerSettings, et toutes les autres tâches peuvent la spécifier.
dataDisks	DataDisk[]	Configuration des disques de données attachés aux nœuds de calcul du pool. Cette propriété doit être spécifiée si les nœuds de calcul du pool doivent avoir des disques de données vides attachés. Cela ne peut pas être mis à jour. Chaque nœud de calcul obtient son propre disque (le disque n’est pas un partage de fichiers). Les disques existants ne peuvent pas être attachés, chaque disque attaché est vide. Lorsque le nœud de calcul est supprimé du pool, le disque et toutes les données associées sont également supprimées. Le disque n’est pas mis en forme après l’attachement, il doit être mis en forme avant d’être utilisé. Pour plus d’informations, consultez https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux et https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.
diskEncryptionConfiguration	DiskEncryptionConfiguration	Configuration du chiffrement de disque pour le pool. Si spécifié, le chiffrement est effectué sur chaque nœud du pool pendant l’approvisionnement de nœuds.
extensions	VMExtension[]	Extension de machine virtuelle pour le pool. Si elle est spécifiée, les extensions mentionnées dans cette configuration sont installées sur chaque nœud.
imageReference	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. Cela s’applique uniquement aux images qui contiennent le système d’exploitation Windows et ne doivent être utilisées que lorsque vous conservez des licences locales valides pour les nœuds de calcul qui seront déployés. En cas d’omission, aucune remise de licence locale n’est appliquée. Les valeurs sont les suivantes : 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. L’agent Batch Compute Node est un programme qui s’exécute sur chaque nœud de calcul du pool et fournit l’interface de commande et de contrôle entre le nœud de calcul et le service Batch. Il existe différentes implémentations de l’agent de nœud de calcul, appelées références SKU, pour différents systèmes d’exploitation. Vous devez spécifier une référence SKU de l’agent Compute Node qui correspond à la référence d’image sélectionnée. Pour obtenir la liste des références SKU de l’agent de nœud de calcul prises en charge, ainsi que leur liste de références d’images vérifiées, consultez l’opération « Répertorier les références SKU de l’agent de nœud de calcul prises en charge ».
nodePlacementConfiguration	NodePlacementConfiguration	Configuration de placement de nœud pour le pool. Cette configuration spécifie des règles sur la façon dont les nœuds du pool seront alloués physiquement.
osDisk	OSDisk	Paramètres du disque du système d’exploitation de la machine virtuelle.
securityProfile	SecurityProfile	Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques. Spécifie les paramètres de profil de sécurité de la machine virtuelle ou du groupe de machines virtuelles identiques.
serviceArtifactReference	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. ID de référence de l’artefact de service sous la forme de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	Paramètres du système d’exploitation Windows sur la machine virtuelle. Cette propriété ne doit pas être spécifiée si la propriété imageReference spécifie une image de système d’exploitation Linux.

VMDiskSecurityProfile

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

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 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. Collection de noms d’extensions après lesquels cette extension doit être provisionnée.
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.

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. Si elle est omise, la valeur par défaut est true.

WindowsUserConfiguration

Propriétés utilisées pour créer un compte d’utilisateur sur un nœud de calcul Windows.

Nom	Type	Description
loginMode	LoginMode	Mode de connexion de l’utilisateur La valeur par défaut est « batch ».