azure-resource-visualizer

Überblick

Was ist azure-resource-visualizer?

azure-resource-visualizer ist ein auf Azure fokussiertes Visualisierungs-Skill, das deine Azure Resource Groups untersucht und daraus klare, gut lesbare Architekturdokumentation erzeugt. Es inspiziert die Ressourcen, ihre Konfigurationen und ihre Beziehungen und generiert daraus detaillierte Mermaid-Diagramme und Markdown-Dateien, die deine Cloud-Topologie beschreiben.

Anstatt mühsam von Hand zusammenzusuchen, wie Virtual Networks, Subnets, App Services, Datenbanken und Security-Komponenten zusammenspielen, automatisiert azure-resource-visualizer die Erkennung und Diagrammerstellung, sodass du einen aktuellen Überblick über deine Umgebung erhältst.

Zentrale Funktionen

• Resource Group Discovery – Listet Azure Resource Groups auf und hilft bei der Auswahl, wenn keine explizit angegeben ist.
• Detaillierte Ressourcenanalyse – Untersucht Ressourcen, ihre Konfigurationen und Abhängigkeiten innerhalb einer Resource Group.
• Beziehungs-Mapping – Identifiziert und dokumentiert Verbindungen zwischen Compute-, Netzwerk-, Daten- und Security-Ressourcen.
• Mermaid-Diagrammerzeugung – Gibt umfassende, syntaktisch korrekte Mermaid-Diagramme aus, einsatzbereit für Markdown, Doku-Sites oder Wikis.
• Architekturdokumentation – Generiert Markdown-Seiten mit Inventaren, Zusammenfassungen auf hoher Ebene und eingebetteten Diagrammen.

Für wen ist dieses Skill gedacht?

Nutze azure-resource-visualizer, wenn du:

• Cloud-Architekt bist und schnell visuelle Architekturdiagramme für Reviews und Design-Dokumente benötigst.
• Entwickler oder DevOps Engineer bist und verstehen willst, wie die Services in einer Resource Group verschaltet sind.
• Platform-/Infrastructure Engineer bist und Dokumentation über Subscriptions und Teams hinweg standardisieren möchtest.
• Security- oder Operations Engineer bist und einen klaren Blick auf Netzwerkflüsse und Abhängigkeiten brauchst.

Am besten geeignet ist das Skill, wenn bereits Azure-Ressourcen bereitgestellt sind und du Einblick, Dokumentation oder Onboarding-Material brauchst – weniger, wenn du nur eine Architektur auf dem Papier planst.

Welche Probleme werden gelöst?

• Stundenlanger manueller Aufwand, Azure-Diagramme in Diagramm-Tools zu zeichnen.
• Schwierigkeit, in großen Resource Groups zu verstehen, wie die Ressourcen zusammenhängen.
• Veraltete Architekturdokumentation, die nicht zu den tatsächlich ausgerollten Deployments passt.
• Fehlende, konsistente und reviewbare Markdown-Dokumentation für einzelne Resource Groups.

Wann azure-resource-visualizer passt – und wann nicht

Gut geeignet, wenn:

• Du Datenvisualisierung und Reporting über bestehende Azure-Infrastruktur benötigst.
• Du Mermaid-Diagramme in Markdown, Repos oder interne Doku-Portale integrieren willst.
• Du mit Azure Resource Graph oder az arbeitest, um Ressourcendaten abzufragen.

Weniger geeignet, wenn:

• Du ein Tool benötigst, um Azure-Ressourcen zu provisionieren oder zu verändern (dieses Skill dient der Analyse und Visualisierung, nicht dem Deployment).
• Du Kostenanalyse, Performance-Monitoring oder Security-Scans brauchst – das ist nicht im Scope.
• Du keinen Zugriff auf Azure-Subscription-Metadaten hast oder keine az-/Azure Resource Graph-Abfragen ausführen kannst.

Verwendung

Voraussetzungen

Bevor du azure-resource-visualizer verwendest, stelle sicher, dass du Folgendes hast:

• Eine aktive Azure-Subscription mit einer oder mehreren Resource Groups.
• Zugriff und Berechtigungen, um Ressourcen in diesen Subscriptions abzufragen.
• Die Azure CLI (az), installiert und eingeloggt, falls dein Setup auf CLI-basierter Discovery aufsetzt.
• Die Resource Graph CLI Extension, wenn du Azure Resource Graph Abfragen nutzen möchtest:
  • az extension add --name resource-graph

Diese Voraussetzungen ermöglichen es dem Skill (oder dem Agent, der es nutzt), Resource Groups aufzulisten und Ressourcen sowie ihre Beziehungen zu inspizieren.

Installation des azure-resource-visualizer Skills

Um azure-resource-visualizer aus dem Repository microsoft/azure-skills hinzuzufügen, nutze die skills CLI:

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

