You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: jumpstart_drops/azqr-tutorial/_index.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ Welcome to the Azure Quick Review Tutorial: a comprehensive guide on how to inst
4
4
5
5
## Table of Contents
6
6
7
-
-[Installation](#installing-azure-quick-review): Step-by-step instructions for installing Azure Quick Review on various operating systems.
8
-
-[Usage](#usage-of-azure-quick-review): Detailed guide on how to use Azure Quick Review after installation, including running scans and filtering recommendations.
9
-
-[Examples](#scenario-scanning-all-resources-in-a-subscription): Practical examples demonstrating how to use Azure Quick Review effectively with sample commands and expected outputs.
7
+
-[Installation](#installing-azure-quick-review) Step-by-step instructions for installing Azure Quick Review on various operating systems.
8
+
-[Usage](#azure-quick-review-usage) Detailed guide on how to use Azure Quick Review after installation, including running scans and filtering recommendations.
9
+
-[Examples](#scenario-scanning-all-resources-in-a-subscription) Practical examples demonstrating how to use Azure Quick Review effectively with sample commands and expected outputs.
10
10
11
11
## Purpose
12
12
@@ -85,9 +85,7 @@ After installation, you can verify that Azure Quick Review is installed correctl
85
85
86
86
This command should display the help information for Azure Quick Review, confirming that the installation was successful.
87
87
88
-
# Usage of Azure Quick Review
89
-
90
-
## Running Azure Quick Review
88
+
## Azure Quick Review Usage
91
89
92
90
After installing Azure Quick Review, you can start using it to scan your Azure resources. Here are the basic commands to run scans:
93
91
@@ -196,20 +194,20 @@ For more information on available commands and help, run:
196
194
197
195
This command will provide you with a list of all available options and their descriptions.
198
196
199
-
# Example Scenario for Using Azure Quick Review
197
+
## Example Scenario for Using Azure Quick Review
200
198
201
199
This document provides an example scenario demonstrating how to effectively use Azure Quick Review (azqr) to scan Azure resources for compliance with best practices.
202
200
203
-
## Scenario: Scanning All Resources in a Subscription
201
+
### Scenario: Scanning All Resources in a Subscription
204
202
205
203
In this example, we will scan all resources within a specific Azure subscription to identify any non-compliant configurations.
206
204
207
-
### Prerequisites
205
+
#### Prerequisites
208
206
209
207
- Ensure that Azure Quick Review is installed on your system. Refer to the installation guide in`install.md`for detailed instructions.
210
208
- You must have the necessary permissions to access the Azure subscription you wish to scan.
211
209
212
-
### Step 1: Authentication
210
+
#### Step 1: Authentication
213
211
214
212
Before running the scan, you need to authenticate with Azure. You can use one of the following methods:
215
213
@@ -228,7 +226,7 @@ Before running the scan, you need to authenticate with Azure. You can use one of
228
226
229
227
> **Note**: **azqr** requires Reader permissions over the subscription or management group scope.
230
228
231
-
### Step 2: Run the Scan
229
+
#### Step 2: Run the Scan
232
230
233
231
To scan all resources in your subscription, execute the following command in your terminal:
234
232
@@ -238,15 +236,15 @@ To scan all resources in your subscription, execute the following command in you
238
236
239
237
Replace `<subscription_id>` with your actual Azure subscription ID.
240
238
241
-
### Step 3: Review the Output
239
+
#### Step 3: Review the Output
242
240
243
241
After the scan completes, Azure Quick Review generates an output file (by default in Excel format) containing several sheets:
244
242
245
243
- **Recommendations**: Lists all recommendations and the number of impacted resources.
246
244
- **ImpactedResources**: Details all resources that have issues.
247
245
- **Inventory**: Provides a comprehensive list of all scanned resources.
248
246
249
-
### Example Command and Expected Output
247
+
#### Example Command and Expected Output
250
248
251
249
**Command:**
252
250
@@ -257,6 +255,6 @@ After the scan completes, Azure Quick Review generates an output file (by defaul
257
255
**Expected Output:**
258
256
- An Excel file named `azqr_action_plan_YYYY_MM_DD_Thhmmss.xlsx` will be generated in the current directory.
259
257
260
-
### Conclusion
258
+
#### Conclusion
261
259
262
260
This example demonstrates how to use Azure Quick Review to scan an Azure subscription for compliance. For further details on filtering recommendations or troubleshooting, refer to the `usage.md` and `troubleshooting` sections in the documentation.
0 commit comments