Diagrams

azdocs diagram --type hierarchy|resources|network|vnets|resource-groups|workbook \
    [--format drawio|mermaid|both|svg|png|all] \
    [--subscription <id>] [--resource-group <name>] [--out <path>]

Diagrams exported here are drawn at full detail — every resource gets its own icon and name, using a natural 1400px working width. The same graphs embedded in a report are summarised instead: resources aggregated by type (Storage Account ×13) at a fixed A4 text-column width. Height follows the content within the page budget; the page-fraction label describes that height rather than adding padding to reach a fixed fraction. See Diagram standards for the full contract.

hierarchy, resources, and network write one file (output/azdocs-<type>.<ext>). The fan-out types write one file per scope under output/diagrams/vnets/ and output/diagrams/resource-groups/ (--out names the directory instead). The workbook writes output/azdocs-workbook.drawio — or, for svg/png, one file per sheet under output/diagrams/workbook/, since a raster cannot hold multiple sheets.

The desktop’s Draw.io Diagram Workbook uses the same workbook output name under the directory you choose. Other diagram types and image formats are available through the CLI.

A network diagram is shaped like this (this is actual azdocs Mermaid output style — GitHub renders it natively):

flowchart LR
    subgraph vnet_hub["vnet-hub<br/><i>10.0.0.0/16</i>"]
        subgraph snet_shared["shared<br/><i>10.0.1.0/24</i>"]
            vm1["vm-app-01<br/><i>Virtual Machine</i>"]
        end
    end
    subgraph vnet_app["vnet-app<br/><i>10.1.0.0/16</i>"]
        subgraph snet_app["app<br/><i>10.1.0.0/24</i>"]
            pe["pe-sql<br/><i>Private Endpoint</i>"]
        end
    end
    subgraph connected["Connected services"]
        sql["sql-prod<br/><i>SQL Server</i>"]
        nsg["nsg-app<br/><i>NSG</i>"]
    end
    vnet_hub -.-|Connected| vnet_app
    pe -.-|private link| sql
    nsg -.- snet_shared

Use --tenant <reference-or-tenant-id> to select the estate. Explicit snapshot IDs remain usable offline without credentials; a supplied tenant selection enforces ownership. See tenant history.

Formats

• .drawio — editable in draw.io or the VS Code draw.io extension. Uses the azure2 icon set, swimlane containers, and orthogonal boundary-anchored connectors. This is the workbook format that keeps all sheets in one editable file. SVG/PNG workbook exports write a separate image per sheet.
• .mmd — Mermaid text. Paste into any GitHub markdown file, wiki, or docs site and it renders. Not available for workbook — use vnets / resource-groups for per-scope Mermaid.
• .svg — standalone vector render (shared layout with drawio). Also embedded in the HTML docs site (output/docs-html/diagrams/).
• .png — the SVG rasterised at 2× via resvg; needs no browser or external tool. SVG/PNG diagrams use the Microsoft Azure icon set embedded in the binary (mapping in data/icon_mapping.toml; unmapped types get the generic resource icon).

Scoping

Estate-wide diagrams stop being useful past a certain size — over ~150 nodes azdocs warns and suggests narrowing:

azdocs diagram --type network --subscription <id>
azdocs diagram --type resources --subscription <id> --resource-group rg-app
azdocs diagram --type vnets --format png            # one PNG per VNet
azdocs diagram --type workbook                      # everything, one drawio file

Next: The TUI