azca

config-analyzer

Azure Configuration Analyzer

Overview

azca is a console app that evaluates rules against an Azure configuration to perform semantic analysis. It is capable of analyzing complex configurations that span multiple resources and helps developers with remediation by providing direct links to product documentation.

• Rule types:
  • ARM Template
  • Resource Graph

Usage

$ npm install -g azca
$ azca COMMAND
running command...
$ azca (-v|--version|version)
azca/0.0.9 win32-x64 node-v14.15.4
$ azca --help [COMMAND]
USAGE
  $ azca COMMAND
...

$ npm install -g azca
$ azca COMMAND
running command...
$ azca (-v|--version|version)
azca/0.0.0 linux-x64 node-v14.15.5
$ azca --help [COMMAND]
USAGE
  $ azca COMMAND
...

Commands

• azca scan
• azca scan:arm
• azca scan:rg

azca scan

Command to scan Azure Resources for potential configuration issues

USAGE
  $ azca scan

OPTIONS
  -d, --debug      prints debugging logs
  -f, --file=file  JSON rules file path
  -v, --verbose    prints all results

EXAMPLE
  $ azca scan:rg --subscription <subscriptionId>
  $ azca scan:arm --subscription <subscriptionId> --group <resourceGroupName>

azca scan:arm

Scans exported ARM Templates for potential configuration issues

USAGE
  $ azca scan:arm

OPTIONS
  -d, --debug                      prints debugging logs
  -f, --file=file                  JSON rules file path
  -g, --group=group                Azure resource groups to scan
  -s, --subscription=subscription  Azure subscription id to scan
  -v, --verbose                    prints all results

EXAMPLE
  $ azca scan:arm --subscription <subscriptionId> --group <resourceGroupName>
       [rule-name]
           [✓ | ❌][rule-description]     
           Resources:
                   [resource-ids]

       [total-passing]
       [total-failing]
       [total-rules-scanned]

azca scan:rg

Uses Resource Graph queries to scan Azure resources for potential configuration issues

USAGE
  $ azca scan:rg

OPTIONS
  -d, --debug                      prints debugging logs
  -f, --file=file                  JSON rules file path
  -g, --group=group                Azure resource groups to scan
  -s, --subscription=subscription  (required) Azure subscription id to scan
  -v, --verbose                    prints all results

EXAMPLE
  $ azca scan:rg --subscription <subscriptionId>
       [rule-name]
           [✓ | ❌][rule-description]     
           Resources:
                   [resource-ids]
       [total-passing]
       [total-failing]
       [total-rules-scanned]

• azca scan:arm
• azca scan:rg

azca scan:arm

Scans exported ARM Templates for potential configuration issues

USAGE
  $ azca scan:arm

OPTIONS
  -d, --debug                      prints debugging logs
  -f, --file=file                  JSON rules file path
  -g, --group=group                Azure resource groups to scan
  -s, --subscription=subscription  Azure subscription id to scan
  -v, --verbose                    prints all results

EXAMPLE
  $ azca scan:arm --subscription <subscriptionId> --group <resourceGroupName>
       [rule-name]
           [✓ | ❌][rule-description]     
           Resources:
                   [resource-ids]

       [total-passing]
       [total-failing]
       [total-rules-scanned]

azca scan:rg

Uses Resource Graph queries to scan Azure resources for potential configuration issues

USAGE
  $ azca scan:rg

OPTIONS
  -d, --debug                      prints debugging logs
  -f, --file=file                  JSON rules file path
  -g, --group=group                Azure resource groups to scan
  -s, --subscription=subscription  (required) Azure subscription id to scan
  -v, --verbose                    prints all results

EXAMPLE
  $ azca scan:rg --subscription <subscriptionId>
       [rule-name]
           [✓ | ❌][rule-description]     
           Resources:
                   [resource-ids]
       [total-passing]
       [total-failing]
       [total-rules-scanned]

Development

To run the integration tests:

• Copy .env.template to .env and fill with your desired values
• npm test