Secret ingredients to quality software


Visualizing - Do you have an Azure resources diagram?

Last updated by Bradystroud on 07 Jul 2021 12:42 am (15 days ago) See History

Looking at a long list of Azure resources is not the best way to be introduced to a new project. It is much better to visualize your resources.

You need an architecture diagram, but this is often high level, just outlining the most critical components from the 50,000ft view, often abstracted into logical functions or groups. So, once you have your architecture diagram, the next step is to create your Azure resources diagram.

Option A: Just viewing a list of resources in the Azure portal

Note: When there are a lot of resources this doesn't work.

azure resources
Figure: Bad Example – Using the Azure Portal to view your resources

Option B: Visually viewing the resources

Figure: Good Example – Viewing the resources in VS Code using the ARM Template Viewer extension

ssw rewards resource github
Figure: Good Example - ARM template and automatically generated Azure resources diagram in the SSW Rewards repository on GitHub

sswrewards azure resources new
Figure: Good Example - The Azure resources diagram generated by the ARM Template Viewer extension for SSW Rewards

Suggestion to Microsoft: Add an auto-generated diagram in the Azure portal. Have an option in the combo box (in addition to List View) for Diagram View.

UPDATE: This is now happening.

Scrum Warning: Like the architecture diagram, this is technical debt as it needs to be kept up to date each Sprint. However, unlike the architecture diagram, this one is much easier to maintain as it can be refreshed with a click. You could reduce this technical debt by automatically saving the .png to the same folder as your architecture diagram. It is easy to do this by using Azure Event Grid and Azure Functions to generate these for you when you make changes to your resources.

Adam CoganAdam Cogan
Matt GoldmanMatt Goldman

We open source. This page is on GitHub