Pool - Update Properties

Service:

Batch Service

Version d'API:

2024-07-01.20.0

Met à jour les propriétés du pool spécifié.
Cela remplace entièrement toutes les propriétés pouvant être mises à jour du pool. Par exemple, si le pool a un StartTask associé à celui-ci et si StartTask n’est pas spécifié avec cette requête, le service Batch supprime l’objet StartTask existant.

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0

Avec des paramètres facultatifs:

POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
poolId	path	True	string	ID du pool à mettre à jour.
api-version	query	True	string	Version de l’API cliente.
timeout	query		integer int32	Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, la valeur par défaut est utilisée à la place.

En-tête de la demande

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

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

Corps de la demande

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

Nom	Obligatoire	Type	Description
applicationPackageReferences	True	ApplicationPackageReference[]	Liste des packages d’application à installer sur chaque nœud de calcul du pool. La liste remplace toutes les références de package d’application existantes sur le pool. Les modifications apportées aux références de package d’application affectent tous les nouveaux nœuds de calcul qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réimages. Il existe au maximum 10 références de package d’application sur un pool donné. En cas d’omission ou si vous spécifiez une collection vide, toutes les références de packages d’application existantes sont supprimées du pool. Un maximum de 10 références peut être spécifié sur un pool donné.
certificateReferences	True	CertificateReference[]	Liste des certificats à installer sur chaque nœud de calcul du pool. Cette liste remplace toutes les références de certificat existantes configurées sur le pool. Si vous spécifiez une collection vide, toutes les références de certificat existantes sont supprimées du pool. Pour les nœuds Windows, le service Batch installe les certificats dans le magasin de certificats et l’emplacement spécifiés. Pour les nœuds de calcul Linux, les certificats sont stockés dans un répertoire à l’intérieur du répertoire de travail de tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour interroger cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certificats » est créé dans le répertoire d’accueil de l’utilisateur (par exemple, /home/{user-name}/certs) et les certificats sont placés dans ce répertoire. Avertissement : cette propriété est déconseillée et sera supprimée après février 2024. Utilisez plutôt l''extension Azure KeyVault.
metadata	True	MetadataItem[]	Liste des paires nom-valeur associées au pool en tant que métadonnées. Cette liste remplace toutes les métadonnées existantes configurées sur le pool. S’il est omis ou si vous spécifiez une collection vide, toutes les métadonnées existantes sont supprimées du pool.
startTask		StartTask	Tâche à exécuter sur chaque nœud de calcul au fur et à mesure qu’elle rejoint le pool. La tâche s’exécute lorsque le nœud de calcul est ajouté au pool ou lorsque le nœud de calcul est redémarré. Si cet élément est présent, il remplace n’importe quel StartTask existant. S’il n’est pas omis, tout StartTask existant est supprimé du pool.
targetNodeCommunicationMode		NodeCommunicationMode	Mode de communication de nœud souhaité pour le pool. Ce paramètre remplace tout paramètre targetNodeCommunication existant sur le pool. S’il est omis, le paramètre existant est par défaut.

Réponses

Nom	Type	Description
204 No Content		La demande adressée au service Batch a réussi. En-têtes client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Erreur du service Batch.

Sécurité

azure_auth

Flux de code d’authentification Microsoft Entra OAuth 2.0

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Authorization

Type: apiKey
Dans: header

Exemples

Pool update

Exemple de requête

HTTP

POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

Exemple de réponse

Code d’état:

204

Définitions

Nom	Description
ApplicationPackageReference	Référence à un package à déployer sur des nœuds de calcul.
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.
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.
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.
ComputeNodeIdentityReference	Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
ContainerHostBatchBindMountEntry	Entrée du chemin d’accès et du mode montage que vous souhaitez monter dans le conteneur de tâches.
ContainerHostDataPath	Chemins d’accès qui seront montés sur le conteneur de la tâche de conteneur.
ContainerRegistry	Registre de conteneurs privé.
ContainerWorkingDirectory	Emplacement du répertoire de travail de tâche de conteneur.
ElevationLevel	Niveau d’élévation de l’utilisateur.
EnvironmentSetting	Variable d’environnement à définir sur un processus de tâche.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
MetadataItem	Paire nom-valeur associée à une ressource de service Batch.
NodeCommunicationMode	Détermine comment un pool communique avec le service Batch.
PoolUpdatePropertiesParameter	Ensemble de modifications à apporter à un pool.
ResourceFile	Un seul fichier ou plusieurs fichiers à télécharger sur un nœud de calcul.
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é.
TaskContainerSettings	Paramètres de conteneur d’une tâche.
UserIdentity	Définition de l’identité de l’utilisateur sous laquelle la tâche est exécutée.

