FIX: Updated markdown per requests

docs/content/tools/collector/_index.md

@@ -1,18 +1,18 @@
 ---
-title: Well-Architected Reliability Assessment (WARA) v2 collector script
+title: Well-Architected Reliability Assessment (WARA) collector script
 weight: 10
 geekdocCollapseSection: false
 ---
 
 {{< toc >}}
 
-# Well-Architected Reliability Assessment (WARA) v2 Collector Script
+# Well-Architected Reliability Assessment (WARA) Collector Script
 
 ## Synopsis
-Well-Architected Reliability Assessment (WARA) v2 collector script
+Well-Architected Reliability Assessment (WARA) collector script
 
 ## Description
-This script is used to collect data from Azure subscriptions to be used in the Well-Architected Reliability Assessment (WARA) v2. The script collects data from the subscriptions, resource groups, and resources, and then runs resource graph queries (Kusto/KQL) to extract information about the resources. The script also collects information about outages, support tickets, advisor recommendations, service retirements, and service health alerts. The collected data is then used to generate a JSON file with recommendations for improving the reliability of the resources. Typically, this JSON file is used as an input for the WARA v2 data analyzer script (2_wara_data_analyzer.ps1).
+This script is used to collect data from Azure subscriptions to be used in the Well-Architected Reliability Assessment (WARA). The script collects data from the subscriptions, resource groups, and resources, and then runs resource graph queries (Kusto/KQL) to extract information about the resources. The script also collects information about outages, support tickets, advisor recommendations, service retirements, and service health alerts. The collected data is then used to generate a JSON file with recommendations for improving the reliability of the resources. Typically, this JSON file is used as an input for the WARA data analyzer script (2_wara_data_analyzer.ps1).
 
 By default, the script executes all relevant checks in the Azure Proactive Resiliency Library v2 but it can also be configured to run checks against specific groups of resources using a runbook (`-RunbookFile`).
 
