Gérer les ressources Batch avec les applets de commande PowerShell

  • Article

Grâce aux cmdlets PowerShell d’Azure Batch, vous pouvez exécuter et rédiger le script de nombreuses tâches Batch courantes. Il s’agit d’une présentation rapide des applets de commande que vous pouvez utiliser pour gérer vos comptes Batch et travailler avec des ressources Batch telles que les pools, les travaux et les tâches.

Pour obtenir une liste complète des applets de commande Batch et la syntaxe détaillée des applets de commande, consultez Référence d’applet de commande Azure Batch.

Nous vous recommandons de mettre à jour vos modules Azure PowerShell fréquemment pour tirer parti des améliorations et des mises à jour de service.

Prérequis

  • Installez and configurez le module Azure PowerShell. Pour installer un module Azure Batch spécifique, comme un module en pré-mise en production, consultez PowerShell Gallery.

  • Exécutez l’applet de commande Connect-AzAccount pour vous connecter à votre abonnement (les applets de commande Azure Batch font partie du module Azure Resource Manager) :

    Connect-AzAccount

  • Inscrivez-vous dans l’espace de noms de fournisseur Batch. Vous devez effectuer cette opération une fois par abonnement uniquement.

    Register-AzResourceProvider -ProviderNamespace Microsoft.Batch

Gestion des clés et des comptes Batch

Création d’un compte Batch

New-AzBatchAccount crée un compte Batch dans un groupe de ressources spécifié. Si vous ne disposez pas d’un groupe de ressources, créez-en un en exécutant l’applet de commande New-AzResourceGroup. Spécifiez une des régions Azure dans le paramètre Emplacement, « USA Centre » par exemple. Par exemple :

New-AzResourceGroup –Name MyBatchResourceGroup –Location "Central US"

Ensuite, créez un compte Batch dans le groupe de ressources. Spécifiez un nom pour le compte dans <nom_compte>, puis l’emplacement et le nom de votre groupe de ressources. La procédure de création du compte Batch peut prendre un certain temps. Par exemple :

New-AzBatchAccount –AccountName <account_name> –Location "Central US" –ResourceGroupName <res_group_name>

Notes

Le nom du compte Batch doit être unique dans la région Azure du groupe de ressources, contenir entre 3 et 24 caractères, et utiliser des minuscules et des chiffres uniquement.

Obtenir les clés d'accès au compte

Get-AzBatchAccountKeys affiche les clés d’accès associées à un compte Azure Batch. Par exemple, exécutez la commande suivante pour obtenir les clés primaires et secondaires du compte que vous avez créé.

$Account = Get-AzBatchAccountKeys –AccountName <account_name>

$Account.PrimaryAccountKey

$Account.SecondaryAccountKey

Générer une nouvelle clé d'accès

New-AzBatchAccountKey génère une nouvelle clé de compte primaire ou secondaire pour un compte Azure Batch. Par exemple, pour générer une nouvelle clé primaire pour votre compte Batch, tapez :

New-AzBatchAccountKey -AccountName <account_name> -KeyType Primary

Notes

Pour générer une nouvelle clé secondaire, spécifiez « Secondary » pour le paramètre KeyType . Vous devez régénérer les clés primaires et secondaires séparément.

Suppression d’un compte Batch

Remove-AzBatchAccount supprime un compte Batch. Par exemple :

Remove-AzBatchAccount -AccountName <account_name>

Quand vous y êtes invité, confirmez que vous voulez supprimer le compte. La suppression du compte peut prendre un certain temps.

Créer un objet BatchAccountContext

Vous pouvez vous authentifier pour gérer les ressources Batch à l’aide de l’authentification de clé partagée ou de l’authentification Microsoft Entra. Pour vous authentifier à l’aide des cmdlets Batch PowerShell, commencez par créer un objet BatchAccountContext pour stocker vos informations d’identification de compte ou votre identité. Vous passez l’objet BatchAccountContext dans les applets de commande utilisant le paramètre BatchContext .

Authentification par clé partagée

$context = Get-AzBatchAccountKeys -AccountName <account_name>

Notes

Par défaut, la clé primaire du compte est utilisée pour l’authentification, mais vous pouvez sélectionner explicitement la clé à utiliser en modifiant la propriété KeyInUse de votre objet BatchAccountContext : $context.KeyInUse = "Secondary".

Authentification Microsoft Entra

$context = Get-AzBatchAccount -AccountName <account_name>

Créer et modifier les ressources Batch

Utilisez les applets de commande telles que New-AzBatchPool, New-AzBatchJob et New-AzBatchTask pour créer des ressources sous un compte Batch. Il existe des applets de commande Get- et Set- correspondantes pour mettre à jour les propriétés des ressources existantes, et des applets de commande Remove- pour supprimer des ressources sous un compte Batch.

