Add service health notification info (Azure#310)

cds-snc · May 19, 2022 · 2b11801 · 2b11801
1 parent bce747c
commit 2b11801
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 0 deletions.
diff --git a/docs/archetypes/generic-subscription.md b/docs/archetypes/generic-subscription.md
@@ -8,6 +8,7 @@
   - [Azure Deployment](#azure-deployment)
     - [Schema Definition](#schema-definition)
     - [Delete Locks](#delete-locks)
+    - [Service Health](#service-health)
     - [Deployment Scenarios](#deployment-scenarios)
     - [Example Deployment Parameters](#example-deployment-parameters)
   - [Recommended Parameter Property Updates](#recommended-parameter-property-updates)
@@ -95,6 +96,12 @@ As an administrator, you can lock a subscription, resource group, or resource to
 
 **This archetype does not use `CanNotDelete` nor `ReadOnly` locks as part of the deployment.  You may customize the deployment templates when it's required for your environment.**
 
+### Service Health
+
+[Service health notifications](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties) are published by Azure, and contain information about the resources under your subscription.  Service health notifications can be informational or actionable, depending on the category.
+
+Our examples configure service health alerts for `Security` and `Incident`.  However, these categories can be customized based on your need.  Please review the possible options in [Azure Docs](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties#details-on-service-health-level-information).
+
 ### Deployment Scenarios
 
 > Sample deployment scenarios are based on the latest JSON parameters file schema definition.  If you have an older version of this repository, please use the examples from your repository.

diff --git a/docs/archetypes/healthcare.md b/docs/archetypes/healthcare.md
@@ -13,6 +13,7 @@
 * [Azure Deployment](#azure-deployment)
   * [Schema Definition](#schema-definition)
   * [Delete Locks](#delete-locks)
+  * [Service Health](#service-health)
   * [Deployment Scenarios](#deployment-scenarios)
   * [Example Deployment Parameters](#example-deployment-parameters)
   * [Deployment Instructions](#deployment-instructions)
@@ -256,6 +257,12 @@ As an administrator, you can lock a subscription, resource group, or resource to
 
 **This archetype does not use `CanNotDelete` nor `ReadOnly` locks as part of the deployment.  You may customize the deployment templates when it's required for your environment.**
 
+### Service Health
+
+[Service health notifications](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties) are published by Azure, and contain information about the resources under your subscription.  Service health notifications can be informational or actionable, depending on the category.
+
+Our examples configure service health alerts for `Security` and `Incident`.  However, these categories can be customized based on your need.  Please review the possible options in [Azure Docs](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties#details-on-service-health-level-information).
+
 ### Deployment Scenarios
 
 > Sample deployment scenarios are based on the latest JSON parameters file schema definition.  If you have an older version of this repository, please use the examples from your repository.

diff --git a/docs/archetypes/hubnetwork-azfw.md b/docs/archetypes/hubnetwork-azfw.md
@@ -14,6 +14,7 @@
 * [Azure Deployment](#azure-deployment)
   * [Schema Definition](#schema-definition)
   * [Delete Locks](#delete-locks)
+  * [Service Health](#service-health)
   * Deployment Scenarios
     * [Azure Firewall Policy](#deployment-scenarios-for-azure-firewall-policy)
     * [Hub Networking with Azure Firewall](#deployment-scenarios-for-hub-networking-with-azure-firewall)
@@ -261,6 +262,12 @@ By default, this archetype deploys `CanNotDelete` lock to prevent accidental del
 * Public Access Zone resource group
 * DDoS resource group (when enabled)
 
+### Service Health
+
+[Service health notifications](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties) are published by Azure, and contain information about the resources under your subscription.  Service health notifications can be informational or actionable, depending on the category.
+
+Our examples configure service health alerts for `Security` and `Incident`.  However, these categories can be customized based on your need.  Please review the possible options in [Azure Docs](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties#details-on-service-health-level-information).
+
 ### Deployment Scenarios for Azure Firewall Policy
 
 > Sample deployment scenarios are based on the latest JSON parameters file schema definition.  If you have an older version of this repository, please use the examples from your repository.

diff --git a/docs/archetypes/hubnetwork-nva-fortigate.md b/docs/archetypes/hubnetwork-nva-fortigate.md
@@ -15,6 +15,7 @@
 * [Azure Deployment](#azure-deployment)
   * [Schema Definition](#schema-definition)
   * [Delete Locks](#delete-locks)
+  * [Service Health](#service-health)
   * [Deployment Scenarios](#deployment-scenarios)
   * [Example Deployment Parameters](#example-deployment-parameters)
 
@@ -279,6 +280,12 @@ By default, this archetype deploys `CanNotDelete` lock to prevent accidental del
 * Public Access Zone resource group
 * DDoS resource group (when enabled)
 
+### Service Health
+
+[Service health notifications](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties) are published by Azure, and contain information about the resources under your subscription.  Service health notifications can be informational or actionable, depending on the category.
+
+Our examples configure service health alerts for `Security` and `Incident`.  However, these categories can be customized based on your need.  Please review the possible options in [Azure Docs](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties#details-on-service-health-level-information).
+
 ### Deployment Scenarios
 
 > Sample deployment scenarios are based on the latest JSON parameters file schema definition.  If you have an older version of this repository, please use the examples from your repository.

diff --git a/docs/archetypes/logging.md b/docs/archetypes/logging.md
@@ -5,6 +5,7 @@
 * [Overview](#overview)
 * [Schema Definition](#schema-definition)
 * [Delete Locks](#delete-locks)
+* [Service Health](#service-health)
 * [Deployment Scenarios](#deployment-scenarios)
 * [Example Deployment Parameters](#example-deployment-parameters)
 * [Deployment Instructions](#deployment-instructions)
@@ -62,6 +63,12 @@ As an administrator, you can lock a subscription, resource group, or resource to
 
 By default, this archetype deploys `CanNotDelete` lock to prevent accidental deletion on all resource groups it creates.
 
+## Service Health
+
+[Service health notifications](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties) are published by Azure, and contain information about the resources under your subscription.  Service health notifications can be informational or actionable, depending on the category.
+
+Our examples configure service health alerts for `Security` and `Incident`.  However, these categories can be customized based on your need.  Please review the possible options in [Azure Docs](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties#details-on-service-health-level-information).
+
 ## Deployment Scenarios
 
 > Sample deployment scenarios are based on the latest JSON parameters file schema definition.  If you have an older version of this repository, please use the examples from your repository.

diff --git a/docs/archetypes/machinelearning.md b/docs/archetypes/machinelearning.md
@@ -17,6 +17,7 @@
   - [Azure Deployment](#azure-deployment)
     - [Schema Definition](#schema-definition)
     - [Delete Locks](#delete-locks)
+    - [Service Health](#service-health)
     - [Deployment Scenarios](#deployment-scenarios)
     - [Example Deployment Parameters](#example-deployment-parameters)
     - [Deployment Instructions](#deployment-instructions)
@@ -257,6 +258,12 @@ As an administrator, you can lock a subscription, resource group, or resource to
 
 **This archetype does not use `CanNotDelete` nor `ReadOnly` locks as part of the deployment.  You may customize the deployment templates when it's required for your environment.**
 
+### Service Health
+
+[Service health notifications](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties) are published by Azure, and contain information about the resources under your subscription.  Service health notifications can be informational or actionable, depending on the category.
+
+Our examples configure service health alerts for `Security` and `Incident`.  However, these categories can be customized based on your need.  Please review the possible options in [Azure Docs](https://docs.microsoft.com/azure/service-health/service-health-notifications-properties#details-on-service-health-level-information).
+
 ### Deployment Scenarios
 
 > Sample deployment scenarios are based on the latest JSON parameters file schema definition.  If you have an older version of this repository, please use the examples from your repository.