ApplicationPackageReference

Référence à un package à déployer sur des nœuds de calcul.

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

AutoUserScope

Étendue de l’utilisateur automatique

Nom	Type	Description
pool	string	Spécifie que la tâche s’exécute en tant que compte d’utilisateur automatique commun créé sur chaque nœud de calcul d’un pool.
task	string	Spécifie que le service doit créer un utilisateur pour la tâche.

AutoUserSpecification

Spécifie les paramètres de l’utilisateur automatique qui exécute une tâche sur le service Batch.

Nom	Type	Description
elevationLevel	ElevationLevel	Niveau d’élévation de l’utilisateur automatique. La valeur par défaut n’est pasAdmin.
scope	AutoUserScope	Étendue de l’utilisateur automatique La valeur par défaut est pool. Si le pool exécute Windows, une valeur de tâche doit être spécifiée si une isolation plus stricte entre les tâches est requise. Par exemple, si la tâche mute le Registre d’une manière qui peut avoir un impact sur d’autres tâches, ou si des certificats ont été spécifiés sur le pool qui ne doit pas être accessible par les tâches normales, mais qu’il doit être accessible par StartTasks.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
message	ErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

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

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

CertificateReference

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

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

CertificateStoreLocation

Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat.

Nom	Type	Description
currentuser	string	Les certificats doivent être installés dans le magasin de certificats CurrentUser.
localmachine	string	Les certificats doivent être installés dans le magasin de certificats LocalMachine.

CertificateVisibility

Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat.

Nom	Type	Description
remoteuser	string	Le certificat doit être visible pour les comptes d’utilisateur sous lesquels les utilisateurs accèdent à distance au nœud de calcul.
starttask	string	Le certificat doit être visible pour le compte d’utilisateur sous lequel StartTask est exécuté. Notez que si l’étendue de l’utilisateur automatique est pool pour startTask et une tâche, ce certificat sera également visible pour la tâche.
task	string	Le certificat doit être visible pour les comptes d’utilisateur sous lesquels les tâches de travail sont exécutées.

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.

ContainerHostBatchBindMountEntry

Entrée du chemin d’accès et du mode montage que vous souhaitez monter dans le conteneur de tâches.

Nom	Type	Description
isReadOnly	boolean	Montez ce chemin source en mode lecture seule ou non. La valeur par défaut est false (mode lecture/écriture). Pour Linux, si vous montez ce chemin en mode lecture/écriture, cela ne signifie pas que tous les utilisateurs du conteneur disposent de l’accès en lecture/écriture pour le chemin d’accès, cela dépend de l’accès dans la machine virtuelle hôte. Si ce chemin d’accès est monté en lecture seule, tous les utilisateurs du conteneur ne pourront pas modifier le chemin d’accès.
source	ContainerHostDataPath	Le chemin d’accès à monter sur le client conteneur peut être sélectionné.

ContainerHostDataPath

Chemins d’accès qui seront montés sur le conteneur de la tâche de conteneur.

Nom	Type	Description
Applications	string	Chemin d’accès des applications.
JobPrep	string	Chemin de la tâche de préparation du travail.
Shared	string	Chemin d’accès de la tâche multi-instances pour partager leurs fichiers.
Startup	string	Chemin d’accès de la tâche de démarrage.
Task	string	Chemin d’accès de la tâche.
VfsMounts	string	Le chemin d’accès contient tous les systèmes de fichiers virtuels sont montés sur ce nœud.

ContainerRegistry

Registre de conteneurs privé.

Nom	Type	Description
identityReference	ComputeNodeIdentityReference	Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à azure Container Registry au lieu du nom d’utilisateur et du mot de passe. Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
password	string	Mot de passe pour vous connecter au serveur de Registre.
registryServer	string	URL du Registre. S’il est omis, la valeur par défaut est « docker.io ».
username	string	Nom d’utilisateur à connecter au serveur de Registre.