Si vous utilisez plusieurs de ces applets de commande, en plus de transmettre un objet BatchContext, vous devez créer ou transmettre les objets qui contiennent des paramètres de ressources détaillés, comme illustré dans l’exemple suivant. Pour obtenir d’autres exemples, consultez l’aide détaillée de chaque applet de commande.

Créer un pool Batch

Lors de la création ou de la mise à jour d’un pool Batch, vous spécifiez une configuration. Les pools doivent généralement être configurés avec la configuration de la machine virtuelle, ce qui vous permet de spécifier l’une des images de machines virtuelles Linux ou Windows prises en charge qui figurent dans le marketplace de machines virtuelles Azure ou de fournir une image personnalisée que vous avez préparée. Les pools de configuration des services cloud fournissent uniquement des nœuds de calcul Windows et ne prennent pas en charge toutes les fonctionnalités de Batch.

Si vous exécutez New-AzBatchPool, passez les paramètres du système d’exploitation dans un objet PSVirtualMachineConfiguration ou PSCloudServiceConfiguration. Par exemple, l’extrait de code suivant crée un pool Batch avec des nœuds de calcul de taille Standard_A1, dans la configuration de machine virtuelle, dont l’image est créée avec Ubuntu Server 20.04-LTS. Ici, le paramètre VirtualMachineConfiguration spécifie la variable $configuration comme objet PSVirtualMachineConfiguration. Le paramètre BatchContext spécifie une variable $context définie au préalable en tant qu’objet BatchAccountContext.

$imageRef = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("UbuntuServer","Canonical","20.04-LTS")

$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageRef, "batch.node.ubuntu 20.04")

New-AzBatchPool -Id "mypspool" -VirtualMachineSize "Standard_a1" -VirtualMachineConfiguration $configuration -AutoScaleFormula '$TargetDedicated=4;' -BatchContext $context

Le nombre cible de nœuds de calcul dans le nouveau pool est calculé à partir d’une formule de mise à l’échelle automatique. Dans ce cas, la formule est simplement $TargetDedicated = 4, ce qui indique que le nombre de nœuds de calcul dans le pool est de 4 au maximum.

Requête relative aux pools, aux travaux, aux tâches et autres détails

Utilisez les applets de commande telles que Get-AzBatchPool, Get-AzBatchJob et Get-AzBatchTask pour interroger les entités créées sous un compte Batch.

Interrogation des données

Par exemple, utilisez Get-AzBatchPools pour rechercher vos pools. Par défaut, cette demande interroge tous les pools sous votre compte, en supposant que vous avez déjà stocké l’objet BatchAccountContext dans $context:

Get-AzBatchPool -BatchContext $context

Utilisation d’un filtre OData

Vous pouvez fournir un filtre OData à l'aide du paramètre Filter pour rechercher uniquement les objets qui vous intéressent. Par exemple, vous pouvez rechercher tous les pools dont l’identificateur commence par « myPool » :

$filter = "startswith(id,'myPool')"

Get-AzBatchPool -Filter $filter -BatchContext $context

Cette méthode n'est pas aussi flexible que l'utilisation de « Where-Object » dans un pipeline local. Toutefois, la requête est envoyée au service Batch directement pour que tout le filtrage se produise côté serveur et économise ainsi la bande passante Internet.

Utilisation du paramètre Id

Une alternative au filtre OData consiste à utiliser le paramètre Id . Pour rechercher un pool spécifique présentant l’identificateur « myPool » :

Get-AzBatchPool -Id "myPool" -BatchContext $context

Le paramètre Id prend uniquement en charge la recherche de l’identificateur complet. Il ne prend pas en charge les caractères génériques ni les filtres de style OData.

Utilisation du paramètre MaxCount

Par défaut, chaque applet de commande retourne un maximum de 1 000 objets. Si vous atteignez cette limite, affinez votre filtration pour limiter le nombre d’objets retournés, ou définissez explicitement une utilisation maximale à l’aide du paramètre MaxCount . Par exemple :

Get-AzBatchTask -MaxCount 2500 -BatchContext $context

Pour supprimer la limite supérieure, définissez MaxCount sur 0 ou une valeur inférieure.

Utilisation du pipeline PowerShell

Les applets de commande Batch utilisent le pipeline PowerShell pour envoyer des données vers les autres applets de commande. Cela a le même effet que la spécification d’un paramètre, mais permet d’utiliser plus facilement plusieurs entités.

Par exemple, recherchez et affichez toutes les tâches sous votre compte :

