AzureMap

Tool for generating plantuml diagrams from Azure resources.

AzureMap has two modes:

• Console mode
• Action mode

Console mode

az login --use-device-code

or set the following env variables

• AZURE_TENANT_ID
• AZURE_CLIENT_ID
• AZURE_CLIENT_SECRET

Required env variable

• AZURE_SUBSCRIPTION_ID

Example

node ./lib/index.mjs

Action mode

This action requires a valid user for accessing the Azure API. It supports two modes:

1. Execute the Azure/login action before running this action or
2. Set the following env variables for the task:
   • AZURE_TENANT_ID
   • AZURE_CLIENT_ID
   • AZURE_CLIENT_SECRET

The action will produce a build artifact (zip file) named diagrams containing a puml and png file.

Arguments

Argument	Required	Description
subscription	✓	azure subscription id

name: 'example'
on:
  push:
    branches:    
      - '**'
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Tool for generating plantuml diagrams from Azure resources.
        uses: localgod/[email protected]
        with:
          subscription: ${{ env.AZURE_SUBSCRIPTION_ID }}
      - name: Store Artifact
        uses: actions/upload-artifact@v3
        with:
          name: diagrams
          path: |
            AzureMap

Build

npm install
npm run build

Develop

npm install
npm run dev