Gérer les ressources Batch avec Azure CLI

  • Article

Vous pouvez gérer vos comptes et ressources Azure Batch à l’aide de l’interface de ligne de commande Azure (Azure CLI). Il existe des commandes pour la création et la mise à jour des ressources Batch tels que les pools, les travaux et les tâches. Vous pouvez également créer des scripts pour la plupart des tâches que vous effectuez via les API Batch, les applets de commande PowerShell et le portail Azure.

Vous pouvez exécuter Azure CLI dans Azure Cloud Shell ou installer Azure CLI localement. Des versions sont disponibles pour les OS (systèmes d’exploitation) Windows, Mac et Linux.

Cet article explique comment utiliser Azure CLI avec des comptes et des ressources Batch.

Configuration de l’interface de ligne de commande Azure

Choisissez la façon dont vous souhaitez configurer Azure CLI :

Si vous débutez l’utilisation d’Azure CLI, consultez Bien démarrer avec Azure CLI avant de continuer.

Si vous avez installé Azure CLI localement, veillez à mettre à jour votre installation vers la dernière version.

S’authentifier auprès d’Azure CLI

Pour utiliser Azure CLI avec Batch, connectez-vous d’abord à votre compte Azure, puis connectez-vous à votre compte Batch.

Se connecter au compte Azure

Pour utiliser Azure CLI, connectez-vous d’abord à votre compte Azure. Cette étape vous donne accès aux commandes Azure Resource Manager, qui incluent les commandes du service Batch Management. Vous pouvez ensuite exécuter des commandes pour gérer les comptes, les clés, les packages d’application et les quotas Batch.

Vous pouvez authentifier votre compte Azure dans Azure CLI) de deux façons. Pour exécuter des commandes vous-même, connectez-vous à Azure CLI de manière interactive. Azure CLI met en cache vos informations d’identification et peut ensuite les utiliser pour vous connecter à votre compte Batch. Pour exécuter des commandes à partir d’un script ou d’une application, connectez-vous à Azure CLI avec un principal de service.

Pour vous connecter à Azure CLI de manière interactive, exécutez az login :

az login

Se connecter au compte Batch

Connectez-vous ensuite à votre compte Batch dans Azure CLI à l’aide de la commande az batch account login. Cette étape vous donne accès aux commandes du service Batch. Vous pouvez ensuite gérer les ressources Batch telles que les pools, les travaux et les tâches.

Vous pouvez authentifier votre compte Batch dans Azure CLI de deux façons. La méthode par défaut consiste à s’authentifier à l’aide de Microsoft Entra ID. Nous vous recommandons d’utiliser cette méthode dans la plupart des scénarios. Une autre option consiste à utiliser l’authentification par clé partagée.

Si vous créez des scripts Azure CLI pour automatiser des commandes Batch, vous pouvez utiliser l’une ou l’autre des méthodes d’authentification. Dans certains scénarios, l’authentification par clé partagée peut être plus simple que la création d’un principal de service.

S’authentifier avec Microsoft Entra ID

La méthode par défaut d’authentification auprès de votre compte Batch repose sur Microsoft Entra ID. Quand vous vous connectez à Azure CLI de manière interactive ou avec un principal de service, vous pouvez utiliser les mêmes informations d’identification mises en cache pour vous connecter à votre compte Batch avec Microsoft Entra ID. Cette méthode d’authentification offre également un contrôle RBAC (contrôle d’accès en fonction du rôle) Azure. Avec le contrôle RBAC Azure, l’accès des utilisateurs dépend du rôle qui leur a été attribué, et non des clés de compte. Vous devez uniquement gérer les rôles Azure, et non les clés de compte. Microsoft Entra ID gère ensuite l’accès et l’authentification.

Pour vous connecter à votre compte Batch avec Microsoft Entra ID, exécutez az batch login. Veillez à inclure les paramètres obligatoires pour le nom de votre compte Batch (-n) et le nom de votre groupe de ressources (-g).

az batch account login -g <your-resource-group> -n <your-batch-account>

S’authentifier avec une clé partagée

Vous pouvez également utiliser l’authentification par clé partagée pour vous connecter à votre compte Batch. Cette méthode utilise les clés d’accès de votre compte pour authentifier les commandes Azure CLI auprès du service Batch.

Pour vous connecter à votre compte Batch en utilisant l’authentification par clé partagée, exécutez az batch login avec le paramètre --shared-key-auth. Veillez à inclure les paramètres obligatoires pour le nom de votre compte Batch (-n) et le nom de votre groupe de ressources (-g).

az batch account login -g <your-resource-group> -n <your-batch-account> --shared-key-auth

Découvrir les commandes Batch

La documentation de référence d’Azure CLI liste toutes les commandes Azure CLI pour Batch.

