From fe7d908522e045c10129450f8529b213af0c0e80 Mon Sep 17 00:00:00 2001 From: cmendible <266546+cmendible@users.noreply.github.com> Date: Fri, 13 Oct 2023 10:39:14 +0200 Subject: [PATCH] Usage section --- docs/content/en/docs/Install/_index.md | 14 +++--- docs/content/en/docs/Overview/_index.md | 62 ------------------------- docs/content/en/docs/Usage/_index.md | 47 +++++++++++++++++++ 3 files changed, 54 insertions(+), 69 deletions(-) create mode 100644 docs/content/en/docs/Usage/_index.md diff --git a/docs/content/en/docs/Install/_index.md b/docs/content/en/docs/Install/_index.md index f0a7d15b..92d11f92 100644 --- a/docs/content/en/docs/Install/_index.md +++ b/docs/content/en/docs/Install/_index.md @@ -4,7 +4,7 @@ weight: 2 description: Learn how to install Azure Quick Review (azqr) --- -### Install on Linux or Azure Cloud Shell +## Install on Linux or Azure Cloud Shell ```bash latest_azqr=$(curl -sL https://api.github.com/repos/Azure/azqr/releases/latest | jq -r ".tag_name" | cut -c1-) @@ -12,12 +12,12 @@ wget https://github.com/Azure/azqr/releases/download/$latest_azqr/azqr-ubuntu-la chmod +x azqr ``` -### Install on Mac - -Download the latest release from [here](https://github.com/Azure/azqr/releases). - -### Install on Windows +## Install on Windows ```console winget install azqr -``` \ No newline at end of file +``` + +## Install on Mac + +Download the latest release from [here](https://github.com/Azure/azqr/releases). \ No newline at end of file diff --git a/docs/content/en/docs/Overview/_index.md b/docs/content/en/docs/Overview/_index.md index 90e5b97a..2cfcf108 100644 --- a/docs/content/en/docs/Overview/_index.md +++ b/docs/content/en/docs/Overview/_index.md @@ -71,68 +71,6 @@ To learn more about the rules used by **Azure Quick Review (azqr)** for generati * Azure Virtual WAN * Azure Web PubSub -## Usage - -### Install on Linux or Azure Cloud Shell - -```bash -latest_azqr=$(curl -sL https://api.github.com/repos/Azure/azqr/releases/latest | jq -r ".tag_name" | cut -c1-) -wget https://github.com/Azure/azqr/releases/download/$latest_azqr/azqr-ubuntu-latest-amd64 -O azqr -chmod +x azqr -``` - -### Install on Mac - -Download the latest release from [here](https://github.com/Azure/azqr/releases). - -### Install on Windows - -```console -winget install azqr -``` - -### Authentication - -**Azure Quick Review (azqr)** supports the following authentication methods: - -* Azure CLI -* Service Principal. You'll need to set the following environment variables: - * AZURE_CLIENT_ID - * AZURE_CLIENT_SECRET - * AZURE_TENANT_ID - -### Authorization - -**Azure Quick Review (azqr)** requires the following permissions: - -* Subscription Reader - -### Running the Scan - -To scan all resource groups in all subscription run: - -```bash -./azqr scan -``` - -To scan all resource groups in a specific subscription run: - -```bash -./azqr scan -s -``` - -To scan a specific resource group in a specific subscription run: - -```bash -./azqr scan -s -g -``` - -For information on available commands and help run: - -```bash -./azqr -h -``` - ## Code of Conduct This project has adopted the [Microsoft Open Source Code of Conduct](CODE_OF_CONDUCT.md) diff --git a/docs/content/en/docs/Usage/_index.md b/docs/content/en/docs/Usage/_index.md new file mode 100644 index 00000000..d2a9ba03 --- /dev/null +++ b/docs/content/en/docs/Usage/_index.md @@ -0,0 +1,47 @@ +--- +title: Usage +description: Use Azure Quick Review — to analyze Azure resources and identify whether they comply with Azure's best practices and recommendations. +weight: 1 +--- + +## Authentication + +**Azure Quick Review (azqr)** supports the following authentication methods: + +* Azure CLI +* Service Principal. You'll need to set the following environment variables: + * AZURE_CLIENT_ID + * AZURE_CLIENT_SECRET + * AZURE_TENANT_ID + +## Authorization + +**Azure Quick Review (azqr)** requires the following permissions: + +* Subscription Reader + +## Running the Scan + +To scan all resource groups in all subscription run: + +```bash +./azqr scan +``` + +To scan all resource groups in a specific subscription run: + +```bash +./azqr scan -s +``` + +To scan a specific resource group in a specific subscription run: + +```bash +./azqr scan -s -g +``` + +For information on available commands and help run: + +```bash +./azqr -h +```