azure-resource-visualizer

Vue d’ensemble

Qu’est-ce que azure-resource-visualizer ?

azure-resource-visualizer est une skill de visualisation centrée sur Azure, conçue pour analyser vos groupes de ressources Azure et les transformer en documentation d’architecture claire et lisible par des humains. Elle inspecte les ressources, leurs configurations et leurs relations, puis produit des diagrammes Mermaid détaillés et des fichiers markdown décrivant votre topologie cloud.

Au lieu de reconstituer manuellement comment les réseaux virtuels, sous-réseaux, App Services, bases de données et composants de sécurité s’imbriquent, azure-resource-visualizer automatise la découverte et la création de diagrammes pour vous offrir une vue à jour de votre environnement.

Fonctionnalités clés

• Découverte des groupes de ressources – Liste et vous aide à sélectionner des groupes de ressources Azure lorsqu’aucun n’est spécifié.
• Analyse approfondie des ressources – Examine les ressources, leurs configurations et leurs interdépendances au sein d’un groupe de ressources.
• Cartographie des relations – Identifie et documente les connexions entre les ressources de calcul, réseau, données et sécurité.
• Génération de diagrammes Mermaid – Produit des diagrammes Mermaid complets et syntaxiquement corrects, prêts à être utilisés dans du markdown, des sites de documentation ou des wikis.
• Documentation d’architecture – Génère des pages markdown pouvant inclure inventaires, synthèses de haut niveau et diagrammes intégrés.

Pour qui est faite cette skill ?

Utilisez azure-resource-visualizer si vous êtes :

• Un architecte cloud qui a besoin rapidement de diagrammes d’architecture visuels pour des revues ou des dossiers de conception.
• Un développeur ou un ingénieur DevOps souhaitant comprendre comment les services d’un groupe de ressources sont interconnectés.
• Un ingénieur plateforme / infra cherchant à standardiser la documentation entre abonnements et équipes.
• Un ingénieur sécurité ou exploitation qui a besoin d’une vision claire des flux réseau et des dépendances.

Cette skill est particulièrement pertinente lorsque vous disposez déjà de ressources Azure déployées et que vous avez besoin de visibilité, de documentation ou de supports d’onboarding — moins lorsque vous n’en êtes encore qu’au stade de la conception sur le papier.

Problèmes adressés

• Passer des heures à dessiner manuellement des diagrammes Azure dans des outils de diagramme.
• Difficulté à comprendre comment les ressources d’un grand groupe de ressources sont liées les unes aux autres.
• Documentation d’architecture obsolète qui ne reflète pas fidèlement ce qui est réellement déployé.
• Absence de documentation markdown homogène et révisable pour chaque groupe de ressources.

Quand azure-resource-visualizer est (ou n’est pas) adapté

Adapté lorsque :

• Vous recherchez de la visualisation de données et du reporting sur une infrastructure Azure existante.
• Vous avez besoin de diagrammes Mermaid intégrés à du markdown, des dépôts ou des portails de documentation internes.
• Vous travaillez avec Azure Resource Graph ou az pour interroger les métadonnées de ressources.

Moins adapté lorsque :

• Vous avez besoin d’un outil pour provisionner ou modifier des ressources Azure (cette skill se concentre sur l’analyse et la visualisation, pas sur le déploiement).
• Vous cherchez de l’analyse de coûts, de la supervision de performance ou des scans de sécurité — ces aspects sont hors périmètre.
• Vous n’avez pas accès aux métadonnées de l’abonnement Azure ou vous ne pouvez pas exécuter de requêtes az / Azure Resource Graph.

Utilisation

Prérequis

Avant d’utiliser azure-resource-visualizer, assurez-vous de disposer :

• D’un abonnement Azure actif avec un ou plusieurs groupes de ressources.
• Des accès et permissions nécessaires pour interroger les ressources de ces abonnements.
• De l’Azure CLI (az) installée et connectée, si votre configuration s’appuie sur la découverte via CLI.
• De l’extension Resource Graph pour la CLI si vous comptez utiliser des requêtes Azure Resource Graph :
  • az extension add --name resource-graph

Ces prérequis permettent à la skill (ou à l’agent qui l’utilise) de lister les groupes de ressources et d’inspecter les ressources ainsi que leurs relations.

Installer la skill azure-resource-visualizer

Pour ajouter azure-resource-visualizer à partir du dépôt microsoft/azure-skills, utilisez la skills CLI :

