Skip to content

ARG script bugfix #1037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erjosito wants to merge 2 commits into
base: main
Choose a base branch
from
Open

ARG script bugfix #1037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2525c4a
bugfix
erjosito Jun 30, 2025
6d261f5
technology to checklist
erjosito Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,15 @@ The script [checklist_graph.sh](./checklist_graph.sh) can do the automated graph
You can download the script in any environment that supports Azure CLI, such as the [Azure Cloud Shell](https://shell.azure.com). In order to download the script and prepare it for execution you can run this command:

```Shell
wget –quiet –output-document ./checklist_graph.sh https://raw.githubusercontent.com/Azure/review-checklists/main/scripts/checklist_graph.sh
chmod +xr ./checklist_graph.sh
wget https://raw.githubusercontent.com/Azure/review-checklists/main/scripts/checklist_graph.sh -–quiet --output-document ./checklist_graph.sh && chmod +xr ./checklist_graph.sh
```

### Basic usage

You can run the script to produce a JSON-formatted output of all the checklist items with documented Azure Resource Graph queries. For example, to run the Azure Resource Graph queries for the AKS checklist:

```Shell
./checklist_graph.sh --technology=aks --format=json > ./graph_results.json
./checklist_graph.sh --checklist=aks --format=json > ./graph_results.json
```

The previous command will generate a JSON file `./graph_results.json`. You can go now to your Excel spreadsheet. Make sure you have loaded up the corresponding checklist already (AKS in this example), and use the Advanced command "Import Graph Results" to import this file into the spreadsheet:
Expand All @@ -45,15 +44,15 @@ The following sections will show more advanced usage of the script.
You can run the script to find out which checklists are available. Note that not all checklists will contain Azure Resource Graph queries:

```
./checklist_graph.sh --list-technologies
./checklist_graph.sh --list-checklists
```

### Listing the existing categories in a checklist

You can run the script as well to generate a more human-readable output. For example, run this in order to execute analysis scoped to a single category. Command:

```
./checklist_graph.sh --techonology=aks --list-categories
./checklist_graph.sh --checklist=aks --list-categories
```

Output:
Expand All @@ -73,7 +72,7 @@ Output:
This example shows how to run this for analysis on all categories in a single subscription. The output can be copy/pasted to the Excel spreadsheet (category by category). Command:

```
./checklist_graph.sh --technology=aks --format=text
./checklist_graph.sh --checklist=aks --format=text
```

Output (truncated for brevity). Note that the resources are formatted with the syntax `<resource-group>/<resource-name>`:
Expand All @@ -93,7 +92,7 @@ CHECKLIST ITEM: Use managed identities instead of Service Principals:
All previous commands can be scoped to a management group, instead of to a single subscription by using the `--management-group` flag, to specify a management group name (make sure to specify the **name** and not the **display name** of the management group). Example:

```
./checklist_graph.sh --technology=aks --category=1 --management-group=mymgmtgroup
./checklist_graph.sh --checklist=aks --category=1 --management-group=mymgmtgroup
```

The output is the same as the previous examples, depending on which flags are used.
Expand All @@ -103,7 +102,7 @@ The output is the same as the previous examples, depending on which flags are us
To troubleshoot the execution of the `checklist_graph.sh` script you can run the command:

```
./checklist_graph.sh --technology=aks --format=json --debug
./checklist_graph.sh --checklist=aks --format=json --debug
```

and check the debug messages being written in the Azure Cloud Shell console
20 changes: 10 additions & 10 deletions scripts/checklist_graph.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
# -d/--debug: increase verbosity
#
# Example:
# ./checklist_graph.sh --list-technologies
# ./checklist_graph.sh --technology=aks --list-categories
# ./checklist_graph.sh --technology=aks --category=0 --format=text
# ./checklist_graph.sh --technology=aks --format=json >graph_results.json
# ./checklist_graph.sh --list-checklists
# ./checklist_graph.sh --checklist=aks --list-categories
# ./checklist_graph.sh --checklist=aks --category=0 --format=text
# ./checklist_graph.sh --checklist=aks --format=json >graph_results.json
#
# Jose Moreno, October 2021
###################################################################################################
Expand Down Expand Up @@ -57,15 +57,15 @@ do
base_url="${i#*=}"
shift # past argument=value
;;
-t=*|--technology=*)
-t=*|--technology=*|--checklist=*)
technology="${i#*=}"
shift # past argument=value
;;
-l*|--list-categories*)
list_categories="yes"
shift # past argument with no value
;;
-t*|--list-technologies*)
-t*|--list-technologies*|--list-checklists*)
list_technologies="yes"
shift # past argument with no value
;;
Expand Down Expand Up @@ -109,10 +109,10 @@ if [[ "$help" == "yes" ]]
then
script_name="$0"
echo "Please run this script as:
$script_name [--list-technologies] [--base-url=<base_url>] [--debug]
$script_name [--list-categories] [--base-url=<base_url>] [--technology=<technology>] [--debug]
$script_name [--technology=<technology>] [--category=<category_id>] [--format=json|text] [--management-group=<mgmt_group>] [--base-url=<base_url>] [--debug]
$script_name [--technology=<technology>] [--category=<category_id>] [--file=<json_file_path>] [--format=json|text] [--management-group=<mgmt_group>] [--base-url=<base_url>] [--debug]"
$script_name [--list-checklists] [--base-url=<base_url>] [--debug]
$script_name [--list-categories] [--base-url=<base_url>] [--checklist=<checklist>] [--debug]
$script_name [--checklist=<checklist>] [--category=<category_id>] [--format=json|text] [--management-group=<mgmt_group>] [--base-url=<base_url>] [--debug]
$script_name [--checklist=<checklist>] [--category=<category_id>] [--file=<json_file_path>] [--format=json|text] [--management-group=<mgmt_group>] [--base-url=<base_url>] [--debug]"
exit
fi

Expand Down
Loading