Skip to content

Commit

Permalink
Merge pull request Azure#491 from ppascan/dev-alz-pattern-NewDocs
Browse files Browse the repository at this point in the history
Add navigation links to various AMBA-ALZ documentation pages
  • Loading branch information
Brunoga-MS authored Jan 17, 2025
2 parents dea921b + c059ccd commit 9aa1520
Show file tree
Hide file tree
Showing 32 changed files with 206 additions and 4 deletions.
8 changes: 7 additions & 1 deletion docs/content/patterns/alz/Getting-started/Alerts-Details.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ geekdocCollapseSection: true
weight: 30
---

### In this page

> [AMBA-ALZ Pattern Metric Alerts Settings](../Alerts-Details#amba-alz-pattern-metric-alerts-settings) </br>
> [AMBA-ALZ Pattern Activity Log Alerts](../Alerts-Details#amba-alz-pattern-activity-log-alerts) </br>
> [VM Insights Log Alerts](../Alerts-Details#vm-insights-log-alerts) </br>
> [Recovery Vault Alerts](../Alerts-Details#recovery-vault-alerts) </br>
To download specific alerts for the AMBA-ALZ pattern, click the Download icon (highlighted in red below) in the top right corner of the page.

![Alert-Details Download icon](../../media/AlertDetailsDownloadReference.png)
Expand Down Expand Up @@ -67,4 +74,3 @@ Security Alerts and Job Failure alerts are summarized in the "[Using Backup Cent
| PolicyName | Component | Category | Scope | Support for Multiple Resources | Verified | References |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------------------------------------------------------------------------------|----------|--------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Deploy RV Backup Health Monitoring Alerts](../../../services/RecoveryServices/vaults/Modify-RSV-BackupHealth-Alert.json) | Microsoft.RecoveryServices/Vaults | Microsoft.RecoveryServices/vaults/monitoringSettings.classicAlertSettings.alertsForCriticalOperations | Resource | No | Y | [Azure Monitor Alerts for Azure Backup](https://learn.microsoft.com/en-us/azure/backup/backup-azure-monitoring-built-in-monitor?tabs=recovery-services-vaults#azure-monitor-alerts-for-azure-backup) <br> [Move to Azure Monitor Alerts](https://learn.microsoft.com/en-us/azure/backup/move-to-azure-monitor-alerts) |

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ geekdocCollapseSection: true
weight: 20
---

### In this page

> [AMBA-ALZ Monitor Alert Approach](../Monitoring-and-Alerting#amba-alz-monitor-alert-approach) </br>
> [AMBA-ALZ Pattern Monitor Alert Policy Definitions](../Monitoring-and-Alerting#amba-alz-pattern-monitor-alert-policy-definitions) </br>
> [AMBA-ALZ Monitor Alert Processing Rules](../Monitoring-and-Alerting#amba-alz-monitor-alert-processing-rules) </br>
> [Monitoring Backup (Recovery Services Vaults)](../Monitoring-and-Alerting#monitoring-backup-recovery-services-vaults) </br>
## AMBA-ALZ Monitor Alert Approach

The strategy for enabling alerts in the AMBA-ALZ pattern involves using Azure Policy to deploy alerts as resources are created, configuring action groups, and using Alert Processing Rules to activate alerts and link them to the action group.
Expand Down Expand Up @@ -126,4 +133,3 @@ Azure Backup now provides new and improved alerting capabilities via Azure Monit
### Notifications

While alerts are generated by default and cannot be disabled for destructive operations, users have control over the notifications. This allows you to specify the email addresses (or other notification endpoints) to which alerts should be routed. Notifications are configured by an alert processing rule, which is created by default when deploying the AMBA-ALZ pattern.

18 changes: 18 additions & 0 deletions docs/content/patterns/alz/Getting-started/Policy-Initiatives.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ geekdocCollapseSection: true
weight: 40
---

### In this page

> [Overview](../Policy-Initiatives#overview) </br>
> [Connectivity Initiative](../Policy-Initiatives#connectivity-initiative) </br>
> [Management Initiative](../Policy-Initiatives#management-initiative) </br>
> [Identity Initiative](../Policy-Initiatives#identity-initiative) </br>
> [Key Management Initiative](../Policy-Initiatives#key-management-initiative) </br>
> [Load Balancing Initiative](../Policy-Initiatives#load-balancing-initiative) </br>
> [Network Changes Initiative](../Policy-Initiatives#network-changes-initiative) </br>
> [Recovery Services Initiative](../Policy-Initiatives#recovery-services-initiative) </br>
> [Storage Initiative](../Policy-Initiatives#storage-initiative) </br>
> [VM Initiative](../Policy-Initiatives#vm-initiative) </br>
> [Web Initiative](../Policy-Initiatives#web-initiative) </br>
> [Hybrid VM Initiative](../Policy-Initiatives#hybrid-vm-initiative) </br>
> [Service Health Initiative](../Policy-Initiatives#service-health-initiative) </br>
> [Notification Assets Initiative](../Policy-Initiatives#notification-assets-initiative) </br>
> [Landing Zone Initiative (Deprecated)](../Policy-Initiatives#landing-zone-initiative-deprecated) </br>
## Overview

This document details the AMBA-ALZ pattern Azure policy initiatives used for deploying the AMBA-ALZ baselines. For references on individual alerts/policies, refer to [Alert Details](../..//Getting-started//Alerts-Details).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ geekdocCollapseSection: true
weight: 80
---

### In this page

> [Overview](../Bring-your-own-Managed-Identity#overview) </br>
> [How this feature works](../Bring-your-own-Managed-Identity#how-this-feature-works) </br>
## Overview

The ***Bring Your Own User Assigned Managed Identity*** (BYO UAMI) feature, introduced in the [2024-06-05 release](../../Overview/Whats-New#2024-06-05), allows both Greenfield and Brownfield customers to create a new User Assigned Managed Identity (UAMI) during or after the deployment of AMBA-ALZ. Brownfield customers who deployed the ALZ pattern before this feature was available can now configure existing UAMIs by setting a few parameters. This feature enables querying Azure Resource Graph (ARG) using Kusto Query Language and enhances log-based search alerts to include ARG queries for resource tags.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ geekdocCollapseSection: true
weight: 90
---

### In this page

> [Overview](../Bring-your-own-Notifications#overview) </br>
> [How this feature works](../Bring-your-own-Notifications#how-this-feature-works) </br>
## Overview

The ***Bring Your Own Notifications*** (BYON) feature, introduced in the [2024-04-12](../../Overview/Whats-New#2024-04-12) release, enables brownfield customers to utilize their existing Action Groups (AGs) and Alert Processing Rules (APRs) without mandating the use of notification assets deployed by the [Notification Assets](https://raw.githubusercontent.com/Azure/azure-monitor-baseline-alerts/main/patterns/alz/policySetDefinitions/Deploy-Notification-Assets.json) initiative or the [Deploy Service Health Action Group](https://raw.githubusercontent.com/Azure/azure-monitor-baseline-alerts/main/services/Resources/subscriptions/Deploy-ServiceHealth-ActionGroups.json) policy definition in the ALZ pattern. This feature also allows brownfield customers who deployed the ALZ pattern before this feature was available to switch to it.
Expand Down
4 changes: 4 additions & 0 deletions docs/content/patterns/alz/HowTo/Cleaning-up-a-Deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ geekdocCollapseSection: true
weight: 52
---

### In this page

> [Cleanup Script Execution](../Cleaning-up-a-Deployment#cleanup-script-execution) </br>
In some cases, you may need to remove all resources deployed by the AMBA-ALZ solution. The following instructions provide a detailed guide on executing a PowerShell script to delete all deployed resources, including:

- Metric Alerts
Expand Down
6 changes: 6 additions & 0 deletions docs/content/patterns/alz/HowTo/Disabling-Policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ geekdocCollapseSection: true
weight: 60
---

### In this page

> [AlertState Parameter](../Disabling-Policies#alertstate-parameter) </br>
> [PolicyEffect Parameter](../Disabling-Policies#policyeffect-parameter) </br>
> [MonitorDisable Parameter](../Disabling-Policies#monitordisable-parameter) </br>
The AMBA-ALZ pattern provides several methods to enable or disable policy effects.

1. **Parameter: AlertState** - Manages the state of alert rules, allowing deployment in a disabled state or disabling existing alert rules at scale through policy.
Expand Down
5 changes: 5 additions & 0 deletions docs/content/patterns/alz/HowTo/Telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ geekdocCollapseSection: true
weight: 100
---

### In this page

> [Telemetry Tracking Using Customer Usage Attribution (PID)](../Telemetry#telemetry-tracking-using-customer-usage-attribution-(pid)) </br>
> [Module PID Value Mapping](../Telemetry#module-pid-value-mapping) </br>
<!-- markdownlint-disable -->

## Telemetry Tracking Using Customer Usage Attribution (PID)
Expand Down
10 changes: 9 additions & 1 deletion docs/content/patterns/alz/HowTo/Threshold-Override.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ geekdocCollapseSection: true
weight: 70
---

### In this page

> [Overview](../Threshold-Override#overview) </br>
> [How this feature works](../Threshold-Override#how-this-feature-works) </br>
> [Metrics alerts](../Threshold-Override#metrics-alerts) </br>
> [Log-search alerts](../Threshold-Override#log-search-alerts) </br>
> [Which tag do customers need to create](../Threshold-Override#which-tag-do-customers-need-to-create) </br>
## Overview

The ***Alert Threshold Override*** feature, introduced in the [2024-09-05 release](../../Overview/Whats-New#2024-09-05), enables both Greenfield and Brownfield customers to customize alert thresholds for specific resources during or after the deployment of AMBA-ALZ. This feature allows the use of a tag with a specific name and value to override the default alert threshold for designated resources. The new threshold value will apply exclusively to the tagged resources, replacing the global threshold specified in the parameter file.
Expand All @@ -26,7 +34,7 @@ Considering the nature of log-search alerts, where resource information is retri

![Log-search Alerts - Override threshold at work](../../media/LogsearchAlerts-OverrideThresholdAtWork.png)

## Which tag does customers need to create
## Which tag do customers need to create

{{< hint type=Info >}}
For a comprehensive list of resource type friendly names, resource provider namespaces, and recommended abbreviations, refer to [Abbreviation recommendations for Azure resources](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Transitioning from Preview to General Availability (GA)
geekdocCollapseSection: true
weight: 101
---

### In this page

> [Cleanup Script Execution](../Moving-from-preview-to-GA#cleanup-script-execution) </br>
> [Next Steps](../Moving-from-preview-to-GA#next-steps) </br>
To transition from the preview version to the General Availability (GA) version of the ALZ Monitor solution, you must remove all previously deployed resources. Follow these instructions to execute a PowerShell script that deletes the following resources:

- Metric Alerts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ geekdocCollapseSection: true
weight: 100
---

### In this page

> [Update](../Update_to_release_2024-03-01#update) </br>
> [Post update actions](../Update_to_release_2024-03-01#post-update-actions) </br>
## Update

Complete the activities documented in the [Steps to update to the latest release](../#steps-to-update-to-the-latest-release) page.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ geekdocCollapseSection: true
weight: 99
---

### In this page

> [Update](../Update_to_release_2024-04-12#update) </br>
> [Post update actions](../Update_to_release_2024-04-12#post-update-actions) </br>
{{< hint type=Important >}}
**_No post-update action_** is required if you wish to continue using the notification assets deployed by the ALZ pattern.
{{< /hint >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ geekdocCollapseSection: true
weight: 98
---

### In this page

> [Pre update actions](../Update_to_release_2024-06-05#pre-update-actions) </br>
> [Update](../Update_to_release_2024-06-05#update)
{{< hint type=Important >}}
***The parameter file structure has changed to accommodate a new feature coming soon.***
{{< /hint >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ geekdocCollapseSection: true
weight: 97
---

### In this page

> [Pre update actions](../Update_to_release_2024-09-02#pre-update-actions) </br>
> [Update](../Update_to_release_2024-09-02#update) </br>
{{< hint type=Important >}}
***Updating to release [2024-09-02](../../../Overview/Whats-New#2024-09-02) from previous releases involves a breaking change. To proceed with the update, you must remove previously deployed policy definitions, policy set definitions, policy assignments, and role assignments. A script is provided to facilitate the removal of these items. <ins>***It is highly recommended to thoroughly test the script in a non-production environment before executing it in production. Alert definitions do not need to be removed as they will continue to function.***</ins>***
{{< /hint >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ geekdocCollapseSection: true
weight: 96
---

### In this page

> [Update](../Update_to_release_2024-11-01#update) </br>
{{< hint type=Info >}}
**_No pre-update or post-update actions_** are required.
{{< /hint >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ geekdocCollapseSection: true
weight: 95
---

### In this page

> [Update](../Update_to_release_2024-12-10#update) </br>
{{< hint type=Info >}}
**_No pre-update or post-update actions_** are required.
{{< /hint >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ geekdocCollapseSection: true
weight: 94
---

### In this page

> [Update](../Update_to_release_2025-01-10#update) </br>
{{< hint type=Info >}}
**_No pre-update or post-update actions_** are required.
{{< /hint >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ geekdocCollapseSection: true
weight: 20
---

### In this page

> [Introduction](../Customize-Policy-Assignment#introduction) </br>
> [Modify initiative assignment](../Customize-Policy-Assignment#modify-initiative-assignment) </br>
> [Next steps](../Customize-Policy-Assignment#next-steps)
## Introduction

This document provides guidance on customizing policy assignments for the policies and initiatives in this repository. While default configurations are available as described in [Introduction to deploying the AMBA-ALZ pattern](../Introduction-to-deploying-the-ALZ-Pattern), you may need to adjust these settings to meet specific monitoring requirements or to implement alerts incrementally in an existing environment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ geekdocCollapseSection: true
weight: 70
---

### In this page

> [Quick deployment](../Deploy-only-Service-Health-Alerts#quick-deployment) </br>
> [Custom deployment](../Deploy-only-Service-Health-Alerts#custom-deployment) </br>
> [Next Steps](../Deploy-only-Service-Health-Alerts#next-steps) </br>
{{< hint type=Important >}}
Updating from the _**preview**_ version isn't supported. If you deployed the _**preview**_ version, proceed with [Moving from preview to GA](../../../Resources/Moving-from-preview-to-GA) before continuing.
{{< /hint >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ title: Deploy via the Azure Portal
weight: 30
---

### In this page

> [Deployment Settings Blade](../Deploy-via-Azure-Portal-UI#deployment-settings-blade) </br>
> [Management Groups Settings Blade](../Deploy-via-Azure-Portal-UI#management-groups-settings-blade) </br>
> [Notification Settings Blade](../Deploy-via-Azure-Portal-UI#notification-settings-blade) </br>
> [Next Steps](../Deploy-via-Azure-Portal-UI#next-steps) </br>
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/amba/alz/portal)

</br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Deploy with Azure CLI
weight: 30
---

### In this page

> [Configuring Variables for Deployment](../Deploy-with-Azure-CLI#3-configuring-variables-for-deployment) </br>
> [Deploying AMBA-ALZ](../Deploy-with-Azure-CLI#4-deploying-amba-alz) </br>
> [Next Steps](../Deploy-with-Azure-CLI#next-steps) </br>
{{% include "parameterConfiguration.md" %}}

## 3. Configuring Variables for Deployment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Deploy with Azure Pipelines
weight: 50
---

### In this page

> [Configure and Run the Pipeline](../Deploy-with-Azure-Pipelines#3-configure-and-run-the-pipeline) </br>
> [Next Steps](../Deploy-with-Azure-Pipelines#next-steps) </br>

{{% include "parameterConfiguration.md" %}}

## 3. Configure and Run the Pipeline
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Deploy with Azure PowerShell
weight: 40
---

### In this page

> [Configuring Variables for Deployment](../Deploy-with-Azure-PowerShell#3-configuring-variables-for-deployment) </br>
> [Deploy Policy Definitions, Initiatives, and Policy Assignments with Default Settings](../Deploy-with-Azure-PowerShell#4-deploy-policy-definitions-initiatives-and-policy-assignments-with-default-settings) </br>
> [Next Steps](../Deploy-with-Azure-PowerShell#next-steps) </br>
{{% include "parameterConfiguration.md" %}}

## 3. Configuring Variables for Deployment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ title: Deploy with GitHub Actions
weight: 60
---

### In this page

> [Configure and Run the Workflow](../Deploy-with-GitHub-Actions#3-configure-and-run-the-workflow) </br>
> [Next Steps](../Deploy-with-GitHub-Actions#next-steps) </br>
{{% include "parameterConfiguration.md" %}}

## 3. Configure and Run the Workflow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@ title: Introduction to deploying the AMBA-ALZ Pattern
weight: 10
---

### In this page

> [Background](../Introduction-to-deploying-the-ALZ-Pattern#background) </br>
> [Prerequisites](../Introduction-to-deploying-the-ALZ-Pattern#prerequisites) </br>
> [Getting Started](../Introduction-to-deploying-the-ALZ-Pattern#getting-started) </br>
> [Determining your Management Group Hierarchy](../Introduction-to-deploying-the-ALZ-Pattern#determining-your-management-group-hierarchy) </br>
> [Customizing Policy Assignments](../Introduction-to-deploying-the-ALZ-Pattern#customizing-policy-assignments) </br>
> [Customizing the AMBA-ALZ Policies](../Introduction-to-deploying-the-ALZ-Pattern#customizing-the-amba-alz-policies) </br>
> [Disabling Monitoring](../Introduction-to-deploying-the-ALZ-Pattern#disabling-monitoring) </br>
> [Cleaning up an ALZ Deployment](../Introduction-to-deploying-the-ALZ-Pattern#cleaning-up-an-amba-alz-deployment) </br>
> [Next Steps](../Introduction-to-deploying-the-ALZ-Pattern#next-steps) </br>
## Background

This guide provides instructions on how to begin implementing alert policies and initiatives in your environment for testing and validation. It assumes that you will use GitHub Actions or manual deployment methods to implement policies, initiatives, and policy assignments in your environment.
Expand Down Expand Up @@ -50,7 +62,7 @@ While it is recommended to implement the alert policies and initiatives within a
- [Manual deployment with Azure CLI](../Deploy-with-Azure-CLI)
- [Manual deployment with Azure PowerShell](../Deploy-with-Azure-PowerShell)

### Determining your Management Group Hierarchy
## Determining your Management Group Hierarchy

Azure Landing Zones provide a framework of best practices, patterns, and tools for establishing a secure, Well-Architected, and manageable cloud environment. A crucial element of Azure Landing Zones is the use of management groups, which enable the organization and management of subscriptions and resources in a hierarchical structure. Management groups facilitate the application of policies and access controls across multiple subscriptions and resources, simplifying the governance and management of your Azure environment.

Expand Down
Loading

0 comments on commit 9aa1520

Please sign in to comment.