@@ -41,6 +41,9 @@ $iswindows ? (unblock-file ./1_wara_collector.ps1) : (Write-host "Unblock not re
 ### Cloud Shell
 ![Alt text](quickstartexample_cloudshell.gif)
 
+- [GitHub Link to Download](https://github.com/Azure/Azure-Proactive-Resiliency-Library-v2/blob/main/tools/1_wara_collector.ps1)
+- [GitHub Link to Sample Output](https://github.com/Azure/Azure-Proactive-Resiliency-Library-v2/blob/main/tools/sample-output/WARA_File_2024-05-07_11_59.json)
+
 ## Filtering
 The filtering capabilities are designed for targeting specific Azure resources, enabling precise and flexible reliability assessments. The scope of the feature includes functionalities that allow users to define the scope and tags and criteria of their reliability checks using parameters or text files.
 
@@ -58,7 +61,41 @@ The filtering capabilities are designed for targeting specific Azure resources,
 - If you set a subscription filter for `subscription1` and you also set a resource group filter for `subscription1/resourcegroups/rg-demo1` your results will contain **all** of the resources in `subscription1`
   - This is because we specified `subscription1` and so all of `subscription1` will be evaluated. If we only wanted to evaluate `subscription1/resourcegroups/rg-demo1` then we would include that resource group as a filter and not the full subscription.
 - If you set a subscription filter for `subscription2` and a resourcegroup filter for `subscription1/resourcegroups/rg-demo1` you will evaluate all of `subscription2` and only the resource group `rg-demo-1`.
-- If you set a subscription filter for `subscription3`, a resourcegroup filter for `subscription1/resourcegroups/rg-demo1` and a tag filter for `env==prod` then you will **only return resources or resources that are in resource groups tagged with env==prod** within the scope of the evaluation which is `subscription3` and `subscription1/resourcegroups/rg-demo1`.
+- Setting a subscription filter for `subscription3`, a resource group filter for `subscription1/resourcegroups/rg-demo1`, and a tag filter for `env==prod` will return **only resources or those in resource groups tagged with env==prod within subscription3 and subscription1/resourcegroups/rg-demo1.**
+
+### Tagging Format
+For the WARA script tags are case insensitive.
+
+Tags provided to the WARA script can be broken into two distinct types:
+- == Equals
+- =/ Not Equals
+
+These tags can be further broken down into their Key:Value pairs and allow for the following logical operands:
+- || or
+
+This allows you to build logical tag filtering:
+- The following example shows where the tag name can be App or Application and the value attributed to these tag names must be App1 or App2. In addition, a new entry acts as an **AND** operator. So the first line must be true, so must the second line where we state that the tag name can be env or environment and the value can be prod or production. Finally, we say the tag name region must equal the tag value useast. Only when all of these criteria are met would a resource become included in the output file.
+```text
+[tags]
+App||Application==App1||App2
+env||environment==prod||production
+region==useast
+```
+In PowerShell this looks like:
+```powershell
+-tags "App||Application==App1||App2","env||environment==prod||production","region==useast"
+```
+- Our next example will demonstrate how we can filter using a **NOT** operator. This will return all resources in scope, except those that meet the requirements of app or application not equalling App3, env or environment not equalling dev or qa, and the region not equalling uswest.
+```text
+[tags]
+App||Application=/App3
+env|environment=/dev||qa
+region=/uswest
+```
+In PowerShell this looks like:
+```powershell
+-tags "App||Application=/App3","env|environment=/dev||qa","region=/uswest"
+```
 
 
 # Examples for Well-Architected Reliability Assessment (WARA) v2 Collector Script
@@ -112,49 +149,60 @@ application==demoapp1
 ### Debugging
 - **Type**: Switch
 - **Description**: Enables debugging output.
+- *Optional*
 
 ### SAP
 - **Type**: Switch
 - **Description**: Enables recommendations and queries for the SAP specialized workload.
+- *Optional*
 
 ### AVD
 - **Type**: Switch
 - **Description**: Enables recommendations and queries for the AVD specialized workload.
+- *Optional*
 
 ### AVS
 - **Type**: Switch
 - **Description**: Enables recommendations and queries for the AVS specialized workload.
+- *Optional*
 
 ### HPC
 - **Type**: Switch
 - **Description**: Enables recommendations and queries for the HPC specialized workload.
+- *Optional*
 
 ### SubscriptionIds
 - **Type**: String Array
 - **Description**: Specifies the subscription IDs to be included in the review. Multiple subscription IDs should be separated by commas. Subscription IDs must be in either GUID form (e.g., `00000000-0000-0000-0000-000000000000`) or full subscription ID form (e.g., `/subscriptions/00000000-0000-0000-0000-000000000000`).
+- *Optional*
 - **Note**: Can't be used in combination with `-ConfigFile` parameter.
 
 ### ResourceGroups
 - **Type**: String Array
 - **Description**: Specifies the resource groups to be included in the review. Multiple resource groups should be separated by commas. Resource groups must be in full resource group ID form (e.g., `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1`).
+- *Optional*
 - **Note**: Can't be used in combination with `-ConfigFile` or `-RunbookFile` parameters.
 
 ### Tags
 - **Type**: String
 - **Description**: Specifies the tags to be used to filter resources.
 - **Note**: Can't be used in combination with `-ConfigFile` or `-RunbookFile` parameters.
+- *Optional*
 
 ### TenantID
 - **Type**: String
 - **Description**: Specifies the Entra tenant ID to be used to authenticate to Azure.
+- *Required*
 
 ### AzureEnvironment
 - **Type**: String
 - **Description**: Specifies the Azure environment to be used. Valid values are `AzureCloud` and `AzureUSGovernment`. Default value is `AzureCloud`.
+- *Optional*
 
 ### ConfigFile
 - **Type**: String
 - **Description**: Specifies the configuration file to be used.
+- *Optional*
 - **Note**: Can't be used in combination with `-RunbookFile`, `-SubscriptionIds`, `-ResourceGroups`, or `-Tags` parameters.
 
 ### RunbookFile
@@ -164,8 +212,10 @@ application==demoapp1
   - The selectors section identifies groups of Azure resources that specific checks will be run against. Selectors can be any valid KQL predicate (e.g., `resourceGroup =~ 'rg1'`).
   - The checks section maps resource graph queries (identified by GUIDs) to specific selectors.
   - The query_overrides section enables catalogs of specialized resource graph queries to be included in the review.
+  - *Optional*
 - **Note**: Can't be used in combination with `-ConfigFile`, `-ResourceGroups`, or `-Tags` parameters. Specify subscriptions in scope using `-SubscriptionIds` parameter.
 
 ### UseImplicitRunbookSelectors
 - **Type**: Switch
 - **Description**: Enables the use of implicit runbook selectors. When this switch is enabled, each resource graph query will be wrapped in an inner join that filters the results to only include resources that match the selector. This is useful when queries do not include selectors.
+- *Optional*