Gérer les outils de développement Azure avecazd tool

L’interface CLI Azure développeur (azd) inclut un groupe de commandes intégré azd tool pour la découverte, l’installation, la mise à niveau et la vérification de l’état des outils courants utilisés pour générer et expédier des applications Azure. Il encapsule les gestionnaires de paquets sous-jacents sur chaque plateforme (tels que winget, brew, apt, npm et l’interface en ligne de commande de VS Code code) au moyen d’un ensemble cohérent de sous-commandes, et prend en charge à la fois l’utilisation interactive et l’automatisation.

Les cas d’usage courants de azd tool incluent :

  • Installation de tous les outils de développement recommandés Azure sur un nouvel ordinateur avec une seule commande.
  • Normalisation de l’environnement de développement au sein d’une équipe ou d’un ensemble d’agents CI.
  • Auditer les outils Azure (et les versions) installés sur un ordinateur donné.
  • Recherchez et appliquez des mises à jour aux outils installés.
  • Configuration de l’outil de script dans les pipelines à l’aide d’indicateurs non interactifs et de sortie JSON.

Outils intégrés

Le Registre intégré comprend les outils suivants. Utilisez les colonnes catégorie et priorité pour déterminer quels outils s’appliquent à un flux de travail donné.

ID Nom Category Priority Stratégie d’installation classique
az-cli Azure CLI cli Recommandé winget / brew / apt
github-copilot-cli GitHub Copilot CLI cli Recommandé winget / brew / npm
vscode-azure-tools outils Azure (VS Code) extension Recommandé CLI code
vscode-bicep Bicep (VS Code) extension Recommandé CLI code
vscode-github-copilot GitHub Copilot (VS Code) extension Optional CLI code
azure-mcp-server Serveur Azure MCP server Optional npm
azd-ai-extensions azd Extensions d’IA library Optional azd extension

La stratégie d’installation exacte dépend du système d’exploitation et des gestionnaires de packages disponibles sur l’ordinateur.

Note

Les extensions VS Code nécessitent que l’interface code CLI soit disponible sur le PATH. S’il code n’est pas disponible, les outils s’affichent comme non installés et vous ne pouvez pas les installer via azd tool.

Vue d’ensemble des commandes

Le azd tool groupe de commandes inclut les sous-commandes suivantes.

Command Description
azd tool Démarre un flux interactif qui affiche les outils installés et disponibles et invite les outils à installer en une seule étape.
azd tool list Répertorie tous les outils inscrits, notamment l’état d’installation, la version, la catégorie et la priorité.
azd tool show <id> Affiche des informations détaillées pour un outil spécifique, notamment les stratégies d’installation par plateforme et le site web du projet.
azd tool check Vérifie les outils installés pour les mises à jour disponibles.
azd tool install [ids...] Installe un ou plusieurs outils par id.
azd tool upgrade [ids...] Met à niveau un ou plusieurs outils installés.

Toutes les commandes prennent en charge --output json pour une sortie au format lisible par machine, adaptée aux scripts et aux pipelines.

Drapeaux courants

Les indicateurs suivants sont disponibles sur install et upgrade:

  • --all: installe ou met à niveau tous les outils éligibles. Pour install, cette commande inclut tous les outils recommandés. Pour upgrade, cette commande inclut tous les outils installés qui ont des mises à jour disponibles.
  • --dry-run: affiche un aperçu des actions azd sans apporter de modifications.

Les options suivantes régissent le comportement des invites :

  • --no-prompt: Supprime les invites interactives. Utile dans les scripts.
  • AZD_NON_INTERACTIVE=true: variable d’environnement équivalente à --no-prompt.
  • AZD_SKIP_FIRST_RUN=true: Désactive l’invite de vérification de l’outil lors de la première exécution.

Exemple de cas d’usage : démarrage d’une machine de développement

Pour configurer l’ensemble complet des outils de développement recommandés Azure sur un nouvel ordinateur, exécutez la commande suivante :

azd tool install --all

