az batch pool

Remarque

Ce groupe de commandes a des commandes définies dans Azure CLI et au moins une extension. Installez chaque extension pour bénéficier de ses fonctionnalités étendues. En savoir plus sur les extensions.

Gérer les pools Batch.

Commandes

Nom Description Type Statut
az batch pool autoscale

Gérer la mise à l’échelle automatique des pools Batch.

Core GA
az batch pool autoscale disable

Désactive la mise à l’échelle automatique d’un pool.

Core GA
az batch pool autoscale enable

Active la mise à l’échelle automatique pour un pool.

Core GA
az batch pool autoscale evaluate

Obtient le résultat de l’évaluation d’une formule de mise à l’échelle automatique sur le pool.

Core GA
az batch pool create

Créez un pool Batch dans un compte. Lors de la création d’un pool, choisissez des arguments dans Services cloud Configuration ou Configuration de machine virtuelle.

Core GA
az batch pool create (azure-batch-cli-extensions extension)

Créez un pool Batch dans un compte. Lors de la création d’un pool, choisissez des arguments dans Services cloud Configuration ou Configuration de machine virtuelle.

Extension GA
az batch pool delete

Supprime un pool du compte spécifié.

Core GA
az batch pool list

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

Core GA
az batch pool node-counts

Obtenez les nombres de nœuds pour les pools Batch.

Core GA
az batch pool node-counts list

Obtient le nombre de nœuds de calcul dans chaque état, regroupés par pool.

Core GA
az batch pool reset

Mettez à jour les propriétés d’un pool Batch. Les propriétés non spécifiées qui peuvent être mises à jour sont réinitialisées à leurs valeurs par défaut.

Core GA
az batch pool resize

Redimensionnez ou arrêtez le redimensionnement d’un pool Batch.

Core GA
az batch pool set

Mettez à jour les propriétés d’un pool Batch. La mise à jour d’une propriété dans un sous-groupe réinitialise les propriétés non spécifiées de ce groupe.

Core GA
az batch pool show

Obtient des informations sur le pool spécifié.

Core GA
az batch pool supported-images

Interroger des informations sur les images de machine virtuelle prises en charge par le service Azure Batch.

Core GA
az batch pool supported-images list

Répertorie toutes les images de machine virtuelle prises en charge par le service Azure Batch.

Core GA
az batch pool usage-metrics

Affichez les métriques d’utilisation des pools Batch.

Core GA
az batch pool usage-metrics list

Répertorie les métriques d’utilisation, agrégées par pool à intervalles de temps individuels, pour le compte spécifié.

Core GA

az batch pool create

Créez un pool Batch dans un compte. Lors de la création d’un pool, choisissez des arguments dans Services cloud Configuration ou Configuration de machine virtuelle.

az batch pool create [--accelerated-networking {false, true}]
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--application-licenses]
                     [--application-package-references]
                     [--auto-scale-formula]
                     [--certificate-references]
                     [--defer-os-rolling-upgrade {false, true}]
                     [--disable-auto-rollback {false, true}]
                     [--disk-encryption-targets]
                     [--enable-auto-os-upgrade {false, true}]
                     [--enable-cross-zone-upgrade {false, true}]
                     [--enable-inter-node-communication]
                     [--enable-secure-boot {false, true}]
                     [--enable-vtpm {false, true}]
                     [--enable-write-accel {false, true}]
                     [--encryption-at-host {false, true}]
                     [--id]
                     [--image]
                     [--json-file]
                     [--max-batch-instance-percent]
                     [--max-unhealthy-instance-percent]
                     [--max-unhealthy-upgraded-instance-percent]
                     [--metadata]
                     [--node-agent-sku-id]
                     [--os-disk-caching {none, readonly, readwrite}]
                     [--os-disk-size]
                     [--os-family {2, 3, 4, 5, 6}]
                     [--os-version]
                     [--pause-time-between-batches]
                     [--placement {cachedisk}]
                     [--policy {regional, zonal}]
                     [--prioritize-unhealthy-instances {false, true}]
                     [--resize-timeout]
                     [--resource-tags]
                     [--rollback-failed-instances-on-policy-breach {false, true}]
                     [--security-type]
                     [--start-task-command-line]
                     [--start-task-resource-files]
                     [--start-task-wait-for-success]
                     [--storage-account-type {premium_lrs, standard_lrs, standardssd_lrs}]
                     [--target-communication {classic, default, simplified}]
                     [--target-dedicated-nodes]
                     [--target-low-priority-nodes]
                     [--targets]
                     [--task-slots-per-node]
                     [--upgrade-policy-mode {automatic, manual, rolling}]
                     [--use-rolling-upgrade-policy {false, true}]
                     [--vm-size]