npx skills add https://github.com/microsoft/azure-skills --skill azure-resource-visualizer

Cette commande récupère la définition de la skill et les ressources associées (exemples, modèles et références) dans votre environnement local de skills afin que votre agent ou vos workflows puissent l’appeler.

Comprendre les fichiers inclus

Après l’installation, examinez ces fichiers et dossiers clés sous skills/azure-resource-visualizer :

• SKILL.md – Définition centrale de la skill, de ses responsabilités et indications de workflow.
• assets/example-diagram.md – Un exemple complet de diagramme Mermaid montrant comment des ressources et couches Azure typiques sont représentées.
• assets/template-architecture.md – Un modèle markdown pour un rapport d’architecture complet, incluant un inventaire des ressources et des emplacements pour les sections de diagramme.
• references/azure-resource-graph.md – Guide et exemples KQL pour utiliser Azure Resource Graph afin de découvrir des ressources à grande échelle.

Ces fichiers illustrent à quoi ressemble un bon résultat et comment structurer votre propre documentation d’architecture.

Workflow type : du groupe de ressources au diagramme

Étape 1 : Sélectionner ou découvrir un groupe de ressources

Si l’utilisateur n’a pas indiqué de nom de groupe de ressources, le workflow de la skill est conçu pour :

1. Utiliser les outils disponibles (généralement az ou Azure Resource Graph) pour lister les groupes de ressources.
2. Présenter une liste numérotée avec noms et emplacements.
3. Demander à l’utilisateur quel groupe de ressources doit être analysé.

Si un groupe de ressources est déjà connu, la skill peut ignorer cette phase de découverte et passer directement à l’analyse.

Étape 2 : Découvrir les ressources et les relations

Une fois le groupe de ressources sélectionné, azure-resource-visualizer se concentre sur :

• La liste de toutes les ressources du groupe (type, nom, région et configuration pertinente comme les SKUs).
• L’identification des interconnexions entre ressources — par exemple, quels App Services utilisent quels sous-réseaux, quelles Function Apps communiquent avec quelles bases de données, ou comment les identités accèdent à Key Vault.

Cela peut se faire via des outils comme :

• Des commandes az filtrées avec --resource-group.
• az graph query avec des modèles KQL proches de ceux de references/azure-resource-graph.md.

Étape 3 : Générer un diagramme d’architecture Mermaid

La skill transforme ensuite ses résultats en diagramme Mermaid. L’exemple dans assets/example-diagram.md illustre le style général :

• Groupement par couches à l’aide de blocs subgraph, par exemple :
  • Network Layer (VNets, subnets, NSGs)
  • Compute Layer (App Service plans, App Services, Functions)
  • Data Layer (databases, storage)
  • Security & Identity (Key Vault, managed identities)
• Libellés de nœud détaillés montrant des paramètres clés comme les plages d’adresses, SKUs ou versions de runtime.
• Arêtes descriptives étiquetant les relations, comme "HTTPS requests", "SQL connection" ou "Blob/Queue access".

Le diagramme généré est un code Mermaid standard, compatible avec le markdown GitHub, de nombreux générateurs de documentation et divers outils d’aperçu de diagrammes.

Étape 4 : Construire le rapport d’architecture en markdown

Utilisez assets/template-architecture.md comme point de départ pour créer un rapport structuré pour chaque groupe de ressources :

• Renseignez l’en-tête avec l’abonnement, la région, le nombre de ressources et la date de génération.
• Rédigez une courte vue d’ensemble décrivant la solution, son objectif et ses composants critiques.
• Complétez le tableau Resource Inventory avec noms, types, SKUs, emplacements et notes sur les ressources.
• Collez le diagramme Mermaid généré dans la section Architecture Diagram.
• Ajoutez des descriptions Network Architecture, Data Flow, Identity & Access et Dependencies en fonction des relations découvertes.
• Consignez des Notes & Recommendations pour les améliorations futures ou les risques identifiés.

Vous obtenez ainsi un modèle de reporting reproductible, utilisable à travers plusieurs équipes ou abonnements.

Exemples de cas d’usage

