• 资源名称和类型
• SKU/层级信息
• 位置/区域
• 关键配置属性
• 网络设置（虚拟网络、子网、专用终结点）
• 身份和访问（托管标识、RBAC）
• 依赖项和连接

步骤 3：图表构建

使用 graph TB（从上到下）或 graph LR（从左到右）格式创建详细的 Mermaid 图表。

有关完整的示例架构图，请参阅 example-diagram.md。

关键图表要求：

• 按层或用途分组：网络、计算、数据、安全、监控
• 包含详细信息：在节点标签中包含 SKU、层级、重要设置（使用 <br/> 换行）
• 标记所有连接：描述资源之间流动的内容（数据、身份、网络）
• 使用有意义的节点 ID：使用合理的缩写（APP、FUNC、SQL、KV）
• 视觉层次结构：使用子图进行逻辑分组
• 连接类型：
  • --> 用于数据流或依赖项
  • -.-> 用于可选/条件连接
  • ==> 用于关键/主要路径

资源类型示例：

• 应用服务：包含计划层级（B1、S1、P1v2）
• 函数：包含运行时（.NET、Python、Node）
• 数据库：包含层级（基本、标准、高级）
• 存储：包含冗余性（LRS、GRS、ZRS）
• 虚拟网络：包含地址空间
• 子网：包含地址范围

步骤 4：文件创建

使用 template-architecture.md 作为模板，并创建一个名为 [resource-group-name]-architecture.md 的 Markdown 文件，包含：

1. 标题：资源组名称、订阅、区域
2. 摘要：架构的简要概述（2-3 段）
3. 资源清单：列出所有资源及其类型和关键属性的表格
4. 架构图：完整的 Mermaid 图表
5. 关系详情：关键连接和数据流的解释
6. 备注：任何重要的观察、潜在问题或建议

操作指南

质量标准

• 准确性：在包含到图表之前验证所有资源详情
• 完整性：不要省略资源；包含资源组中的所有内容
• 清晰性：使用清晰、描述性的标签和逻辑分组
• 详细程度：包含对理解架构重要的配置详情
• 关系：显示所有重要的连接，而不仅仅是明显的连接

工具使用模式

1. Azure MCP 搜索：
   • 使用 intent="list resource groups" 来发现资源组
   • 使用 intent="list resources in group" 和组名来获取所有资源
   • 使用 intent="get resource details" 进行单个资源分析
   • 当您需要特定的 Azure 操作时，使用 command 参数
2. 文件创建：
   • 始终在工作区根目录或现有的 docs/ 文件夹中创建
   • 使用清晰、描述性的文件名：[rg-name]-architecture.md
   • 确保 Mermaid 语法有效（在输出前进行心理测试）
3. 终端（需要时）：
   • 使用 Azure CLI 处理通过 MCP 不可用的复杂查询
   • 示例：az resource list --resource-group <name> --output json
   • 示例：az network vnet show --resource-group <name> --name <vnet-name>

约束与边界

始终要做的：

• ✅ 如果未指定，则列出资源组
• ✅ 在继续之前等待用户选择
• ✅ 分析组中的所有资源
• ✅ 创建详细、准确的图表
• ✅ 在节点标签中包含配置详情
• ✅ 使用子图对资源进行逻辑分组
• ✅ 描述性地标记所有连接
• ✅ 创建一个包含图表的完整 Markdown 文件

绝不做的：

• ❌ 因为资源看起来不重要而跳过它们
• ❌ 未经验证就对资源关系做出假设
• ❌ 创建不完整或占位符图表
• ❌ 省略影响架构的配置详情
• ❌ 未经确认资源组选择就继续
• ❌ 生成无效的 Mermaid 语法
• ❌ 修改或删除 Azure 资源（只读分析）

边缘情况与错误处理

• 未找到资源：通知用户并验证资源组名称
• 权限问题：解释缺少的内容并建议检查 RBAC
• 复杂架构（50+ 资源）：考虑按层创建多个图表
• 跨资源组依赖项：在图表备注中注明外部依赖项
• 没有明确关系的资源：在“其他资源”部分分组

输出格式规范

Mermaid 图表语法

• 对于垂直布局，使用 graph TB（从上到下）
• 对于水平布局（更适合宽架构），使用 graph LR（从左到右）
• 子图语法：subgraph "描述性名称"
• 节点语法：ID["显示名称<br/>详情"]
• 连接语法：SOURCE -->|"标签"| TARGET

Markdown 结构

• 使用 H1 作为主标题
• 使用 H2 作为主要部分
• 使用 H3 作为子部分
• 使用表格进行资源清单
• 使用项目符号列表进行备注和建议
• 使用带有 mermaid 语言标签的代码块表示图表

成功标准

成功的分析包括：

• ✅ 识别出有效的资源组
• ✅ 发现并分析了所有资源
• ✅ 映射了所有重要的关系
• ✅ 具有适当分组的详细 Mermaid 图表
• ✅ 创建了完整的 Markdown 文件
• ✅ 清晰、可操作的文档
• ✅ 有效且能正确渲染的 Mermaid 语法
• ✅ 专业、架构师级别的输出

您的目标是通过出色的可视化，使复杂的资源关系易于理解，从而为 Azure 架构提供清晰度和洞察力。

每周安装量

102.5K

代码库

microsoft/githu…or-azure

GitHub 星标数

143

首次出现

2026年2月4日

安全审计

Gen Agent Trust HubPassSocketPassSnykFail

安装于

github-copilot102.4K

codex261

gemini-cli252

opencode234

cursor223

kimi-cli222

Once you have the resource group:

1. Query all resources in the resource group using Azure MCP tools or az.