Paramètres facultatifs

--accelerated-networking

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 entraîner une amélioration des performances réseau. Pour plus d’informations, consultez : https://learn.microsoft.com/azure/virtual- network/accelerated-networking-overview. Définissez true pour activer.

valeurs acceptées: false, true
--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--application-licenses

La liste des licences d’application doit être un sous-ensemble de licences d’application de service Batch disponibles. Si une licence n’est pas prise en charge, la création du pool échoue. Valeurs séparées par l’espace.

--application-package-references

Lors de la création d’un pool, l’ID d’application du package doit être complet (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Les modifications apportées aux références de package affectent tous les nouveaux nœuds qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réinitialisé. Il existe un maximum de 10 références de package sur un pool donné. ID d’application séparés par espace avec version facultative au format « id[#version] ».

--auto-scale-formula

Formule pour le nombre souhaité de nœuds de calcul dans le pool. La formule est case activée pour la validité avant la création du pool. Si la formule n’est pas valide, le service Batch rejette la demande avec des informations d’erreur détaillées. Pour plus d’informations sur la spécification de cette formule, consultez https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/.

--certificate-references

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. Empreintes de certificat séparées par l’espace.

--defer-os-rolling-upgrade

Différer les mises à niveau du système d’exploitation sur les machines virtuelles si elles exécutent des tâches. True si l’indicateur est présent.

valeurs acceptées: false, true
--disable-auto-rollback

Indique si la fonctionnalité de restauration d’image du système d’exploitation doit être désactivée. True si l’indicateur est présent.

valeurs acceptées: false, true
--disk-encryption-targets

Liste séparée par un espace de DiskEncryptionTargets. les valeurs possibles actuelles incluent OsDisk et TemporaryDisk.

--enable-auto-os-upgrade

Indique si les mises à niveau du système d’exploitation doivent être appliquées automatiquement aux instances de groupe identique de manière propagée lorsqu’une version plus récente de l’image du système d’exploitation devient disponible.

Si cette valeur est définie sur true pour les pools Windows, WindowsConfiguration.enableAutomatic Mises à jour ne peut pas être définie sur true. True si l’indicateur est présent.

valeurs acceptées: false, true
--enable-cross-zone-upgrade

Autorisez VMSS à ignorer les limites AZ lors de la construction de lots de mise à niveau. Prenez en compte le domaine de mise à jour et maxBatchInstancePercent pour déterminer la taille du lot. Ce champ peut être défini sur true ou false uniquement lors de l’utilisation de NodePlacementConfiguration comme Zonal. True si l’indicateur est présent.

valeurs acceptées: false, true
--enable-inter-node-communication

Indique si le pool autorise la communication directe entre les nœuds de calcul. L’activation de la communication entre nœuds limite la taille maximale du pool en raison de restrictions de déploiement sur les nœuds de calcul du pool. Cela peut entraîner le fait que le pool n’atteigne pas sa taille souhaitée. La valeur par défaut est false (Faux). True si l’indicateur est présent.

--enable-secure-boot

Activez le démarrage sécurisé.

valeurs acceptées: false, true
--enable-vtpm

Activez vTPM.

valeurs acceptées: false, true
--enable-write-accel

Spécifiez si writeAccelerator doit être activé ou désactivé sur le disque.

valeurs acceptées: false, true
--encryption-at-host

Cette propriété peut être utilisée par l’utilisateur dans la demande pour activer ou désactiver le chiffrement de l’hôte pour la machine virtuelle ou le groupe de machines virtuelles identiques. Cela active le chiffrement pour tous les disques, y compris le disque Resource/Temp sur l’hôte lui-même. Le comportement par défaut est : Le chiffrement sur l’hôte est désactivé, sauf si cette propriété a la valeur true pour la ressource.

valeurs acceptées: false, true
--id

Obligatoire. 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. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID de pool au sein d’un compte qui diffèrent uniquement par cas).

--image

Référence d’image du système d’exploitation. Il peut s’agir du format « publisher :offer :sku[ :version] » ou d’un ID d’image ARM complet du formulaire « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} ». Si le format « publisher :offer :sku[ :version] » est facultatif et s’il est omis le plus récent sera utilisé. Les valeurs valides peuvent être récupérées via « az batch pool supported-images list ». Par exemple : « MicrosoftWindowsServer :WindowsServer :2012-R2-Datacenter :latest ».