Get-AzBatchJob -BatchContext $context | Get-AzBatchTask -BatchContext $context

Redémarrez chaque nœud de calcul dans un pool :

Get-AzBatchComputeNode -PoolId "myPool" -BatchContext $context | Restart-AzBatchComputeNode -BatchContext $context

Gestion des packages d’application

Les packages d’application permettent de déployer facilement des applications vers les nœuds de calcul dans vos pools. Grâce aux applets de commande PowerShell pour Batch, vous pouvez télécharger et gérer des packages d’application dans votre compte Batch, et déployer des versions de package sur des nœuds de calcul.

Important

Pour utiliser les packages d’application, vous devez commencer par lier un compte de stockage Azure à votre compte Batch.

Créez une application :

New-AzBatchApplication -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication"

Ajoutez un package d’application :

New-AzBatchApplicationPackage -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication" -ApplicationVersion "1.0" -Format zip -FilePath package001.zip

Définissez la version par défaut pour l’application :

Set-AzBatchApplication -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication" -DefaultVersion "1.0"

Répertorier les packages d’une application

$application = Get-AzBatchApplication -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication"

$application.ApplicationPackages

Supprimer un package d’application

Remove-AzBatchApplicationPackage -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication" -ApplicationVersion "1.0"

Supprimer une application

Remove-AzBatchApplication -AccountName <account_name> -ResourceGroupName <res_group_name> -ApplicationId "MyBatchApplication"

Notes

Vous devez supprimer toutes les versions de packages d’application d’une application avant de supprimer l’application. Vous recevrez une erreur « Conflit » si vous essayez de supprimer une application qui possède des packages d’applications.

Déployer un package d’application

Vous pouvez spécifier un ou plusieurs packages d’application pour le déploiement lorsque vous créez un pool. Lorsque vous spécifiez un package lors de la création du pool, il est déployé sur chaque nœud lorsque le nœud rejoint le pool. Les packages sont également déployés lorsqu’un nœud est redémarré ou réinitialisé.

Spécifiez l’option -ApplicationPackageReference lors de la création d’un pool pour déployer un package d’application sur les nœuds du pool dès qu’ils rejoignent le pool. Commencez par créer un objet PSApplicationPackageReference, puis configurez-le avec l’ID d’application et la version du package que vous souhaitez déployer sur les nœuds de calcul du pool :

$appPackageReference = New-Object Microsoft.Azure.Commands.Batch.Models.PSApplicationPackageReference

$appPackageReference.ApplicationId = "MyBatchApplication"

$appPackageReference.Version = "1.0"

Créez maintenant le pool et spécifiez l’objet de référence du package comme argument dans l’option ApplicationPackageReferences :

New-AzBatchPool -Id "PoolWithAppPackage" -VirtualMachineSize "Small" -VirtualMachineConfiguration $configuration -BatchContext $context -ApplicationPackageReferences $appPackageReference

Pour plus d’informations sur les packages d’applications, consultez Déployer des applications sur les nœuds avec des packages d’applications Batch.

Mise à jour des packages d’applications d’un pool

Pour mettre à jour les applications associées à un pool existant, commencez par créer un objet PSApplicationPackageReference avec les propriétés souhaitées (ID d’application et version de package) :

$appPackageReference = New-Object Microsoft.Azure.Commands.Batch.Models.PSApplicationPackageReference

$appPackageReference.ApplicationId = "MyBatchApplication"

$appPackageReference.Version = "2.0"

Obtenez ensuite le pool dans Batch, effacez tous les packages existants, ajoutez la nouvelle référence de package, puis mettez à jour le service Batch avec les nouveaux paramètres de pool :

$pool = Get-AzBatchPool -BatchContext $context -Id "PoolWithAppPackage"

$pool.ApplicationPackageReferences.Clear()

$pool.ApplicationPackageReferences.Add($appPackageReference)

Set-AzBatchPool -BatchContext $context -Pool $pool

Vous avez mis à jour les propriétés du pool dans le service Batch. Pour déployer réellement le nouveau package d’application sur des nœuds de calcul dans le pool, vous devez redémarrer ou réinitialiser ces nœuds. Vous pouvez redémarrer tous les nœuds dans un pool avec la commande suivante :

Get-AzBatchComputeNode -PoolId "PoolWithAppPackage" -BatchContext $context | Restart-AzBatchComputeNode -BatchContext $context

Conseil

Vous pouvez déployer plusieurs packages d’application sur les nœuds de calcul dans un pool. Si vous souhaitez ajouter un package d’application au lieu de remplacer les packages actuellement déployés, omettez la ligne $pool.ApplicationPackageReferences.Clear() ci-dessus.

Étapes suivantes