Pour lister toutes les commandes Batch dans Azure CLI, exécutez az batch -h.

Il existe plusieurs exemples de scripts CLI pour les tâches Batch courantes. Ces exemples montrent comment utiliser de nombreuses commandes disponibles pour Batch dans Azure CLI. Vous pouvez découvrir comment créer et gérer des comptes, des pools, des travaux et des tâches Batch.

Utiliser les commandes de l’extension CLI Batch

Vous pouvez utiliser l’extension CLI Batch pour exécuter des travaux Batch sans écrire de code. L’extension fournit des commandes permettant d’utiliser des modèles JSON pour créer des pools, des travaux et des tâches avec Azure CLI. L’extension fournit également les commandes nécessaires pour se connecter à un compte Stockage Azure lié à votre compte Batch. Vous pouvez ensuite charger les fichiers d’entrée des travaux, et télécharger les fichiers d’entrée des travaux.

Créer des ressources avec JSON

Vous pouvez créer la plupart des ressources Batch en utilisant uniquement des paramètres de ligne de commande. Pour certaines fonctionnalités, vous devez plutôt spécifier un fichier config JSON. Le fichier JSON contient les détails de configuration de votre nouvelle ressource. Par exemple, vous devez utiliser un fichier JSON pour spécifier les fichiers de ressources d’une tâche de démarrage.

Par exemple, pour utiliser un fichier JSON afin de configurer une nouvelle ressource de pool Batch :

az batch pool <your-batch-pool-configuration>.json

Quand vous spécifiez un fichier JSON pour une nouvelle ressource, n’utilisez pas d’autres paramètres dans votre commande. Le service utilise uniquement le fichier JSON pour configurer la ressource.

La documentation relative à la référence API REST pour Batch liste la syntaxe JSON nécessaire à la création d’une ressource.

Pour afficher la syntaxe JSON requise pour créer une ressource, consultez la documentation Informations de référence de l’API REST Batch. Accédez à la section Exemples de la page de référence de l’opération relative à la ressource. Recherchez ensuite la sous-section intitulée Ajouter <type de ressource>. Exemple : Ajouter une tâche de base. Utilisez l’exemple de code JSON en tant que modèle pour vos fichiers config.

Pour un exemple de script qui spécifie un fichier JSON, consultez Exécuter un travail et des tâches avec Batch.

Interroger efficacement les ressources Batch

Vous pouvez interroger votre compte Batch et lister toutes les ressources à l’aide de la commande list. Par exemple, pour lister les pools de votre compte et les tâches d’un travail :

az batch pool list
az batch task list --job-id <your-job-id>

Pour limiter la quantité de données retournée par votre requête Batch, spécifiez une clause OData. Dans la mesure où tout le filtrage se produit côté serveur, vous ne recevez que les données que vous demandez. Utilisez ces clauses OData pour économiser de la bande passante et gagner du temps avec les opérations list. Pour plus d’informations, consultez Concevoir des requêtes de liste efficaces pour les ressources Batch.

Clause Description
--select-clause [select-clause] Retourne un sous-ensemble de propriétés pour chaque entité.
--filter-clause [filter-clause] Retourne uniquement les entités qui correspondent à l’expression OData spécifiée.
--expand-clause [expand-clause] Obtient les informations d’entité dans un seul appel REST sous-jacent. Pour le moment, la clause expand ne prend en charge que la propriété stats.

Pour obtenir un exemple de script montrant comment utiliser ces clauses, consultez Exécuter un travail et des tâches avec Batch.

Dépannage

Pour obtenir de l’aide sur une commande Batch, ajoutez -h à la fin de votre commande. N’ajoutez pas d’autres options. Par exemple, pour obtenir de l’aide sur la création d’un compte Batch, exécutez az batch account create -h.

Pour retourner la sortie de commande détaillée, ajoutez -v ou -vv à la fin de votre commande. Utilisez ces commutateurs pour afficher la sortie d’erreur complète. L’indicateur -vv retourne les requêtes et réponses REST réelles.

Pour voir la sortie de la commande au format JSON, ajoutez --json à la fin de votre commande. Par exemple, pour afficher les propriétés d’un pool nommé pool001, exécutez az batch pool show pool001 --json. Copiez et modifiez ensuite la sortie pour créer des ressources Batch à l’aide d’un fichier config JSON.

Résolution des problèmes généraux d’Azure CLI

Azure CLI peut s’exécuter dans plusieurs environnements de shell, mais avec de légères variations en termes de format. Si vous avez des résultats inattendus avec des commandes Azure CLI, consultez Comment utiliser Azure CLI avec succès.

Étapes suivantes

Démarrage rapide : Exécuter votre premier travail Batch avec Azure CLI