--json-file

Le fichier contenant le pool crée une spécification de paramètre de propriétés dans JSON(mis en forme pour correspondre au corps de la demande de l’API REST). Si ce paramètre est spécifié, tous les arguments de paramètre de création de propriétés du pool sont ignorés. Consultez l’article https://docs.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#request-body.

--max-batch-instance-percent

Pourcentage maximal d’instances de machines virtuelles totales qui seront mises à niveau simultanément par la mise à niveau propagée dans un lot. Comme il s’agit d’un nombre maximal d’instances non saines dans les lots précédents ou futurs, le pourcentage d’instances d’un lot peut diminuer pour garantir une fiabilité plus élevée. La valeur de ce champ doit être comprise entre 5 et 100, inclus. Si maxBatchInstancePercent et maxUnhealthyInstancePercent sont attribués avec la valeur, la valeur de maxBatchInstancePercent ne doit pas être supérieure à maxUnhealthyInstancePercent.

--max-unhealthy-instance-percent

Pourcentage maximal des instances de machine virtuelle totales dans le groupe identique qui peuvent être simultanément non saines, soit en raison d’une mise à niveau, soit en étant trouvée dans un état non sain par l’intégrité de la machine virtuelle case activée s avant l’abandon de la mise à niveau propagée. Cette contrainte est case activée avant de démarrer n’importe quel lot. La valeur de ce champ doit être comprise entre 5 et 100, inclus. Si maxBatchInstancePercent et maxUnhealthyInstancePercent sont attribués avec la valeur, la valeur de maxBatchInstancePercent ne doit pas être supérieure à maxUnhealthyInstancePercent.

--max-unhealthy-upgraded-instance-percent

Pourcentage maximal d’instances de machine virtuelle mises à niveau qui peuvent être trouvées dans un état non sain. Cette case activée se produit après la mise à niveau de chaque lot. Si ce pourcentage est jamais dépassé, la mise à jour propagée abandonne. La valeur de ce champ doit être comprise entre 0 et 100, inclus.

--metadata

Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur. Valeurs séparées par l’espace au format « key=value ».

--node-agent-sku-id

Obligatoire. L’agent Batch Compute Node est un programme qui s’exécute sur chaque nœud de calcul du pool et fournit l’interface de commande et de contrôle entre le nœud de calcul et le service Batch. Il existe différentes implémentations de l’agent de nœud de calcul, appelées références SKU, pour différents systèmes d’exploitation. Vous devez spécifier une référence SKU de l’agent Compute Node qui correspond à la référence d’image sélectionnée. Pour obtenir la liste des références SKU de l’agent de nœud de calcul prises en charge, ainsi que leur liste de références d’images vérifiées, consultez l’opération « Répertorier les références SKU de l’agent de nœud de calcul prises en charge ».