ContainerWorkingDirectory

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

Nom	Type	Description
containerImageDefault	string	Utilisez le répertoire de travail défini dans l’image conteneur. Veillez à ce que ce répertoire ne contienne pas les fichiers de ressources téléchargés par Batch.
taskWorkingDirectory	string	Utilisez le répertoire de travail de tâche du service Batch standard, qui contiendra les fichiers de ressources de tâche renseignés par Batch.

ElevationLevel

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

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

EnvironmentSetting

Variable d’environnement à définir sur un processus de tâche.

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

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.

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.

NodeCommunicationMode

Détermine comment un pool communique avec le service Batch.

Nom	Type	Description
classic	string	Les nœuds utilisant le mode de communication classique nécessitent une communication TCP entrante sur les ports 29876 et 29877 à partir du « BatchNodeManagement ». Balise de service {region} » et communication TCP sortante sur le port 443 vers « Storage.region » et « BatchNodeManagement ». Balises de service {region}".
default	string	Le mode de communication de nœud est automatiquement défini par le service Batch.
simplified	string	Les nœuds utilisant le mode de communication simplifié nécessitent une communication TCP sortante sur le port 443 vers le « BatchNodeManagement ». Balise de service {region}". Aucun port entrant ouvert n’est requis.

PoolUpdatePropertiesParameter

Ensemble de modifications à apporter à un pool.

Nom	Type	Description
applicationPackageReferences	ApplicationPackageReference[]	Liste des packages d’application à installer sur chaque nœud de calcul du pool. La liste remplace toutes les références de package d’application existantes sur le pool. Les modifications apportées aux références de package d’application affectent tous les nouveaux nœuds de calcul qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réimages. Il existe au maximum 10 références de package d’application sur un pool donné. En cas d’omission ou si vous spécifiez une collection vide, toutes les références de packages d’application existantes sont supprimées du pool. Un maximum de 10 références peut être spécifié sur un pool donné.
certificateReferences	CertificateReference[]	Liste des certificats à installer sur chaque nœud de calcul du pool. Cette liste remplace toutes les références de certificat existantes configurées sur le pool. Si vous spécifiez une collection vide, toutes les références de certificat existantes sont supprimées du pool. Pour les nœuds Windows, le service Batch installe les certificats dans le magasin de certificats et l’emplacement spécifiés. Pour les nœuds de calcul Linux, les certificats sont stockés dans un répertoire à l’intérieur du répertoire de travail de tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour interroger cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certificats » est créé dans le répertoire d’accueil de l’utilisateur (par exemple, /home/{user-name}/certs) et les certificats sont placés dans ce répertoire. Avertissement : cette propriété est déconseillée et sera supprimée après février 2024. Utilisez plutôt l''extension Azure KeyVault.
metadata	MetadataItem[]	Liste des paires nom-valeur associées au pool en tant que métadonnées. Cette liste remplace toutes les métadonnées existantes configurées sur le pool. S’il est omis ou si vous spécifiez une collection vide, toutes les métadonnées existantes sont supprimées du pool.
startTask	StartTask	Tâche à exécuter sur chaque nœud de calcul au fur et à mesure qu’elle rejoint le pool. La tâche s’exécute lorsque le nœud de calcul est ajouté au pool ou lorsque le nœud de calcul est redémarré. Si cet élément est présent, il remplace n’importe quel StartTask existant. S’il n’est pas omis, tout StartTask existant est supprimé du pool.
targetNodeCommunicationMode	NodeCommunicationMode	Mode de communication de nœud souhaité pour le pool. Ce paramètre remplace tout paramètre targetNodeCommunication existant sur le pool. S’il est omis, le paramètre existant est par défaut.

ResourceFile

Un seul fichier ou plusieurs fichiers à télécharger sur un nœud de calcul.

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

StartTask

Tâche exécutée lorsqu’un nœud joint un pool dans le service Azure Batch, ou lorsque le nœud de calcul est redémarré ou réinitialisé.

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

TaskContainerSettings

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

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

UserIdentity

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

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