• Onboarding d’un nouveau membre d’équipe – Exécutez azure-resource-visualizer sur les groupes de ressources de production clés et partagez le markdown généré pour permettre aux nouveaux arrivants de comprendre rapidement l’architecture.
• Revue avant changement – Diagrammez un groupe de ressources avant des modifications d’infrastructure afin de visualiser les dépendances et le périmètre d’impact potentiel.
• Mise à jour de la documentation d’architecture – Réexécutez régulièrement la skill, mettez à jour les diagrammes et inventaires, et gardez votre documentation alignée sur l’environnement réel.

FAQ

azure-resource-visualizer déploie-t-il ou modifie-t-il des ressources Azure ?

Non. azure-resource-visualizer se concentre sur l’analyse, la visualisation et la documentation. Il examine vos ressources Azure existantes à l’aide d’outils de requête comme az et Azure Resource Graph, puis produit des diagrammes Mermaid et du markdown. Il ne crée, ne met à jour ni ne supprime aucune ressource.

De quels outils azure-resource-visualizer dépend-il ?

La skill est conçue pour fonctionner en complément des outils Azure existants plutôt que de les remplacer. Dans l’usage courant, elle s’appuie sur :

• Azure CLI (az) pour lister groupes de ressources et ressources.
• Optionnellement, Azure Resource Graph (az graph query) pour des requêtes rapides multi-abonnements, comme illustré dans references/azure-resource-graph.md.

Votre configuration exacte peut varier selon la façon dont votre agent ou vos workflows sont câblés, mais vous devez prévoir d’avoir az installé et authentifié.

azure-resource-visualizer fonctionne-t-il sur plusieurs abonnements ?

Oui, si votre environnement et vos requêtes sont configurés pour la découverte multi-abonnements. Avec Azure Resource Graph, vous pouvez interroger des ressources à travers plusieurs abonnements, puis restreindre l’analyse à un groupe de ressources ou un ensemble de groupes. La skill se concentre sur les groupes de ressources que vous choisissez, quel que soit l’abonnement.

Quel type de diagrammes azure-resource-visualizer produit-il ?

azure-resource-visualizer produit des diagrammes d’architecture basés sur Mermaid. Ces diagrammes :

• Utilisent des sections subgraph par couche (Network, Compute, Data, Security & Identity).
• Incluent des nœuds annotés avec des propriétés clés (comme les plages d’adresses des VNets, les SKUs, les runtimes).
• Montrent des arêtes directionnelles avec du texte décrivant les interactions entre composants.

La sortie est du code Mermaid standard que vous pouvez intégrer directement dans des fichiers markdown, des READMEs GitHub ou des sites de documentation compatibles Mermaid.

Puis-je personnaliser la documentation générée ?

Oui. Le fichier assets/template-architecture.md est volontairement fourni comme modèle. Vous pouvez :

• Adapter les sections (ajout ou suppression de tableaux, titres ou sections de notes).
• Standardiser le langage et les formats pour votre organisation.
• Utiliser le modèle comme base pour une génération automatisée par votre agent ou vos scripts.

L’objectif de la skill est de proposer une structure cohérente ; la manière dont vous l’adaptez à vos processus vous appartient.

azure-resource-visualizer est-il adapté aux très petits environnements de test ?

La skill peut s’appliquer à tout groupe de ressources, quelle que soit sa taille, mais elle offre le plus de valeur lorsqu’il y a suffisamment de ressources et de relations pour que le diagramme manuel devienne fastidieux. Pour une seule VM de test ou une démo minimaliste, la surcharge peut ne pas se justifier. Pour des applications multi-couches, des services partagés et des topologies réseau complexes, elle devient nettement plus utile.

À quelle fréquence dois-je exécuter azure-resource-visualizer ?

Exécutez-la dès que vous avez besoin d’une vue fiable de votre environnement :

• Après des changements d’infrastructure significatifs.
• Avant des revues d’architecture ou des audits.
• Selon une cadence définie (par exemple mensuelle ou trimestrielle) pour garder la documentation synchronisée.

Comme la skill est en lecture seule et s’appuie sur des requêtes, il est sûr de la relancer aussi souvent que nécessaire.

Où puis-je voir des exemples concrets de sortie ?

Dans le répertoire de la skill :

• assets/example-diagram.md contient un exemple complet de diagramme d’architecture Mermaid avec couches et relations annotées.
• assets/template-architecture.md montre comment structurer un rapport d’architecture complet autour de ce diagramme.

Consulter ces fichiers est le moyen le plus rapide de comprendre ce que azure-resource-visualizer peut produire pour vos propres groupes de ressources Azure.