Partager via

Gérer des ressources Batch avec Azure CLI

Vous pouvez gérer vos comptes et ressources Azure Batch à l’aide de l’interface Azure Command-Line (Azure CLI). Il existe des commandes pour créer et mettre à jour des ressources Batch telles que des pools, des travaux et des tâches. Vous pouvez également créer des scripts pour la plupart des mêmes tâches que celles que vous effectuez via des API Batch, des applets de commande PowerShell et le portail Azure.

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

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

Configurer Azure CLI

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

Si vous débutez avec Azure CLI, consultez Prise en main d’Azure CLI avant de continuer.

Si vous avez déjà 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 des commandes de service Batch Management . Ensuite, vous pouvez exécuter des commandes pour gérer les comptes, clés, packages d’application et quotas Batch.

Vous pouvez authentifier votre compte Azure dans Azure CLI) de deux manières. Pour exécuter des commandes par vous-même, connectez-vous à Azure CLI de manière interactive. Azure CLI met en cache vos informations d’identification et peut utiliser ces mêmes informations d’identification pour vous connecter à votre compte Batch après. 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

Ensuite, connectez-vous à votre compte Batch dans Azure CLI à l’aide de la commande az batch account login . Cette étape vous donne accès aux commandes de service Batch. Vous pouvez ensuite gérer des ressources Batch telles que des pools, des travaux et des 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 l’ID Microsoft Entra. 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 les commandes Batch, vous pouvez utiliser l’une ou l’autre méthode 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 pour l’authentification auprès de votre compte Batch est via l’ID Microsoft Entra. Lorsque vous vous connectez à Azure CLI de manière interactive ou avec un principal de service, vous pouvez utiliser ces mêmes informations d’identification mises en cache pour vous connecter à votre compte Batch avec l’ID Microsoft Entra. Cette méthode d’authentification offre également un contrôle d’accès en fonction du rôle Azure (Azure RBAC). Avec Azure RBAC, l’accès utilisateur dépend de son rôle 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 l’ID Microsoft Entra, exécutez az batch login. Veillez à inclure les paramètres requis 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 vos clés d’accès de compte pour authentifier les commandes Azure CLI pour le service Batch.

Pour vous connecter à votre compte Batch avec l’authentification par clé partagée, exécutez az batch login avec le paramètre --shared-key-auth. Veillez à inclure les paramètres requis 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

Apprendre les commandes Batch

La documentation de référence Azure CLI répertorie toutes les commandes Azure CLI pour Batch.

Pour répertorier 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 apprendre à créer et gérer des comptes, des pools, des travaux et des tâches Batch.

Utiliser les commandes d’extension Batch CLI

Vous pouvez utiliser l’extension Batch CLI 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 des commandes pour se connecter à un compte de stockage Azure lié à votre compte Batch. Vous pouvez ensuite charger des fichiers d’entrée de travail et télécharger des fichiers d’entrée de travail.

Créer des ressources avec JSON

Vous pouvez créer la plupart des ressources Batch à l’aide de paramètres de ligne de commande uniquement. Certaines fonctionnalités nécessitent que vous spécifiiez un fichier de configuration JSON à la place. Le fichier JSON contient les détails de configuration de votre nouvelle ressource. Par exemple, vous devez utiliser un fichier JSON pour spécifier des fichiers de ressources pour une tâche de démarrage.

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

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

Lorsque 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 de référence de l’API REST Batch répertorie toute syntaxe JSON requise pour créer une ressource.

Pour afficher la syntaxe JSON requise pour créer une ressource, reportez-vous à la documentation de référence de l’API REST Batch . Accédez à la section Exemples dans la page de référence de l’opération de ressource. Ensuite, recherchez la sous-section intitulée Ajouter <un type> de ressource. Par exemple, ajoutez une tâche de base. Utilisez l’exemple de code JSON comme modèles pour vos fichiers de configuration.

Pour obtenir 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 répertorier toutes les ressources à l’aide de la list commande. Par exemple, pour répertorier les pools dans votre compte et vos tâches dans un travail :

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

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

Clause Descriptif
--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. La clause expand prend actuellement en charge uniquement la stats propriété.

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

Résolution des problèmes

Pour obtenir de l’aide sur n’importe quelle 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 une 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 demandes et réponses REST réelles.

Pour afficher la sortie de 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. Ensuite, copiez et modifiez la sortie pour créer des ressources Batch à l’aide d’un fichier de configuration 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

  • Last updated on