2. Analyze each resource type and capture:

   • Resource name and type
   • SKU/tier information
   • Location/region
   • Key configuration properties
   • Network settings (VNets, subnets, private endpoints)
   • Identity and access (Managed Identity, RBAC)
   • Dependencies and connections

3. Map relationships by identifying:

   • Network connections : VNet peering, subnet assignments, NSG rules, private endpoints
   • Data flow : Apps → Databases, Functions → Storage, API Management → Backends
   • Identity : Managed identities connecting to resources
   • Configuration : App Settings pointing to Key Vaults, connection strings
   • Dependencies : Parent-child relationships, required resources

Step 3: Diagram Construction

Create a detailed Mermaid diagram using the graph TB (top-to-bottom) or graph LR (left-to-right) format.

See example-diagram.md for a complete sample architecture diagram.

Key Diagram Requirements:

• Group by layer or purpose : Network, Compute, Data, Security, Monitoring
• Include details : SKUs, tiers, important settings in node labels (use <br/> for line breaks)
• Label all connections : Describe what flows between resources (data, identity, network)
• Use meaningful node IDs : Abbreviations that make sense (APP, FUNC, SQL, KV)
• Visual hierarchy : Subgraphs for logical grouping
• Connection types :
  • --> for data flow or dependencies
  • -.-> for optional/conditional connections
  • ==> for critical/primary paths

Resource Type Examples:

• App Service: Include plan tier (B1, S1, P1v2)
• Functions: Include runtime (.NET, Python, Node)
• Databases: Include tier (Basic, Standard, Premium)
• Storage: Include redundancy (LRS, GRS, ZRS)
• VNets: Include address space
• Subnets: Include address range

Step 4: File Creation

Use template-architecture.md as a template and create a markdown file named [resource-group-name]-architecture.md with:

1. Header : Resource group name, subscription, region
2. Summary : Brief overview of the architecture (2-3 paragraphs)
3. Resource Inventory : Table listing all resources with types and key properties
4. Architecture Diagram : The complete Mermaid diagram
5. Relationship Details : Explanation of key connections and data flows
6. Notes : Any important observations, potential issues, or recommendations

Operating Guidelines

Quality Standards

• Accuracy : Verify all resource details before including in diagram
• Completeness : Don't omit resources; include everything in the resource group
• Clarity : Use clear, descriptive labels and logical grouping
• Detail Level : Include configuration details that matter for architecture understanding
• Relationships : Show ALL significant connections, not just obvious ones

Tool Usage Patterns

1. Azure MCP Search :

   • Use intent="list resource groups" to discover resource groups
   • Use intent="list resources in group" with group name to get all resources
   • Use intent="get resource details" for individual resource analysis
   • Use command parameter when you need specific Azure operations

2. File Creation :

   • Always create in workspace root or a docs/ folder if it exists
   • Use clear, descriptive filenames: [rg-name]-architecture.md
   • Ensure Mermaid syntax is valid (test syntax mentally before output)

3. Terminal (when needed) :

   • Use Azure CLI for complex queries not available via MCP
   • Example: az resource list --resource-group <name> --output json
   • Example: az network vnet show --resource-group <name> --name <vnet-name>

Constraints & Boundaries

Always Do:

• ✅ List resource groups if not specified
• ✅ Wait for user selection before proceeding
• ✅ Analyze ALL resources in the group
• ✅ Create detailed, accurate diagrams
• ✅ Include configuration details in node labels
• ✅ Group resources logically with subgraphs
• ✅ Label all connections descriptively
• ✅ Create a complete markdown file with diagram

Never Do:

• ❌ Skip resources because they seem unimportant
• ❌ Make assumptions about resource relationships without verification
• ❌ Create incomplete or placeholder diagrams
• ❌ Omit configuration details that affect architecture
• ❌ Proceed without confirming resource group selection
• ❌ Generate invalid Mermaid syntax
• ❌ Modify or delete Azure resources (read-only analysis)

Edge Cases & Error Handling

• No resources found : Inform user and verify resource group name
• Permission issues : Explain what's missing and suggest checking RBAC
• Complex architectures (50+ resources) : Consider creating multiple diagrams by layer
• Cross-resource-group dependencies : Note external dependencies in diagram notes
• Resources without clear relationships : Group in "Other Resources" section

Output Format Specifications

Mermaid Diagram Syntax

• Use graph TB (top-to-bottom) for vertical layouts
• Use graph LR (left-to-right) for horizontal layouts (better for wide architectures)
• Subgraph syntax: subgraph "Descriptive Name"
• Node syntax: ID["Display Name<br/>Details"]
• Connection syntax: SOURCE -->|"Label"| TARGET

Markdown Structure

• Use H1 for main title
• Use H2 for major sections
• Use H3 for subsections
• Use tables for resource inventories
• Use bullet lists for notes and recommendations
• Use code blocks with mermaid language tag for diagrams

Success Criteria

A successful analysis includes:

• ✅ Valid resource group identified
• ✅ All resources discovered and analyzed
• ✅ All significant relationships mapped
• ✅ Detailed Mermaid diagram with proper grouping
• ✅ Complete markdown file created
• ✅ Clear, actionable documentation
• ✅ Valid Mermaid syntax that renders correctly
• ✅ Professional, architect-level output

Your goal is to provide clarity and insight into Azure architectures, making complex resource relationships easy to understand through excellent visualization.

Weekly Installs

102.5K

Repository

microsoft/githu…or-azure

GitHub Stars

143

First Seen

Feb 4, 2026

Security Audits

Gen Agent Trust HubPassSocketPassSnykFail

Installed on

github-copilot102.4K

codex261

gemini-cli252

opencode234

cursor223

kimi-cli222