Damit werden die Skill-Definition und die zugehörigen Assets (Beispiele, Templates und Referenzen) in dein lokales Skills-Setup gezogen, sodass dein Agent oder Workflow das Skill aufrufen kann.

Die enthaltenen Dateien verstehen

Nach der Installation solltest du diese zentralen Dateien und Ordner unter skills/azure-resource-visualizer prüfen:

• SKILL.md – Kernbeschreibung des Skills, seiner Aufgaben und Workflow-Empfehlungen.
• assets/example-diagram.md – Ein vollständiges Beispiel eines Mermaid-Diagramms, das zeigt, wie typische Azure-Ressourcen und Layer dargestellt werden.
• assets/template-architecture.md – Ein Markdown-Template für einen vollständigen Architekturreport inklusive Ressourceninventar und Platzhaltern für Diagrammsektionen.
• references/azure-resource-graph.md – Leitfaden und KQL-Beispiele für die Nutzung von Azure Resource Graph zur großflächigen Ressourcenerkennung.

Diese Dateien zeigen dir, wie „guter“ Output aussieht und wie du deine eigene Architekturdokumentation strukturieren kannst.

Typischer Workflow: Von der Resource Group zum Diagramm

Schritt 1: Resource Group auswählen oder ermitteln

Wenn der Nutzer keinen Namen einer Resource Group angegeben hat, ist der Workflow des Skills so ausgelegt, dass er:

1. Verfügbare Tools (typischerweise az oder Azure Resource Graph) nutzt, um Resource Groups aufzulisten.
2. Eine nummerierte Liste mit Namen und Regionen anzeigt.
3. Den Nutzer fragt, welche Resource Group analysiert werden soll.

Ist eine Resource Group bereits bekannt, kann das Skill die Discovery überspringen und direkt mit der Analyse starten.

Schritt 2: Ressourcen und Beziehungen ermitteln

Sobald eine Resource Group ausgewählt ist, konzentriert sich azure-resource-visualizer auf:

• Auflistung aller Ressourcen in der Gruppe (Typ, Name, Region und relevante Konfiguration wie SKUs).
• Identifikation von Verbindungen zwischen Ressourcen – z. B. welche App Services welche Subnets nutzen, welche Function Apps mit welchen Datenbanken sprechen oder wie Identities auf Key Vault zugreifen.

Dies lässt sich mit Tools wie folgenden umsetzen:

• az-Befehle mit Filterung per --resource-group.
• az graph query mit KQL-Patterns ähnlich denen in references/azure-resource-graph.md.

Schritt 3: Mermaid-Architekturdiagramm erzeugen

Das Skill verwandelt seine Ergebnisse anschließend in ein Mermaid-Diagramm. Das Beispiel in assets/example-diagram.md veranschaulicht den generellen Stil:

• Layered Grouping mit subgraph-Blöcken, zum Beispiel:
  • Network Layer (VNets, Subnets, NSGs)
  • Compute Layer (App Service Plans, App Services, Functions)
  • Data Layer (Datenbanken, Storage)
  • Security & Identity (Key Vault, Managed Identities)
• Detaillierte Node Labels, die wichtige Konfigurationsdetails wie Adressbereiche, SKUs oder Runtime-Versionen anzeigen.
• Beschriftete Kanten, die Beziehungen erläutern, etwa "HTTPS requests", "SQL connection" oder "Blob/Queue access".

Das generierte Diagramm nutzt reguläre Mermaid-Syntax und funktioniert damit in GitHub Markdown, Dokumentationsgeneratoren und vielen Diagramm-Preview-Tools.

Schritt 4: Architekturreport in Markdown erstellen

Nutze assets/template-architecture.md als Ausgangspunkt, um einen strukturierten Report für jede Resource Group zu erstellen:

• Fülle den Header mit Subscription, Region, Ressourcenanzahl und Erstellungsdatum.
• Schreibe eine kurze Übersicht, die die Lösung, ihren Zweck und die wichtigsten Komponenten beschreibt.
• Befülle die Tabelle Resource Inventory mit Ressourcennamen, -typen, SKUs, Regionen und Notizen.
• Füge das generierte Mermaid-Diagramm in den Abschnitt Architecture Diagram ein.
• Ergänze Beschreibungen zur Network Architecture, Data Flow, Identity & Access und Dependencies basierend auf den ermittelten Beziehungen.
• Halte Notes & Recommendations für zukünftige Verbesserungen oder Risiken fest.

So entsteht ein wiederverwendbares Reporting-Muster, das du über mehrere Teams oder Subscriptions hinweg einsetzen kannst.

Beispiel-Szenarien für den Einsatz

• Onboarding eines neuen Teammitglieds – Führe azure-resource-visualizer auf zentralen Produktiv-Resource-Groups aus und teile das generierte Markdown, damit neue Kolleg:innen das Systemlayout schnell verstehen.
• Review vor Änderungen – Erstelle ein Diagramm einer Resource Group, bevor du Infrastrukturänderungen vornimmst, um Abhängigkeiten und möglichen Impact zu erkennen.
• Auffrischung der Architekturdokumentation – Führe das Skill regelmäßig erneut aus, aktualisiere Diagramme und Inventare und halte deine Doku nah an der Live-Umgebung.