--os-disk-caching

Spécifiez 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.

valeurs acceptées: none, readonly, readwrite
--os-disk-size

Taille initiale du disque en Go lors de la création d’un disque de système d’exploitation.

--os-family

Obligatoire. Les valeurs possibles sont : 2 - Famille de système d’exploitation 2, équivalente à Windows Server 2008 R2 SP1. 3 - Famille de systèmes d’exploitation 3, équivalent à Windows Server 2012. 4 - Famille de système d’exploitation 4, équivalente à Windows Server 2012 R2. 5 - Famille de systèmes d’exploitation 5, équivalent à Windows Server 2016. 6 - Famille de systèmes 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).

valeurs acceptées: 2, 3, 4, 5, 6
--os-version

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.

--pause-time-between-batches

Délai d’attente entre la fin de la mise à jour pour toutes les machines virtuelles d’un lot et le démarrage du lot suivant. La durée doit être spécifiée au format ISO 8601. Le format attendu est une durée ISO-8601.

--placement

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

valeurs acceptées: cachedisk
--policy

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.

valeurs acceptées: regional, zonal
--prioritize-unhealthy-instances

Mettez à niveau toutes les instances non saines dans un groupe identique avant toutes les instances saines. True si l’indicateur est présent.

valeurs acceptées: false, true
--resize-timeout

Ce délai d’expiration s’applique uniquement à la mise à l’échelle manuelle ; elle n’a aucun effet quand enableAutoScale a la valeur true. La valeur par défaut est de 15 minutes. La valeur minimale est de 5 minutes. Si vous spécifiez une valeur inférieure à 5 minutes, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Le format attendu est une durée ISO-8601.

--resource-tags

L’utilisateur peut spécifier des balises de ressource pour le pool. Toutes les ressources créées pour le pool seront également marquées par les mêmes balises de ressource.

--rollback-failed-instances-on-policy-breach

Échec de restauration des instances dans le modèle précédent si la stratégie de mise à niveau propagée est enfreinte. True si l’indicateur est présent.

valeurs acceptées: false, true
--security-type

Spécifiez le SecurityType de la machine virtuelle. Il doit être défini sur n’importe quelle valeur spécifiée pour activer Uefi Paramètres. Le comportement par défaut est : Uefi Paramètres ne sera pas activé, sauf si cette propriété est définie.

--start-task-command-line

Obligatoire. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

--start-task-resource-files

Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. Références de ressources séparées par l’espace au format filename=httpurl.

--start-task-wait-for-success

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. True si l’indicateur est présent.

--storage-account-type

Type de compte de stockage pour disque managé.

valeurs acceptées: premium_lrs, standard_lrs, standardssd_lrs
--target-communication

Mode de communication de nœud souhaité pour le pool. Si cet élément est présent, il remplace le targetNodeCommunicationMode existant configuré sur le pool. S’il est omis, toutes les métadonnées existantes restent inchangées.

valeurs acceptées: classic, default, simplified
--target-dedicated-nodes

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.

--target-low-priority-nodes

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.

--targets

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. Espace des disques cibles séparés à chiffrer. Les valeurs peuvent être OsDisk ou TemporaryDisk.

--task-slots-per-node

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 de la vmSize du pool ou 256.

--upgrade-policy-mode

Mode de mise à niveau du système d’exploitation du pool.

valeurs acceptées: automatic, manual, rolling
--use-rolling-upgrade-policy

Indique si la stratégie de mise à niveau propagée doit être utilisée pendant la mise à niveau automatique du système d’exploitation. La mise à niveau automatique du système d’exploitation revient à la stratégie par défaut si aucune stratégie n’est définie sur vmSS. True si l’indicateur est présent.

valeurs acceptées: false, true
--vm-size