Cette commande installe chaque outil marqué comme recommended dans le Registre à l’aide du gestionnaire de package approprié pour la plateforme actuelle. Pour afficher un aperçu des actions d’installation sans apporter de modifications, ajoutez --dry-run:

azd tool install --all --dry-run

Pour conserver les outils installés en cours, exécutez les commandes suivantes :

azd tool check
azd tool upgrade --all

Répertorier les outils installés et disponibles

Exécutez azd tool list pour afficher chaque outil inscrit, son état d’installation et sa version installée :

$ azd tool list

  Id                     Name                      Category    Priority      Status          Version
  ─────────────────────  ────────────────────────  ──────────  ────────────  ──────────────  ────────
  az-cli                 Azure CLI                 cli         recommended   Installed       2.67.0
  github-copilot-cli     GitHub Copilot CLI        cli         recommended   Not Installed
  vscode-azure-tools     Azure Tools (VS Code)     extension   recommended   Installed       0.9.0
  vscode-bicep           Bicep (VS Code)           extension   recommended   Installed       0.30.0
  vscode-github-copilot  GitHub Copilot (VS Code)  extension   optional      Not Installed
  azure-mcp-server       Azure MCP Server          server      optional      Not Installed
  azd-ai-extensions      azd AI Extensions         library     optional      Not Installed

Pour retourner les mêmes données que JSON pour le script, exécutez :

azd tool list --output json

Afficher les détails d’un outil

Exécutez azd tool show <id> pour inspecter un outil spécifique, y compris les stratégies d’installation qui s’appliquent à chaque plateforme prise en charge et au site web du projet :

azd tool show az-cli

Installer un ou plusieurs outils

Transmettez une ou plusieurs valeurs d’outil id pour installer des outils spécifiques :

azd tool install az-cli vscode-bicep

Pour installer chaque outil recommandé, utilisez --all:

azd tool install --all

Pour afficher un aperçu des commandes d’installation sans les exécuter, ajoutez --dry-run:

azd tool install az-cli --dry-run

L’exécution azd tool sans sous-commande démarre un flux interactif qui affiche les outils installés, permet la sélection d’outils supplémentaires et les installe en une seule étape.

Rechercher les mises à jour

Exécutez azd tool check pour analyser les outils installés pour connaître les mises à jour disponibles :

azd tool check

azd exécute également une vérification périodique des mises à jour en arrière-plan et affiche des notifications non intrusives lorsque des versions plus récentes d’outils inscrits sont disponibles.

Outils de mise à niveau

Mettez à niveau des outils spécifiques en transmettant leurs id valeurs :

azd tool upgrade az-cli github-copilot-cli

Mettez à niveau tout ce qui a une mise à jour disponible :

azd tool upgrade --all

Affichez un aperçu du plan de mise à niveau sans l’appliquer :

azd tool upgrade --all --dry-run

Première expérience d’utilisation

La première fois qu’une commande de flux de travail telle que azd init, azd upou azd deploy s’exécute, azd effectue une vérification unique de l’outil et invite à passer en revue ou à installer les outils recommandés.

Utilisez l’une des options suivantes pour ignorer ou désactiver l’invite de première exécution :

  • Passez --no-prompt à la commande workflow.
  • Définissez la variable AZD_SKIP_FIRST_RUN=trued’environnement .
  • Exécutez cette commande dans un environnement CI détecté. azd contourne automatiquement l’invite lorsque CI, TF_BUILDou GITHUB_ACTIONS est défini.

Scénarios CI et non interactifs

Le azd tool groupe de commandes prend en charge les pipelines et les scripts via les options suivantes :

  • Utilisez des arguments positionnels id avec install et upgrade pour éviter la sélection interactive.
  • Ajoutez --no-prompt ou définissez AZD_NON_INTERACTIVE=true pour supprimer les invites.
  • Permet --output json de capturer des résultats structurés pour les étapes en aval.
  • Reposez sur la détection automatique CI, qui supprime l’invite de première exécution et les notifications de mise à jour en arrière-plan.

L’exemple suivant installe les Azure CLI et l’extension Bicep dans une étape de pipeline :

azd tool install az-cli vscode-bicep --no-prompt --output json