FAQ

Deployt oder verändert azure-resource-visualizer Azure-Ressourcen?

Nein. azure-resource-visualizer konzentriert sich auf Analyse, Visualisierung und Dokumentation. Es untersucht deine bestehenden Azure-Ressourcen mit Query-Tools wie az und Azure Resource Graph und erzeugt daraus Mermaid-Diagramme und Markdown. Es erstellt, aktualisiert oder löscht keine Ressourcen.

Von welchen Tools hängt azure-resource-visualizer ab?

Das Skill ist darauf ausgelegt, mit bestehenden Azure-Tools zusammenzuarbeiten, nicht sie zu ersetzen. Typischerweise nutzt es:

• Die Azure CLI (az), um Resource Groups und Ressourcen aufzulisten.
• Optional Azure Resource Graph (az graph query) für schnelle, subscriptionübergreifende Abfragen, wie in references/azure-resource-graph.md gezeigt.

Dein konkretes Setup kann variieren, je nachdem, wie dein Agent oder Workflow angebunden ist. Du solltest aber davon ausgehen, dass az installiert und authentifiziert sein muss.

Kann azure-resource-visualizer mit mehreren Subscriptions arbeiten?

Ja, sofern deine Umgebung und Abfragen auf cross-subscription Discovery ausgelegt sind. Mit Azure Resource Graph kannst du Ressourcen über mehrere Subscriptions hinweg abfragen und die Analyse anschließend auf eine bestimmte Resource Group oder eine Auswahl von Gruppen einschränken. Die Verantwortung des Skills konzentriert sich auf die Resource Groups, die du auswählst – unabhängig von der Subscription.

Welche Art von Diagrammen erzeugt azure-resource-visualizer?

azure-resource-visualizer erzeugt Mermaid-basierte Architekturdiagramme. Diese Diagramme:

• Verwenden geschichtete subgraph-Sektionen (Network, Compute, Data, Security & Identity).
• Enthalten beschriftete Nodes mit Schlüssel-Eigenschaften (z. B. VNet-Adressräume, SKUs, Runtimes).
• Zeigen gerichtete Kanten mit Text, der beschreibt, wie Komponenten interagieren.

Der Output ist regulärer Mermaid-Code, den du direkt in Markdown-Dateien, GitHub READMEs oder Dokumentationsseiten einbetten kannst, die Mermaid unterstützen.

Kann ich die generierte Dokumentation anpassen?

Ja. Die Datei assets/template-architecture.md ist bewusst als Template angelegt. Du kannst:

• Die Sektionen anpassen (Tabellen, Überschriften oder Notizbereiche hinzufügen oder entfernen).
• Sprache und Formatierungen für deine Organisation standardisieren.
• Das Template als Basis für automatisierte Generierung durch deinen Agent oder eigene Skripte nutzen.

Das Ziel des Skills ist eine konsistente Struktur – wie du sie für deine Prozesse adaptierst, liegt bei dir.

Ist azure-resource-visualizer für sehr kleine Testumgebungen geeignet?

Es kann für Resource Groups jeder Größe genutzt werden, entfaltet seinen Mehrwert aber vor allem dann, wenn genügend Ressourcen und Beziehungen vorhanden sind, dass manuelles Diagrammieren mühsam wird. Für eine einzelne Test-VM oder ein Minimal-Demo-Setup ist der Overhead oft nicht nötig. Für mehrschichtige Anwendungen, Shared Services und komplexe Netzwerke wird es dagegen deutlich hilfreicher.

Wie häufig sollte ich azure-resource-visualizer ausführen?

Führe es immer dann aus, wenn du einen verlässlichen Blick auf deine Umgebung brauchst:

• Nach relevanten Infrastrukturänderungen.
• Vor Architektur-Reviews oder Audits.
• In einem regelmäßigen Rhythmus (z. B. monatlich oder quartalsweise), um die Dokumentation synchron zu halten.

Da das Skill read-only arbeitet und auf Query-basierter Discovery beruht, kann es beliebig oft gefahrlos erneut ausgeführt werden.

Wo kann ich konkrete Beispiele für den Output sehen?

Im Skill-Verzeichnis findest du:

• assets/example-diagram.md mit einem vollständig ausgearbeiteten Beispiel eines Mermaid-Architekturdiagramms mit Layern und kommentierten Beziehungen.
• assets/template-architecture.md, das zeigt, wie du einen vollständigen Architekturreport rund um dieses Diagramm strukturieren kannst.

Diese Dateien zu sichten, ist der schnellste Weg, um zu verstehen, was azure-resource-visualizer für deine eigenen Azure Resource Groups erzeugen kann.