Obligatoire. Pour plus d’informations sur les tailles disponibles des machines virtuelles pour les pools Services cloud (pools créés avec cloudServiceConfiguration), consultez Tailles pour Services cloud (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch prend en charge toutes les tailles de machine virtuelle Services cloud à l’exception d’ExtraSmall, A1V2 et A2V2. Pour plus d’informations sur les tailles de machines virtuelles disponibles pour les pools utilisant des images à partir de la Place de marché Machines Virtuelles (pools créés avec virtualMachineConfiguration), consultez Tailles pour Machines Virtuelles (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tailles pour Machines Virtuelles (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch prend en charge toutes les tailles de machine virtuelle Azure, à l’exception des STANDARD_A0 et celles avec stockage Premium (STANDARD_GS, STANDARD_DS et série STANDARD_DSV2).

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch pool create (azure-batch-cli-extensions extension)

Créez un pool Batch dans un compte. Lors de la création d’un pool, choisissez des arguments dans Services cloud Configuration ou Configuration de machine virtuelle.

az batch pool create [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--application-licenses]
                     [--application-package-references]
                     [--auto-scale-formula]
                     [--certificate-references]
                     [--disk-encryption-targets]
                     [--enable-inter-node-communication]
                     [--id]
                     [--image]
                     [--json-file]
                     [--metadata]
                     [--node-agent-sku-id]
                     [--os-family]
                     [--os-version]
                     [--parameters]
                     [--policy]
                     [--resize-timeout]
                     [--resource-group]
                     [--start-task-command-line]
                     [--start-task-resource-files]
                     [--start-task-wait-for-success]
                     [--target-dedicated-nodes]
                     [--target-low-priority-nodes]
                     [--targets]
                     [--task-slots-per-node]
                     [--template]
                     [--vm-size]

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--application-licenses

La liste des licences d’application doit être un sous-ensemble de licences d’application de service Batch disponibles. Si une licence n’est pas prise en charge, la création du pool échoue.

--application-package-references

Lors de la création d’un pool, l’ID d’application du package doit être complet (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Les modifications apportées aux références de package affectent tous les nouveaux nœuds qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réinitialisé. Il existe un maximum de 10 références de package sur un pool donné.

--auto-scale-formula

Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur false. Elle est requise si enableAutoScale a la valeur true. La formule est case activée pour la validité avant la création du pool. Si la formule n’est pas valide, le service Batch rejette la demande avec des informations d’erreur détaillées. Pour plus d’informations sur la spécification de cette formule, consultez « Mettre automatiquement à l’échelle les nœuds de calcul dans un pool Azure Batch » (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

--certificate-references

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.

--disk-encryption-targets

Liste séparée d’espace de DiskEncryptionTargets. les valeurs possibles actuelles incluent OsDisk et TemporaryDisk.

--enable-inter-node-communication

Indique si le pool autorise la communication directe entre les nœuds de calcul. L’activation de la communication entre nœuds limite la taille maximale du pool en raison de restrictions de déploiement sur les nœuds de calcul du pool. Cela peut entraîner le fait que le pool n’atteigne pas sa taille souhaitée. La valeur par défaut est false (Faux).

valeur par défaut: False
--id

Obligatoire. 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. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID de pool au sein d’un compte qui diffèrent uniquement par cas).

--image

Référence d’image du système d’exploitation. Il peut s’agir du format « publisher :offer :sku[ :version] » ou d’un ID d’image ARM complet du formulaire « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} ». Si le format « publisher :offer :sku[ :version] » est facultatif et s’il est omis le plus récent sera utilisé. Les valeurs valides peuvent être récupérées via « az batch pool node-agent-skus list ». Par exemple : « MicrosoftWindowsServer :WindowsServer :2012-R2-Datacenter :latest ».

--json-file

Fichier contenant le pool à créer au format JSON, si ce paramètre est spécifié, tous les autres paramètres sont ignorés.

--metadata

Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.

--node-agent-sku-id

Référence SKU de l’agent de nœud Batch à provisionner sur les nœuds de calcul du pool. L’agent de nœud Batch est un programme qui s’exécute sur chaque nœud du pool et fournit l’interface de commande et de contrôle entre le nœud et le service Batch. Il existe différentes implémentations de l’agent de nœud pour différents systèmes d’exploitation, connues sous le nom de références. Vous devez spécifier une référence SKU de l’agent de nœud qui correspond à la référence d’image sélectionnée. Pour obtenir la liste des références SKU de l’agent de nœud 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 prises en charge ».

--os-family

Famille de systèmes d’exploitation invités d’Azure à installer sur les machines virtuelles au sein du pool. Les valeurs possibles sont : 2 - Famille de système d’exploitation 2, équivalente à Windows Server 2008 R2 SP1. 3 - Famille de systèmes d’exploitation 3, équivalent à Windows Server 2012. 4 - Famille de système d’exploitation 4, équivalente à Windows Server 2012 R2. 5 - Famille de systèmes d’exploitation 5, équivalent à Windows Server 2016. 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). Valeurs autorisées : 2, 3, 4, 5.

--os-version

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.

--parameters

Valeurs de paramètre pour un fichier de modèle JSON de pool Batch. Peut être utilisé uniquement avec --template.

--policy

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. Valeurs autorisées : régional, zonal.

--resize-timeout

Ce délai d’expiration s’applique uniquement à la mise à l’échelle manuelle ; elle n’a aucun effet quand enableAutoScale a la valeur true. La valeur par défaut est de 15 minutes. La valeur minimale est de 5 minutes. Si vous spécifiez une valeur inférieure à 5 minutes, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).

--resource-group

Groupe de ressources du compte Batch.

--start-task-command-line

Ligne de commande de la tâche de démarrage. 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.

--start-task-resource-files

Liste des fichiers que le service Batch télécharge sur le nœud de calcul avant d’exécuter la ligne de commande. Références de ressources séparées par espace au format filename=httpurl.

--start-task-wait-for-success

Indique si le service Batch doit attendre que la tâche de démarrage 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 la tâche de démarrage échoue sur un nœud de calcul, le service Batch retente la tâche de démarrage 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 de calcul inutilisable et ne planifie pas les tâches. Cette condition peut être détectée via l’état du nœud et la planification des détails d’erreur. Si la valeur est false, le service Batch n’attend pas la fin de la tâche de démarrage. Dans ce cas, d’autres tâches peuvent commencer à s’exécuter sur le nœud de calcul pendant que la tâche de démarrage est toujours en cours d’exécution ; et même si la tâche de démarrage échoue, les nouvelles tâches continueront d’être planifiées sur le nœud. La valeur par défaut est false. True si l’indicateur est présent.

valeur par défaut: False
--target-dedicated-nodes

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.

--target-low-priority-nodes

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.

--targets

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. Espace des disques cibles séparés à chiffrer. Les valeurs peuvent être OsDisk ou TemporaryDisk.

--task-slots-per-node

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 de la vmSize du pool ou 256.

--template

Fichier de modèle JSON du pool Batch. Si ce paramètre est spécifié, tous les autres paramètres sont ignorés.

--vm-size

Obligatoire. Pour plus d’informations sur les tailles disponibles des machines virtuelles pour les pools Services cloud (pools créés avec cloudServiceConfiguration), consultez Tailles pour Services cloud (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch prend en charge toutes les tailles de machine virtuelle Services cloud à l’exception d’ExtraSmall, A1V2 et A2V2. Pour plus d’informations sur les tailles de machines virtuelles disponibles pour les pools utilisant des images à partir de la Place de marché Machines Virtuelles (pools créés avec virtualMachineConfiguration), consultez Tailles pour Machines Virtuelles (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tailles pour Machines Virtuelles (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch prend en charge toutes les tailles de machine virtuelle Azure, à l’exception des STANDARD_A0 et celles avec stockage Premium (STANDARD_GS, STANDARD_DS et série STANDARD_DSV2).

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch pool delete

Supprime un pool du compte spécifié.

Lorsque vous demandez qu’un pool soit supprimé, les actions suivantes se produisent : l’état du pool est défini sur la suppression ; toute opération de redimensionnement en cours sur le pool est arrêtée ; le service Batch démarre le redimensionnement du pool sur zéro nœuds de calcul ; toutes les tâches exécutées sur des nœuds de calcul existants sont arrêtées et requeuées (comme si une opération de redimensionnement de pool avait été demandée avec l’option de mise en file d’attente par défaut) ; enfin, le pool est supprimé du système. Étant donné que les tâches en cours d’exécution sont requeuées, l’utilisateur peut réexécuter ces tâches en mettant à jour leur travail pour cibler un autre pool. Les tâches peuvent ensuite s’exécuter sur le nouveau pool. Si vous souhaitez remplacer le comportement de mise en file d’attente, vous devez appeler le pool de redimensionnement explicitement pour réduire la taille zéro du pool avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool dans l’état de suppression, elle échoue avec le code d’état HTTP 409 avec le code d’erreur PoolBeingDeleted.

az batch pool delete --pool-id
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]
                     [--yes]

Paramètres obligatoires

--pool-id

ID du pool à supprimer.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch pool list

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

az batch pool list [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--expand]
                   [--filter]
                   [--select]

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--expand

Clause $expand OData.

--filter

Clause OData $filter. 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-pools.

--select

Clause OData $select.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch pool reset

Mettez à jour les propriétés d’un pool Batch. Les propriétés non spécifiées qui peuvent être mises à jour sont réinitialisées à leurs valeurs par défaut.

az batch pool reset --pool-id
                    [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--application-package-references]
                    [--certificate-references]
                    [--json-file]
                    [--metadata]
                    [--start-task-command-line]
                    [--start-task-environment-settings]
                    [--start-task-max-task-retry-count]
                    [--start-task-wait-for-success]

Paramètres obligatoires

--pool-id

ID du pool à mettre à jour.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--application-package-references

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

--certificate-references

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

--json-file

Fichier contenant la spécification des paramètres de propriétés de mise à jour du pool dans JSON(mis en forme pour correspondre au corps de la demande de l’API REST). Si ce paramètre est spécifié, tous les arguments de paramètre de paramètre de mise à jour du pool sont ignorés.

--metadata

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

--start-task-command-line

Ligne de commande de la tâche de démarrage. 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.

--start-task-environment-settings

Liste des paramètres de variable d’environnement pour la tâche de démarrage. Valeurs séparées par l’espace au format « key=value ».

--start-task-max-task-retry-count

Nombre maximal de fois que la tâche peut être retentée.

--start-task-wait-for-success

Indique si le service Batch doit attendre que la tâche de démarrage 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. True si l’indicateur est présent, sinon a la valeur False.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch pool resize

Redimensionnez ou arrêtez le redimensionnement d’un pool Batch.

az batch pool resize --pool-id
                     [--abort]
                     [--account-endpoint]
                     [--account-key]
                     [--account-name]
                     [--if-match]
                     [--if-modified-since]
                     [--if-none-match]
                     [--if-unmodified-since]
                     [--node-deallocation-option {requeue, retaineddata, taskcompletion, terminate}]
                     [--resize-timeout]
                     [--target-dedicated-nodes]
                     [--target-low-priority-nodes]

Paramètres obligatoires

--pool-id

ID du pool.

Paramètres facultatifs

--abort

Arrêtez l’opération de redimensionnement du pool.

valeur par défaut: False
--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--if-match

L’opération est effectuée uniquement si l’ETag actuel de la ressource correspond exactement à la valeur spécifiée.

--if-modified-since

L’opération est effectuée uniquement si la ressource a été modifiée depuis l’horodatage spécifié.

--if-none-match

L’opération ne sera pas effectuée uniquement si l’ETag actuel de la ressource correspond exactement à la valeur spécifiée.

--if-unmodified-since

L’opération ne sera pas effectuée uniquement si la ressource a été modifiée depuis l’horodatage spécifié.

--node-deallocation-option

Lorsque les nœuds peuvent être supprimés du pool, si la taille du pool diminue.

valeurs acceptées: requeue, retaineddata, taskcompletion, terminate
--resize-timeout

La valeur par défaut est de 15 minutes. La valeur minimale est de 5 minutes. Si vous spécifiez une valeur inférieure à 5 minutes, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).

--target-dedicated-nodes

Nombre souhaité de nœuds de calcul dédiés dans le pool.

--target-low-priority-nodes

Nombre souhaité de nœuds de calcul Spot/Basse priorité dans le pool.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch pool set

Mettez à jour les propriétés d’un pool Batch. La mise à jour d’une propriété dans un sous-groupe réinitialise les propriétés non spécifiées de ce groupe.

az batch pool set --pool-id
                  [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--application-package-references]
                  [--certificate-references]
                  [--if-match]
                  [--if-modified-since]
                  [--if-none-match]
                  [--if-unmodified-since]
                  [--json-file]
                  [--metadata]
                  [--start-task-command-line]
                  [--start-task-environment-settings]
                  [--start-task-max-task-retry-count]
                  [--start-task-resource-files]
                  [--start-task-wait-for-success]
                  [--target-communication {classic, default, simplified}]

Paramètres obligatoires

--pool-id

ID du pool à mettre à jour.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--application-package-references

Les modifications apportées aux références de package affectent tous les nouveaux nœuds qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réinitialisé. Si cet élément est présent, il remplace toutes les références de package existantes. Si vous spécifiez une collection vide, toutes les références de package sont supprimées du pool. En cas d’omission, toutes les références de package existantes restent inchangées. ID d’application séparés par espace avec version facultative au format « id[#version] ».

--certificate-references

Si cet élément est présent, il remplace toutes les références de certificat existantes configurées sur le pool. S’il est omis, les références de certificat existantes restent inchangées. 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. Empreintes de certificat séparées par l’espace.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

--json-file

Fichier contenant la spécification des paramètres de correctif de pool au format JSON (mis en forme pour correspondre au corps de l’API REST respective). Si ce paramètre est spécifié, tous les « arguments de pool » sont ignorés.

--metadata

Si cet élément est présent, il remplace toutes les métadonnées existantes configurées sur le pool. Si vous spécifiez une collection vide, toutes les métadonnées sont supprimées du pool. S’il est omis, toutes les métadonnées existantes restent inchangées. Valeurs séparées par l’espace au format « key=value ».

--start-task-command-line

Obligatoire. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

--start-task-environment-settings

Valeurs séparées par l’espace au format « key=value ».

--start-task-max-task-retry-count

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

--start-task-resource-files

Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. Références de ressources séparées par l’espace au format filename=httpurl.

--start-task-wait-for-success

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. Spécifiez « true » ou « false » pour mettre à jour la propriété.

--target-communication

Mode de communication de nœud souhaité pour le pool. Si cet élément est présent, il remplace le targetNodeCommunicationMode existant configuré sur le pool. S’il est omis, toutes les métadonnées existantes restent inchangées.

valeurs acceptées: classic, default, simplified
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch pool show

Obtient des informations sur le pool spécifié.

az batch pool show --pool-id
                   [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--expand]
                   [--if-match]
                   [--if-modified-since]
                   [--if-none-match]
                   [--if-unmodified-since]
                   [--select]

Paramètres obligatoires

--pool-id

ID du pool à obtenir.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--expand

Clause $expand OData.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

--select

Clause OData $select.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.