Job - List

Service:

Batch Service

API Version:

2023-11-01.18.0

Répertorie tous les travaux dans le compte spécifié.

GET {batchUrl}/jobs?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
api-version	query	True	string	Version de l’API cliente.
$expand	query		string	Clause de $expand OData.
$filter	query		string	Clause de $filter OData. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.
$select	query		string	Clause de $select OData.
maxresults	query		integer int32	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1 000 travaux peut être retourné.
timeout	query		integer int32	Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

Media Types: "application/json; odata=minimalmetadata"

Nom	Obligatoire	Type	Description
client-request-id		string uuid	Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date		string date-time-rfc1123	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement.

Réponses

Nom	Type	Description
200 OK	CloudJobListResult	Réponse contenant la liste des travaux. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Erreur du service Batch.

Sécurité

azure_auth

Microsoft Entra flux de code d’authentification OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

Job list

Sample Request

HTTP

GET account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "jobId",
      "url": "https://account.region.batch.azure.com/jobs/jobId",
      "eTag": "0x8D4100FC46D5BF4",
      "lastModified": "2016-11-19T00:05:27.2137716Z",
      "creationTime": "2016-11-19T00:05:25.311915Z",
      "state": "active",
      "stateTransitionTime": "2016-11-19T00:05:27.2137716Z",
      "previousState": "disabled",
      "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z",
      "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",
        "poolId": "poolId"
      },
      "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.
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 de 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	Travail Azure Batch.
CloudJobListResult	Résultat de la liste des travaux dans un compte.
CloudServiceConfiguration	Configuration des nœuds de calcul dans un pool basé sur la plateforme Azure Services cloud.
ComputeNodeFillType	Comment les tâches sont distribuées entre les nœuds de calcul dans 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.
ContainerRegistry	Un registre de conteneurs privé.
ContainerType	Technologie de conteneur à utiliser.
ContainerWorkingDirectory	Emplacement du répertoire de travail de la tâche du 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 formater les disques à partir d'une machine virtuelle pour les utiliser.
DiffDiskPlacement	Spécifie l’emplacement de disque éphémère pour le disque du système d’exploitation pour tous les nœuds de calcul (machines virtuelles) du pool.
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 Azure Compute Gallery Image.
DiskEncryptionTarget	La liste des cibles de disque batch Service chiffrera 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 Task.
ErrorCategory	Catégorie de l’erreur.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
HttpHeader	Une paire nom-valeur d’en-tête HTTP
ImageReference	Référence à une image de la Place de marché Azure Machines Virtuelles ou à une image Azure Compute Gallery. Pour obtenir la liste de toutes les références d’images Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ».
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 toute tâche du travail sur un nœud de calcul donné.
JobReleaseTask	Tâche de mise en production du travail à exécuter à l’achèvement du travail sur n’importe quel nœud de calcul sur lequel le travail s’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éseau 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 du placement des nœuds 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 à l’état terminé.
OnTaskFailure	Action que le service Batch doit effectuer en cas d’échec d’une tâche dans le travail.
OSDisk	Paramètres du disque du système d’exploitation du nœud de calcul.
OutputFile	Spécification pour le chargement de fichiers à partir d’un nœud de calcul Azure Batch vers un autre emplacement une fois que le service Batch a terminé l’exécution du processus Task.
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	La durée de vie minimale des pools automatiques créés et la façon dont plusieurs travaux planifiés sont attribués aux pools.
PoolSpecification	Spécification pour la création d’un pool.
PublicIPAddressConfiguration	Configuration de l’adresse IP publique de la configuration réseau d’un pool.
ResourceFile	Fichier unique ou plusieurs fichiers à télécharger sur un nœud de calcul.
SecurityProfile	Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le 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 d’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la dernière version de l’image.
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 dans la création de disques de données ou de 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.
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 basé sur l’infrastructure Azure Machines Virtuelles.
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 cette valeur est omise 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 http status code 409. Si cette valeur est omise 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 », qui accorde l’accès à toutes les opérations liées au travail qui contient la tâche.

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 faire la distinction entre les pools créés à différentes fins, vous pouvez spécifier cet élément pour ajouter un préfixe à l’ID affecté. Le préfixe peut contenir jusqu'à 20 caractères.
keepAlive	boolean	Indique s’il faut maintenir un pool automatique en vie 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 (déterminée par le paramètre poolLifetimeOption) expire ; c’est-à-dire lorsque le travail ou la planification du travail se termine. Si la valeur est true, le service Batch ne supprime pas automatiquement le pool. Il appartient à l’utilisateur de supprimer les pools automatiques créés avec cette option.
pool	PoolSpecification	Spécification du pool pour le pool automatique.
poolLifetimeOption	PoolLifetimeOption	La durée de vie minimale des pools automatiques créés et la façon dont plusieurs travaux planifiés 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 est nonAdmin.
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 susceptible d’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 doit être accessible par StartTasks.

AzureBlobFileSystemConfiguration

Informations utilisées pour se connecter à un conteneur de stockage Azure à l’aide de Blobfuse.

Nom	Type	Description
accountKey	string	Clé de compte de stockage Azure. Cette propriété s’exclue mutuellement avec sasKey et identity ; 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 mount. Il s’agit des options « net use » dans 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 montages Batch, accessible via la variable d’environnement AZ_BATCH_NODE_MOUNTS_DIR.
sasKey	string	Jeton SAS stockage Azure. Cette propriété s’exclut mutuellement avec accountKey et identity ; exactement un doit être spécifié.

AzureFileShareConfiguration

Informations utilisées pour se connecter à un partage de fichiers Azure.

Nom	Type	Description
accountKey	string	Clé de compte de stockage Azure.
accountName	string	Nom du compte stockage Azure.
azureFileUrl	string	URL Azure Files. Il s’agit de la forme « https://{account}.file.core.windows.net/ ».
mountOptions	string	Options de ligne de commande supplémentaires à passer à la commande mount. Il s’agit des options « net use » dans 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 montages 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 programmation.
message	ErrorMessage	Message décrivant l’erreur, destiné à être affiché 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 lecture et é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 (c’est-à-dire créés avec cloudServiceConfiguration ou avec virtualMachineConfiguration à l’aide d’une référence d’image 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 la tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour rechercher cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certs » est créé dans le répertoire de base de l’utilisateur (par exemple, /home/{nom-utilisateur}/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 (c’est-à-dire créés avec cloudServiceConfiguration ou avec virtualMachineConfiguration à l’aide d’une référence d’image Windows). Les noms de magasins courants incluent : 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 auquel l’empreinte numérique est associée. Il doit s’agir de 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 AutoUser Scope est pool à la fois pour StartTask et une tâche, ce certificat sera également visible pour la tâche.
task	string	Le certificat doit être visible pour les comptes d’utilisateur sous lesquels les tâches de travail sont exécutées.

CIFSMountConfiguration

Informations utilisées pour se connecter à un système de fichiers CIFS.

Nom	Type	Description
mountOptions	string	Options de ligne de commande supplémentaires à passer à la commande mount. Il s’agit des options « net use » dans Windows et « mount » dans Linux.
password	string	Mot de passe à utiliser pour l’authentification sur le système de fichiers CIFS.
relativeMountPath	string	Chemin d’accès relatif sur le nœud de calcul où le système de fichiers sera monté Tous les systèmes de fichiers sont montés par rapport au répertoire de montages 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 sur le système de fichiers CIFS.

CloudJob

Travail Azure Batch.

Nom	Type	Valeur par défaut	Description
allowTaskPreemption	boolean		Si les tâches de ce travail peuvent être préemptées par d’autres travaux de haute priorité Si la valeur est définie sur True, d’autres travaux de priorité élevée soumis au système sont prioritaires et peuvent mettre de nouveau les tâches en file d’attente à partir de ce travail. Vous pouvez mettre à jour l’objet 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 de variables d’environnement courants. 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 requêtes. En particulier, vous pouvez passer l’ETag lors de la mise à jour d’un travail pour spécifier que vos modifications ne doivent prendre effet que si personne d’autre n’a modifié le travail entre-temps.
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 dans un compte qui diffèrent uniquement par la casse).
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 dans le travail. Lors de la réduction d’un pool, le service Batch tente de conserver les nœuds sur 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és avant que les nœuds de calcul n’exécutent des 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 la planifier à la priorité la plus élevée. S’il n’y a pas de nœuds de calcul inactifs disponibles, le système peut arrêter l’une des tâches en cours d’exécution dans le pool et la renvoyer à la file d’attente afin de libérer de l’espace 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 la priorité sur les tâches d’autres travaux. Dans l’ensemble des travaux, seules les priorités au niveau de l’emploi sont observées. Par exemple, si un gestionnaire de travaux dans une tâche de priorité 0 doit être redémarré, il ne déplace pas les tâches d’un travail de priorité 1. Batch effectue une nouvelle tentative de 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 dues aux opérations de récupération sont indépendantes de et ne sont pas comptabilisées dans maxTaskRetryCount. Même si maxTaskRetryCount est 0, une nouvelle tentative interne en raison d’une opération de récupération peut se produire. Pour cette raison, 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 de longue durée 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 exécution de tâche spéciale à la fin du travail sur chaque nœud de calcul qui a exécuté une autre tâche du travail.
lastModified	string		Heure de la dernière modification du travail. C’est la dernière fois que les données au niveau du travail, telles que l’état ou la priorité du travail, ont changé. Il ne prend pas en compte les modifications au niveau de la tâche, telles que l’ajout de nouvelles tâches ou le changement d’état des tâches.
maxParallelTasks	integer	-1	Nombre maximal de tâches pouvant être exécutées en parallèle pour le travail. La valeur de maxParallelTasks doit être -1 ou supérieure à 0 si elle est 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 pouvant ê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’attribue 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 à l’état terminé. La valeur par défaut est noaction.
onTaskFailure	OnTaskFailure		Action que le service Batch doit effectuer en cas d’échec d’une tâche dans le travail. Une tâche est considérée comme ayant échoué en cas d’échecInfo. Une valeur failureInfo est définie si la tâche se termine avec un code de sortie différent de zéro après avoir épuisé son nombre de nouvelles tentatives, ou s’il y a eu une erreur au 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 de 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 initial Actif.
previousStateTransitionTime	string		Heure à laquelle le travail est entré dans son état précédent. Cette propriété n’est pas définie si le travail est dans son état initial Actif.
priority	integer		Priorité du travail. Les valeurs de priorité peuvent être comprises entre -1000 et 1000, -1 000 étant la priorité la plus basse et 1000 la plus haute. La valeur par défaut est 0.
state	JobState		État actuel du travail.
stateTransitionTime	string		Heure à laquelle le travail est entré dans son état actuel.
stats	JobStatistics		Statistiques d’utilisation des ressources pour toute la durée de vie du travail. Cette propriété est renseignée uniquement si cloudJob a été récupéré avec une clause expand incluant l’attribut « stats » ; sinon, elle est null. Les statistiques peuvent ne pas être immédiatement disponibles. Le service Batch effectue un cumul périodique des statistiques. Le délai standard 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 les unes sur les autres. La valeur par défaut est false.

CloudJobListResult

Résultat de la liste des travaux dans un compte.

Nom	Type	Description
odata.nextLink	string	URL permettant d’obtenir l’ensemble de résultats suivant.
value	CloudJob[]	Liste des travaux.

CloudServiceConfiguration

Configuration des nœuds de calcul dans un pool basé sur la plateforme Azure Services cloud.

Nom	Type	Description
osFamily	string	Famille de systèmes d’exploitation invités Azure à installer sur les machines virtuelles du pool. Les valeurs possibles sont : 2 - Famille du système d’exploitation 2, équivalent à Windows Server 2008 R2 SP1. 3 - Famille du système d’exploitation 3, équivalent à Windows Server 2012. 4 - Famille du système d’exploitation 4, équivalent à Windows Server 2012 R2. 5 - Famille du système d’exploitation 5, équivalent à Windows Server 2016. 6 - Famille du système d’exploitation 6, équivalent à Windows Server 2019. Pour plus d’informations, consultez Versions du système d’exploitation invité Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
osVersion	string	Version du système d’exploitation invité Azure à installer sur les machines virtuelles du pool. La valeur par défaut est * qui spécifie la dernière version du système d’exploitation pour la famille de systèmes d’exploitation spécifiée.

ComputeNodeFillType

Comment les tâches sont distribuées entre les nœuds de calcul dans un pool.

Nom	Type	Description
pack	string	Autant de tâches que possible (taskSlotsPerNode) doivent être affectées à chaque nœud de calcul dans le pool avant qu’une tâche ne soit affectée 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 le spécifie « docker pull ». Une image provient du registre Docker par défaut, sauf si l’image est complète 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.

ContainerRegistry

Un registre de conteneurs privé.

Nom	Type	Description
identityReference	ComputeNodeIdentityReference	Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à un Azure Container Registry au lieu du nom d’utilisateur et du mot de passe. 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 se connecter au serveur du Registre.
registryServer	string	L’URL du registre. En cas d’omission, 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 avec Docker sera utilisée pour lancer les conteneurs.

ContainerWorkingDirectory

Emplacement du répertoire de travail de la tâche du conteneur.

Nom	Type	Description
containerImageDefault	string	Utilisez le répertoire de travail défini dans l’image conteneur. Veillez à ce que ce répertoire ne contienne pas les fichiers de ressources téléchargés par Batch.
taskWorkingDirectory	string	Utilisez le répertoire de travail tâche du service Batch standard, qui contient 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 formater 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 de disque initiale en gigaoctets.
lun	integer	Numéro d’unité logique. Le lun est utilisé pour identifier chaque disque de données de manière unique. 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. En cas d’omission, la valeur par défaut est « standard_lrs ».

DiffDiskPlacement

Spécifie l’emplacement de disque éphémère pour le disque du système d’exploitation pour tous les nœuds de calcul (machines virtuelles) du pool.

Nom	Type	Description
CacheDisk	string	Le disque de système d’exploitation éphémère est stocké sur le cache de la machine virtuelle.

DiffDiskSettings

Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par le nœud de calcul (machine virtuelle).

Nom	Type	Description
placement	DiffDiskPlacement	Spécifie l’emplacement de disque éphémère pour le 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 de choix de l’emplacement, par exemple, de l’espace disque de cache pour l’approvisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences en matière de taille de disque de système d’exploitation éphémère, reportez-vous aux exigences de taille de disque du système d’exploitation éphémère pour les machines virtuelles Windows sur https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et aux machines virtuelles Linux à l’adresse https://docs.microsoft.com/en-us/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 Azure Compute Gallery Image.

Nom	Type	Description
targets	DiskEncryptionTarget[]	La liste des cibles de disque batch Service chiffrera sur le nœud de calcul. En cas d’omission, aucun disque sur les nœuds de calcul du pool ne sera chiffré. Sur le pool Linux, seul « TemporaryDisk » est pris en charge ; sur le pool Windows, « OsDisk » et « TemporaryDisk » doivent être spécifiés.

DiskEncryptionTarget

La liste des cibles de disque batch Service chiffrera sur le nœud de calcul.

Nom	Type	Description
osdisk	string	Le disque du système d’exploitation sur le nœud de calcul est chiffré.
temporarydisk	string	Le disque temporaire sur le nœud de calcul est chiffré. Sur Linux, ce chiffrement s’applique à d’autres partitions (telles que celles sur les disques de données montés) lorsque le chiffrement se produit au moment du démarrage.

DynamicVNetAssignmentScope

Étendue de l’attribution de réseau virtuel dynamique.

Nom	Type	Description
job	string	L’attribution de réseau virtuel dynamique est effectuée par travail.
none	string	Aucune attribution de réseau virtuel dynamique n’est activée.

ElevationLevel

Niveau d’élévation de l’utilisateur.

Nom	Type	Description
admin	string	L’utilisateur est un utilisateur disposant d’un accès élevé et fonctionne avec des autorisations d’administrateur complètes.
nonadmin	string	L’utilisateur est un utilisateur standard sans accès élevé.

EnvironmentSetting

Variable d’environnement à définir sur un processus Task.

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

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 utilisateur, tel qu’une 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

Une paire nom-valeur d’en-tête HTTP

Nom	Type	Description
name	string	Nom non sensible à la casse de l’en-tête à utiliser lors du chargement des fichiers de sortie
value	string	Valeur de l’en-tête à utiliser lors du chargement des fichiers de sortie

ImageReference

Référence à une image de la Place de marché Azure Machines Virtuelles ou à une image Azure Compute Gallery. Pour obtenir la liste de toutes les références d’images Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ».

Nom	Type	Description
exactVersion	string	Version spécifique de l’image de plateforme ou de l’image de la Place de marché utilisée pour créer le nœud. Ce champ en lecture seule diffère de « version » uniquement si la valeur spécifiée pour « version » lors de la création du pool était « latest ».
offer	string	Type d’offre de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, UbuntuServer ou WindowsServer.
publisher	string	Éditeur de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, Canonical ou MicrosoftWindowsServer.
sku	string	Référence SKU de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, 18.04-LTS ou 2019-Datacenter.
version	string	Version de l’image de la Place de marché Azure Machines Virtuelles. 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 Azure Compute Gallery. Les nœuds de calcul dans le pool seront créés à l’aide de cet ID d’image. Il s’agit de la forme /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pour toujours utiliser la dernière version d’image par défaut. Cette propriété s’exclut mutuellement avec d’autres propriétés ImageReference. L’image Azure Compute Gallery 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 imageId, la version la plus récente est utilisée. Pour plus d’informations sur les paramètres de pare-feu pour que l’agent Batch Compute Node communique avec le service Batch, consultez https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#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. Il doit être unique au sein d’un pool Batch. Les valeurs acceptables sont comprises entre 1 et 65535, sauf pour 22, 3389, 29876 et 29877, car elles sont réservées. Si des valeurs réservées sont fournies, la requête échoue avec le code HTTP status 400.
frontendPortRangeEnd	integer	Dernier numéro de port dans la plage de ports externes qui seront utilisés pour fournir un accès entrant au backendPort sur des nœuds de calcul individuels. Les valeurs acceptables sont comprises entre 1 et 65534, à l’exception des ports de 50000 à 55000 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 qui se chevauchent sont fournies, la demande échoue avec le code HTTP status 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 back-endPort sur des nœuds de calcul individuels. Les valeurs acceptables sont comprises entre 1 et 65534, sauf les ports de 50000 à 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 qui se chevauchent sont fournies, la demande échoue avec le code HTTP status 400.
name	string	Nom du point de terminaison. Le nom doit être unique au sein d’un pool Batch, il 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, se terminer par une lettre, un chiffre ou un trait de soulignement et ne peuvent pas dépasser 77 caractères. Si des valeurs non valides sont fournies, la demande échoue avec le code HTTP status 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 pouvant ê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 HTTP status 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	Nombre maximal de fois que chaque tâche peut être retentée. Le service Batch retente une tâche si son code de sortie est différent de zéro. Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives. Le service Batch essaiera chaque tâche une fois, puis peut réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est de 3, Batch tente une tâche jusqu’à 4 fois (une tentative initiale et 3 tentatives). Si le nombre maximal de nouvelles tentatives est 0, le service Batch ne réessaye pas Tasks. Si le nombre maximal de nouvelles tentatives est -1, le service Batch retente tâches sans limite. La valeur par défaut est 0 (aucune nouvelle tentative).
maxWallClockTime	string	Durée maximale d’exécution du travail, mesurée à 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, la durée d’exécution du travail n’est pas limitée.

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 à l’état terminé.
poolId	string	ID du pool auquel ce travail est attribué. 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 a été exécuté sur un pool automatique et que 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 au 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 à l’état terminé. Si le service Batch termine le travail, il définit la raison comme suit : JMComplete - la tâche du gestionnaire de travaux terminée et killJobOnCompletion a été défini 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 terminé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é un 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’applications que le service Batch déploiera 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 Task. Par conséquent, si un package d’application référencé se trouve déjà sur le nœud de calcul et est à jour, il n’est pas re-téléchargé ; 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 du 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 afin d’ajouter d’autres tâches au travail, ou case activée la status 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’expansion des variables 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 (relatif au répertoire de travail De la tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/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 containerConfiguration set, celui-ci doit également être défini. Si le pool qui exécutera cette tâche n’a pas de conteneurConfiguration défini, cela ne doit pas être défini. Lorsque cela est spécifié, tous les répertoires 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 dans le conteneur et la ligne de commande Tâche 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 fichiers 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 d’une longueur maximale de 1 024.
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’ensemble du travail. Si la valeur est true, lorsque la tâche du gestionnaire de travaux se termine, le service Batch marque le travail comme terminé. Si des tâches sont toujours en cours d’exécution (autres que la mise en production 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 le status de travail. Dans ce cas, vous devez utiliser l’attribut onAllTasksComplete pour arrêter le travail, ou demander à un client ou à un utilisateur d’arrêter le travail explicitement. Par exemple, le Gestionnaire de travaux crée un ensemble de tâches, mais n’a plus de rôle dans leur 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 du travail (et non pour surveiller la progression), il est important de définir killJobOnCompletion sur false.
outputFiles	OutputFile[]	Liste des fichiers que le service Batch chargera à partir du nœud de calcul après l’exécution de la ligne de commande. Pour les tâches multi-instance, les fichiers sont uniquement chargés à partir du nœud de calcul sur lequel la tâche principale est exécutée.
requiredSlots	integer	Nombre d’emplacements de planification dont la tâche a besoin pour s’exécuter. La valeur par défaut est 1. Une tâche peut être planifiée pour s’exécuter sur un nœud de calcul uniquement si le nœud dispose de suffisamment d’emplacements de planification disponibles. Pour les tâches multi-instance, 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échargera 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 demande échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Vous pouvez y parvenir à l’aide de fichiers .zip, de packages d’application ou de conteneurs Docker.
runExclusive	boolean	Indique si la tâche du Gestionnaire de travaux nécessite une utilisation exclusive du nœud de calcul sur lequel elle s’exécute. Si la valeur est true, aucune autre tâche ne s’exécutera 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 est normalement comptabilisée 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
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 seront joints pendant la durée de la tâche. Cela fonctionne uniquement avec un pool VirtualMachineConfiguration. Le réseau virtuel doit se trouver dans la même région et 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écuteront 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 de Role-Based Access Control « Contributeur de machine virtuelle classique » (RBAC) pour le réseau virtuel spécifié afin que Azure Batch service 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 vers les nœuds du 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 les communications entrantes à 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/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Tâche de préparation du travail à exécuter avant toute tâche 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’expansion des variables 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 (relatif au répertoire de travail De la tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/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 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 dans le conteneur et la ligne de commande Tâche 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 fichiers 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 manière 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 affecte la 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 demande avec le code d’erreur TaskIdSameAsJobPreparationTask ; si vous appelez directement l’API REST, le code http status est 409 (conflit).
rerunOnNodeRebootAfterSuccess	boolean	Indique si le service Batch doit réexécuter la tâche de préparation du travail après le 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’est pas terminée (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 de travail pour qu’elle soit idempotente et qu’elle se comporte 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échargera 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 demande échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Vous pouvez y parvenir à l’aide de fichiers .zip, de packages d’application ou de conteneurs Docker.
userIdentity	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 en tant qu’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 d’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 de contraintes). Si la tâche ne s’est toujours pas terminée correctement 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, de 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 à l’achèvement du travail sur n’importe quel nœud de calcul sur lequel le travail s’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’expansion des variables 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 (relatif au répertoire de travail De la tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/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 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 dans le conteneur et la ligne de commande Tâche 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 fichiers 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 manière 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 affecte la 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 demande avec le code d’erreur TaskIdSameAsJobReleaseTask ; si vous appelez directement l’API REST, le code http status 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 15 minutes. Vous ne pouvez pas spécifier un délai d’expiration supérieur à 15 minutes. Si vous le faites, le service Batch le rejette avec une erreur ; si vous appelez directement l’API REST, le code http status est 400 (requête incorrecte).
resourceFiles	ResourceFile[]	Liste des fichiers que le service Batch téléchargera sur le nœud de calcul avant d’exécuter la ligne de commande. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la demande échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Vous pouvez y parvenir à l’aide de fichiers .zip, de packages d’application ou de conteneurs Docker. 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 Task pour la tâche de mise en production du travail sur le nœud de calcul. Passé ce délai, le service Batch peut supprimer le répertoire Task et tout son contenu. La valeur par défaut est 7 jours, c’est-à-dire que le répertoire task est conservé pendant 7 jours, sauf si le nœud de calcul est supprimé ou que 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 programmation.
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 affiché 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 sont terminées, et le système n’acceptera plus de tâches ni d’autres modifications apportées à la tâche.
deleting	string	Un utilisateur a demandé que le travail soit supprimé, mais l’opération de suppression est toujours en cours (par exemple, parce que le système est toujours en cours d’exécution de Tâches).
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 l’opération de désactivation est toujours en cours (par exemple, en attente de l’arrêt des tâches).
enabling	string	Un utilisateur a demandé que le travail soit activé, mais 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 arrêté le travail, mais 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	Durée totale du processeur en mode noyau (additionnée sur tous les cœurs et tous les nœuds de calcul) consommée 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 terminées dans le travail pendant l’intervalle de temps donné. Une tâche se termine 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 sur 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	Durée totale du processeur en mode utilisateur (additionnée sur tous les cœurs et tous les nœuds de calcul) consommée 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 uniquement indiquée dans les statistiques de durée de vie du compte ; il n’est pas inclus dans les statistiques du travail.
wallClockTime	string	Durée totale de l’horloge murale de toutes les tâches du travail. L’heure de l’horloge murale est le temps écoulé entre le début de l’exécution de la tâche sur un nœud de calcul et le moment où elle a terminé (ou jusqu’à la dernière mise à jour des statistiques, si la tâche n’était pas terminée à ce moment-là). Si une tâche a été retentée, cela inclut l’heure de l’horloge murale de toutes les nouvelles tentatives de tâche.
writeIOGiB	number	Quantité totale de données en Gio écrites sur le disque par toutes les tâches du travail.
writeIOps	integer	Nombre total d’opérations d’écriture sur disque effectuées par toutes les tâches du travail.

LinuxUserConfiguration

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

Nom	Type	Description
gid	integer	ID de groupe pour le compte d’utilisateur. 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 choisit le gid.
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 des nœuds de calcul dans un pool Linux lorsque la propriété enableInterNodeCommunication du pool a la valeur true (elle est ignorée si enableInterNodeCommunication est false). Pour ce faire, il place 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 choisit l’uid.

LoginMode

Mode de connexion de l’utilisateur

Nom	Type	Description
batch	string	Mode de connexion Win32 LOGON32_LOGON_BATCH. Le mode de connexion par lots est recommandé pour les processus parallèles de longue durée.
interactive	string	Mode de connexion Win32 LOGON32_LOGON_INTERACTIVE. La UAC est activée sur les pools Windows VirtualMachineConfiguration. Si cette option est utilisée avec une identité d’utilisateur avec élévation de privilèges dans un pool Windows VirtualMachineConfiguration, la session utilisateur n’est pas élevée, sauf si l’application exécutée par la ligne de commande Task est configurée pour toujours exiger des privilèges d’administration ou pour toujours exiger un privilège maximal.

ManagedDisk

Nom	Type	Description
storageAccountType	StorageAccountType	Type de compte de stockage pour le disque managé.

MetadataItem

Paire nom-valeur associée à une ressource de service Batch.

Nom	Type	Description
name	string	Nom de l’élément de métadonnées.
value	string	Valeur de l’élément de métadonnées.

MountConfiguration

Système de fichiers à monter sur chaque nœud.

Nom	Type	Description
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	Conteneur de stockage Azure à monter à l’aide de fuse blob sur chaque nœud. Cette propriété s’exclut mutuellement avec toutes les autres propriétés.
azureFileShareConfiguration	AzureFileShareConfiguration	Partage de fichiers Azure à monter sur chaque nœud. Cette propriété s’exclut 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’exclut mutuellement avec toutes les autres propriétés.
nfsMountConfiguration	NFSMountConfiguration	Système de fichiers NFS à monter sur chaque nœud. Cette propriété s’exclut mutuellement avec toutes les autres propriétés.

NameValuePair

Représente une paire nom-valeur.

Nom	Type	Description
name	string	Nom dans 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) sur une machine virtuelle, ce qui peut améliorer les 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. La configuration du point de terminaison de pool est uniquement prise en charge sur les pools avec la propriété virtualMachineConfiguration.
publicIPAddressConfiguration	PublicIPAddressConfiguration	Configuration IPAddress publique pour les nœuds de calcul dans le pool Batch. La propriété de configuration IP publique est uniquement prise en charge sur les pools avec la propriété virtualMachineConfiguration.
subnetId	string	Identificateur de ressource ARM du sous-réseau de réseau virtuel auquel les nœuds de calcul du pool vont se joindre. Il s’agit de la forme /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Le réseau virtuel doit se trouver dans la même région et 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 libres, le pool alloue partiellement les 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 Access Control (RBAC) pour le réseau virtuel spécifié. Le sous-réseau spécifié doit autoriser la communication à partir du service Azure Batch pour pouvoir 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 vers les nœuds du 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. Pour les pools créés avec virtualMachineConfiguration, seuls les réseaux virtuels ARM (« Microsoft.Network/virtualNetworks ») sont pris en charge, mais pour les pools créés avec cloudServiceConfiguration, les réseaux virtuels ARM et classiques sont pris en charge. Si le réseau virtuel spécifié possède des groupes de sécurité réseau associés, quelques ports système réservés doivent être activés pour les communications entrantes. 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. Pour les pools créés avec une configuration de service cloud, activez les ports 10100, 20100 et 30100. Activez également les connexions sortantes vers stockage Azure sur le port 443. Pour plus d’informations, consultez : https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#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éseau 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 numéro de priorité est faible, plus la priorité de la règle est élevée. Par exemple, les règles peuvent être spécifiées avec des numéros d’ordre de 150, 250 et 350. La règle dont le numéro d’ordre est 150 est prioritaire sur la règle qui a un ordre de 250. Les priorités autorisées sont comprises entre 150 et 4 096. Si des valeurs réservées ou dupliquées sont fournies, la demande échoue avec le code HTTP status 400.
sourceAddressPrefix	string	Préfixe d’adresse source ou balise à mettre en correspondance pour la règle. Les valeurs valides sont une adresse IP unique (par exemple, 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 http status code 400.
sourcePortRanges	string[]	Plages de ports sources à faire correspondre 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 (par exemple, 100 à 200). Les ports doivent être comprises entre 0 et 65535. Chaque entrée de cette collection ne doit pas chevaucher d’autres entrées (une plage ou un port individuel). Si d’autres valeurs sont fournies, la requête échoue avec http status code 400. La valeur par défaut est « ».

NetworkSecurityGroupRuleAccess

Action qui doit être effectuée pour une adresse IP, une plage de sous-réseau ou une balise spécifiée.

Nom	Type	Description
allow	string	Autorise l'accès.
deny	string	Refuse l'accès.

NFSMountConfiguration

Informations utilisées pour se connecter à un système de fichiers NFS.

Nom	Type	Description
mountOptions	string	Options de ligne de commande supplémentaires à passer à la commande mount. Il s’agit des options « net use » dans 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 montages 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 de « BatchNodeManagement . Balise de service {region} et communication TCP sortante sur le port 443 vers « Storage.region » et « BatchNodeManagement ». {region} » étiquettes de service.
default	string	Le mode de communication de nœud est automatiquement défini par le service Batch.
simplified	string	Les nœuds utilisant le mode de communication simplifié nécessitent une communication TCP sortante sur le port 443 vers « BatchNodeManagement . {region} » balise de service. Aucun port d’entrée ouvert n’est requis.

NodePlacementConfiguration

Configuration du placement des nœuds pour un pool.

Nom	Type	Description
policy	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 seront répartis entre différentes zones de disponibilité avec un meilleur équilibrage des efforts.

OnAllTasksComplete

Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont à l’état terminé.

Nom	Type	Description
noaction	string	Ne rien faire. Le travail reste actif, sauf s’il est arrêté ou désactivé par d’autres moyens.
terminatejob	string	Arrêtez le travail. TerminateReason du travail est défini sur « AllTasksComplete ».

OnTaskFailure

Action que le service Batch doit effectuer en cas d’échec d’une tâche dans le travail.

Nom	Type	Description
noaction	string	Ne rien faire. Le travail reste actif, sauf s’il est arrêté ou désactivé par d’autres moyens.
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, 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.

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 est none. 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 de disque initiale 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 de 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 pour le chargement de fichiers à partir d’un nœud de calcul Azure Batch vers un autre emplacement une fois que le service Batch a terminé l’exécution du processus Task.

Nom	Type	Description
destination	OutputFileDestination	Destination du ou des fichiers de sortie.
filePattern	string	Modèle indiquant le ou les fichiers à charger. Les chemins d’accès relatifs et absolus sont pris en charge. Les chemins d’accès relatifs sont relatifs au répertoire de travail Task. Les caractères génériques suivants sont pris en charge : * correspond à 0 ou plusieurs caractères (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 dans 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, sauf 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 correspondra pas à .a.gif, mais.gif le fera). Exemple simple : ***.txt correspond à n’importe quel fichier qui ne commence pas par « . » 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é dans une séquence d’échappement entre crochets (par exemple, abc[] correspond à un fichier nommé abc). Notez que \ et / sont tous deux 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 dans 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 à Stockage Blob Azure spécifiée 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 de l’objet blob (qui est ajouté à chaque nom d’objet blob) dans lequel 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 de paires nom-valeur pour les en-têtes à utiliser dans le chargement des fichiers de sortie Ces en-têtes seront 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/en-us/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 le stockage Blob Azure vers lequel les fichiers sont chargés.

OutputFileUploadCondition

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

Nom	Type	Description
taskcompletion	string	Chargez le ou les fichiers une fois le processus de tâche terminé, quel que soit le code de sortie.
taskfailure	string	Chargez le ou les fichiers uniquement après la fin du processus Task avec un code de sortie différent de zéro.
tasksuccess	string	Chargez le ou les fichiers uniquement après la fin du processus Task avec un code de sortie 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 doit être chargé. 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 HTTP status 400. Cela ne peut pas être spécifié si l’adresse 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 (création et, sauf si keepAlive est spécifié, suppression) du pool automatique. Toutes les actions de l’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 de 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 pour le travail n’est exécutée 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 Tasks tant que le pool n’existe pas. Vous devez spécifier l’ID de pool ou la spécification du pool automatique, mais pas les deux.

PoolLifetimeOption

La durée de vie minimale des pools automatiques créés et la façon dont plusieurs travaux planifiés sont attribués aux pools.

Nom	Type	Description
job	string	Le pool existe pendant toute la durée de vie du travail auquel il est dédié. Le service Batch crée le pool lorsqu’il crée le travail. Si l’option « job » est appliquée à une planification de travail, le service Batch crée un pool automatique pour chaque travail créé dans le calendrier.
jobschedule	string	Le pool existe pendant la durée de vie de la planification du travail. Le service Batch crée le pool lorsqu’il crée le premier travail selon la planification. Vous pouvez appliquer cette option uniquement aux planifications de travaux, et non aux travaux.

PoolSpecification

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

Nom	Type	Description
applicationLicenses	string[]	Liste des licences d’application que le service Batch mettra à disposition sur chaque nœud de calcul du pool. La liste des licences d’application doit être un sous-ensemble des licences d’application de service Batch disponibles. Si une licence qui n’est pas prise en charge est demandée, la création du pool échoue. Les licences autorisées disponibles sur le pool sont « maya », « vray », « 3dsmax », « arnold ». Des frais supplémentaires s’appliquent pour chaque licence d’application ajoutée au pool.
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 n’ont pas été redémarrés ou réimagenés. 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 15 minutes. Les valeurs minimale et maximale sont respectivement de 5 minutes et de 168 heures. 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 http status est 400 (requête incorrecte).
autoScaleFormula	string	Formule du 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 validité de la formule est vérifiée 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 la tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour interroger cet emplacement. Pour les certificats avec la visibilité de « remoteUser », un répertoire « certs » est créé dans le répertoire de base 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 .
cloudServiceConfiguration	CloudServiceConfiguration	Configuration du service cloud pour le pool. Cette propriété doit être spécifiée si le pool doit être créé avec des machines virtuelles PaaS Azure. Cette propriété et virtualMachineConfiguration s’excluent mutuellement et l’une des propriétés doit être spécifiée. Si aucun des deux n’est spécifié, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code http status est 400 (requête incorrecte). Cette propriété ne peut pas être spécifiée si le compte Batch a été créé avec sa propriété poolAllocationMode définie sur « UserSubscription ».
displayName	string	Nom complet du pool. Le nom d’affichage n’a pas besoin d’être unique et peut contenir des caractères Unicode d’une longueur maximale de 1 024.
enableAutoScale	boolean	Indique si la taille du pool doit s’ajuster automatiquement au fil du temps. Si la valeur est false, au moins un des targetDedicatedNodes et targetLowPriorityNodes doit être spécifié. 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 des restrictions de déploiement sur les nœuds de calcul du pool. Il se peut que le pool n’atteigne pas la taille souhaitée. La valeur par défaut est false.
metadata	MetadataItem[]	Liste de paires nom-valeur associées au pool en tant que métadonnées. Le service Batch n’attribue 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 les Azure Files, NFS, CIFS/SMB et Blobfuse.
networkConfiguration	NetworkConfiguration	Configuration réseau pour le pool. Configuration réseau d’un pool.
resizeTimeout	string	Délai d’attente 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 lorsque enableAutoScale est défini sur true. La valeur par défaut est 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 http status 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 de Azure Batch. Lorsqu’elles sont spécifiées, ces balises sont propagées aux ressources Azure 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 à mesure qu’il 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 effectue une nouvelle tentative de 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 (sans s’y limiter) lorsqu’un nœud défectueux 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 dues aux opérations de récupération sont indépendantes de et ne sont pas comptabilisées dans maxTaskRetryCount. Même si maxTaskRetryCount est 0, une nouvelle tentative interne en raison d’une opération de récupération peut se produire. Pour cette raison, 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 de longue durée consiste à utiliser une forme de point de contrôle. Dans certains cas, starttask peut être réexécuté même si le nœud de calcul n’a pas été redémarré. Une attention particulière doit être prise pour éviter les StartTasks qui créent un processus d’interruption ou qui installent/lancent des services à partir du répertoire de travail StartTask, car cela empêchera Batch de pouvoir réexécuter le 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. En cas d’omission, la valeur par défaut est Default.
taskSchedulingPolicy	TaskSchedulingPolicy	Comment les tâches sont distribuées entre les nœuds de calcul dans un pool. Si elle n’est pas spécifiée, la valeur par défaut est répartie.
taskSlotsPerNode	integer	Nombre d’emplacements de tâche utilisables pour exécuter des tâches simultanées sur un nœud de calcul unique au sein du pool. La valeur par défaut est 1. La valeur maximale est la plus petite de 4 fois le nombre de cœurs du vmSize du pool ou 256.
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 si le pool doit être créé avec des machines virtuelles IaaS Azure. Cette propriété et cloudServiceConfiguration s’excluent mutuellement et l’une des propriétés doit être spécifiée. Si aucun des deux n’est spécifié, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code http status est 400 (requête incorrecte).
vmSize	string	Taille des machines virtuelles dans le pool. Toutes les machines virtuelles d’un pool ont la même taille. Pour plus d’informations sur les tailles disponibles des 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 de l’adresse IP publique de la configuration réseau d’un pool.

Nom	Type	Description
ipAddressIds	string[]	Liste des adresses IP publiques que le service Batch utilisera lors de l’approvisionnement des nœuds de calcul. 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

Fichier unique ou plusieurs fichiers à télécharger sur un nœud de calcul.

Nom	Type	Description
autoStorageContainerName	string	Nom du conteneur de stockage dans le compte de stockage automatique. 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 le nom commence par le préfixe spécifié sont téléchargés. La propriété est valide uniquement quand 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 les nœuds de calcul Linux. Il sera ignoré s’il est spécifié 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, une valeur par défaut de 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 obligatoire et décrit le chemin d’accès 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 est conservée intégralement 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 des nœuds de calcul. Il existe trois façons d’obtenir une telle URL pour un objet blob dans le stockage Azure : inclure une signature d’accès partagé (SAP) accordant des autorisations de lecture sur l’objet blob, utiliser une identité managée avec une autorisation de lecture ou définir 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 à Stockage Blob Azure spécifiée 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.

SecurityProfile

Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le groupe de machines virtuelles identiques.

Nom	Type	Description
encryptionAtHost	boolean	Cette propriété peut être utilisée par l’utilisateur dans la demande pour activer ou désactiver le chiffrement 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 de ressource/temporaire sur l’hôte lui-même.
securityType	SecurityTypes	Spécifie le SecurityType de la machine virtuelle. Elle doit être définie 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
trustedLaunch	string	Le lancement fiable protège contre les techniques d’attaque avancées et persistantes.

ServiceArtifactReference

Spécifie l’ID de référence d’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la dernière version de l’image.

Nom	Type	Description
id	string	ID de référence d’artefact de service de ServiceArtifactReference ID de référence d’artefact de service sous la forme /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 l’objet 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’expansion des variables 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 (relatif au répertoire de travail De la tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/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 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 dans le conteneur et la ligne de commande Tâche 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 fichiers 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 est 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 fois, puis peut réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est de 3, Batch tente la tâche jusqu’à 4 fois (une tentative initiale et 3 tentatives). Si le nombre maximal de nouvelles tentatives est 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. Toutefois, 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échargera sur le nœud de calcul avant d’exécuter la ligne de commande. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la demande échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Vous pouvez y parvenir à l’aide de fichiers .zip, de packages d’application ou de conteneurs Docker. 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 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 que starttask se termine. Dans ce cas, d’autres tâches peuvent commencer à s’exécuter sur le nœud de calcul pendant que starttask est toujours en cours d’exécution ; et même si starttask échoue, de nouvelles tâches continueront d’être planifiées sur le nœud de calcul. La valeur par défaut est true.

StorageAccountType

Type de compte de stockage à utiliser dans la création de disques de données ou de disque de système d’exploitation.

Nom	Type	Description
premium_lrs	string	Le disque de données/le disque du système d’exploitation doit utiliser un stockage localement redondant Premium.
standard_lrs	string	Le disque de données/disque de système d’exploitation doit utiliser un stockage localement redondant standard.
standardssd_lrs	string	Le disque de données/disque de système d’exploitation doit utiliser un stockage SSD standard localement redondant.

TaskConstraints

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

Nom	Type	Description
maxTaskRetryCount	integer	Nombre maximal de nouvelles tentatives de la tâche. Le service Batch retente une tâche si son code de sortie est différent de zéro. Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives pour l’exécutable De la tâche en raison d’un code de sortie différent de zéro. Le service Batch essaiera la tâche une fois, puis peut réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est de 3, Batch tente la tâche jusqu’à 4 fois (une tentative initiale et 3 tentatives). Si le nombre maximal de nouvelles tentatives est 0, le service Batch ne retentera 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. Toutefois, 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 d’exécution de la tâche, mesurée à partir du moment où la tâche démarre. Si la tâche ne se termine pas dans le délai imparti, le service Batch l’arrête. Si ce n’est pas spécifié, la durée d’exécution de la tâche n’est pas limitée.
retentionTime	string	Durée minimale pour conserver le répertoire Task sur le nœud de calcul où il s’est exécuté, à partir du moment où il termine l’exécution. Passé ce délai, le service Batch peut supprimer le répertoire Task et tout son contenu. La valeur par défaut est 7 jours, c’est-à-dire que le répertoire task est conservé pendant 7 jours, sauf si le nœud de calcul est supprimé ou que le travail est supprimé.

TaskContainerSettings

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

Nom	Type	Description
containerRunOptions	string	Options supplémentaires pour la commande de création de conteneur. 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 le spécifie « 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 si a déjà été fourni lors de la création du pool.
workingDirectory	ContainerWorkingDirectory	Emplacement du répertoire de travail de la tâche du 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 dans un pool. Si elle n’est pas spécifiée, 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.

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 est nonAdmin.
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 des caractères Unicode d’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é d’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 basé sur l’infrastructure Azure Machines Virtuelles.

Nom	Type	Description
containerConfiguration	ContainerConfiguration	Configuration du conteneur pour le pool. Si cette option est spécifiée, l’installation est effectuée sur chaque nœud de calcul du pool pour permettre à Tasks de s’exécuter dans des conteneurs. Toutes les tâches régulières et les tâches du gestionnaire de tâches exécutées 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 dans le 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 à eux. Il 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 qui lui sont associées sont également supprimés. Le disque n’est pas mis en forme après avoir été attaché. Il doit être mis en forme avant utilisation . Pour plus d’informations, consultez https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux et https://docs.microsoft.com/en-us/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. S’il est spécifié, le chiffrement est effectué sur chaque nœud du pool lors de l’approvisionnement des nœuds.
extensions	VMExtension[]	Extension de machine virtuelle pour le pool. Si elles sont spécifiées, 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é Azure Machines Virtuelles ou à l’image de machine virtuelle personnalisée à utiliser.
licenseType	string	Type de licence locale à utiliser lors du déploiement du système d’exploitation. Cela s’applique uniquement aux images qui contiennent le système d’exploitation Windows et ne doit être utilisé que lorsque vous détenez 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 pour Windows Server. Windows_Client : la licence locale est pour le client Windows.
nodeAgentSKUId	string	Référence SKU de l’agent de nœud de calcul Batch à provisionner sur les nœuds de calcul dans le pool. L’agent de nœud de calcul Batch 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 de nœud de calcul qui correspond à la référence d’image sélectionnée. Pour obtenir la liste des références SKU d’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 du nœud pour le pool. Cette configuration spécifie des règles sur la façon dont les nœuds du pool seront physiquement alloués.
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é pour la machine virtuelle ou le groupe de machines virtuelles identiques. Spécifie les paramètres de profil de sécurité pour la machine virtuelle ou le groupe de machines virtuelles identiques.
serviceArtifactReference	ServiceArtifactReference	Spécifie l’ID de référence d’artefact de service utilisé pour définir la même version d’image pour toutes les machines virtuelles du groupe identique lors de l’utilisation de la dernière version de l’image. ID de référence d’artefact de service sous la forme /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.

VMExtension

Configuration des extensions de machine virtuelle.

Nom	Type	Description
autoUpgradeMinorVersion	boolean	Indique si l’extension doit utiliser une version mineure plus récente si une version est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur true.
enableAutomaticUpgrade	boolean	Indique si l’extension doit être automatiquement mise à niveau par la plateforme si une version plus récente de l’extension est disponible.
name	string	Nom de l’extension de machine virtuelle.
protectedSettings	object	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé.
provisionAfterExtensions	string[]	Collection de noms d’extension. Collection de noms d’extension après lesquels cette extension doit être provisionnée.
publisher	string	Nom de l’éditeur du gestionnaire d’extensions.
settings	object	Paramètres publics au format JSON pour l’extension.
type	string	Type de l’extension.
typeHandlerVersion	string	Version du gestionnaire de script.

WindowsConfiguration

Paramètres du système d’exploitation Windows à appliquer à la machine virtuelle.

Nom	Type	Description
enableAutomaticUpdates	boolean	Indique si les mises à jour automatiques sont activées sur la machine virtuelle. 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 des pools VirtualMachineConfiguration est « batch » et pour les pools CloudServiceConfiguration est « interactive ».