Complete pillar metadata (Azure#2707)

BernieWhite · web-flow · commit b3ab563b2523 · 2024-02-26T02:38:16.000+10:00
diff --git a/.ps-rule/Rule.Rule.ps1 b/.ps-rule/Rule.Rule.ps1
@@ -54,7 +54,7 @@ Rule 'Rule.Pillar' -Type 'PSRule.Rules.Rule' {
 }
 
 # Synopsis: Add tag to rules for a valid Well-Architected Framework pillar.
-Rule 'Rule.PillarTag' -Type 'PSRule.Rules.Rule' -Level Warning {
+Rule 'Rule.PillarTag' -Type 'PSRule.Rules.Rule' {
     $Assert.In($TargetObject, 'Tag.''Azure.WAF/pillar''', @(
         # English
         'Cost Optimization'
diff --git a/.vscode/markdown.code-snippets b/.vscode/markdown.code-snippets
@@ -5,7 +5,7 @@
     "description": "Azure rule documentation",
     "body": [
       "---",
-      "reviewed: 2023-mm-dd",
+      "reviewed: 2024-mm-dd",
       "severity: ${4:severity}",
       "pillar: ${5:pillar}",
       "category: ${6:category}",
diff --git a/.vscode/powershell.code-snippets b/.vscode/powershell.code-snippets
@@ -5,7 +5,7 @@
     "description": "Rule definition for Azure",
     "body": [
       "# Synopsis: ${2}",
-      "Rule '${1}' -Type '${3}' -Tag @{ release = ''; ruleSet = ''; } {",
+      "Rule '${1}' -Type '${3}' -Tag @{ release = ''; ruleSet = ''; 'Azure.WAF/pillar' = ''; } {",
       "\t$0",
       "}"
     ]
diff --git a/docs/en/rules/Azure.MySQL.UseFlexible.md b/docs/en/rules/Azure.MySQL.UseFlexible.md
@@ -1,7 +1,7 @@
 ---
 severity: Important
-pillar: Operational Excellence
-category: Infrastructure provisioning
+pillar: Reliability
+category: RE:05 Redundancy
 resource: Azure Database for MySQL
 online version: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.MySQL.UseFlexible/
 ---
@@ -14,17 +14,18 @@ Use Azure Database for MySQL Flexible Server deployment model.
 
 ## DESCRIPTION
 
-Azure Database for MySQL Single Server is on the retirement path. Upgrade to Azure Database for MySQL Flexible Server.
+Azure Database for MySQL Single Server is on the retirement path.
+Upgrade to Azure Database for MySQL Flexible Server.
 
 Azure Database for MySQL Flexible Server provides additional options for resilience and scalability above the Single Server deployment model.
 
 ## RECOMMENDATION
 
-Migrate to Azure Database for MySQL Flexible Server deployment model.
+Consider migrating to Azure Database for MySQL Flexible Server deployment model.
 
 ## LINKS
 
-- [Infrastructure provisioning](https://learn.microsoft.com/azure/architecture/framework/devops/automation-infrastructure)
+- [RE:05 Redundancy](https://learn.microsoft.com/azure/well-architected/reliability/redundancy)
 - [Azure Database for MySQL Single Server deployment model retirement](https://learn.microsoft.com/azure/mysql/single-server/whats-happening-to-mysql-single-server)
 - [Migrate from Single Server to Flexible Server](https://learn.microsoft.com/azure/mysql/single-server/whats-happening-to-mysql-single-server#migrate-from-single-server-to-flexible-server)
 - [Comparing the MySQL deployment options in Azure](https://learn.microsoft.com/azure/mysql/single-server/select-right-deployment-type#comparing-the-mysql-deployment-options-in-azure)
diff --git a/docs/en/rules/Azure.RSV.StorageType.md b/docs/en/rules/Azure.RSV.StorageType.md
@@ -29,12 +29,12 @@ The following geo-replicated options are available for recovery services vaults:
 
 Consider using GeoRedundant for recovery services vaults that contain data.
 
-
 ## EXAMPLES
 
 ### Configure with Azure template
-The default storage type used by Recovery Services vaults is Geo-redundant. However if you're 
-defining the backup config in an ARM template:
+
+The default storage type used by Recovery Services vaults is Geo-redundant.
+However if you're defining the backup config in an ARM template:
 
 - Set `properties.storageType` to either `GeoRedundant` or `ReadAccessGeoZoneRedundant`.
 For example:
@@ -53,8 +53,9 @@ For example:
 ```
 
 ### Configure with Bicep
-The default storage type used by Recovery Services vaults is Geo-redundant. However if you're 
-defining the backup config via Bicep:
+
+The default storage type used by Recovery Services vaults is Geo-redundant.
+However if you're defining the backup config via Bicep:
 
 - Set `properties.storageType` to either `GeoRedundant` or `ReadAccessGeoZoneRedundant`.
 
@@ -73,7 +74,7 @@ resource testRecoveryServices 'Microsoft.RecoveryServices/vaults/backupconfig@20
 
 ## LINKS
 
-- [Recovery Services Vault - Overview](https://docs.microsoft.com/azure/backup/backup-azure-recovery-services-vault-overview#storage-settings-in-the-recovery-services-vault)
-- [Recovery Services Vault - Storage Settings](https://docs.microsoft.com/azure/backup/backup-create-rs-vault#set-storage-redundancy)
-- [Azure deployment reference](https://docs.microsoft.com/azure/templates/microsoft.recoveryservices/vaults/backupconfig?tabs=bicep)
-- [Well Architected Framework - Reliability](https://learn.microsoft.com/azure/architecture/framework/resiliency/design-resiliency)
+- [RE:05 Redundancy](https://learn.microsoft.com/azure/well-architected/reliability/redundancy)
+- [Recovery Services Vault - Overview](https://learn.microsoft.com/azure/backup/backup-azure-recovery-services-vault-overview#storage-settings-in-the-recovery-services-vault)
+- [Recovery Services Vault - Storage Settings](https://learn.microsoft.com/azure/backup/backup-create-recovery-services-vault#set-storage-redundancy)
+- [Azure deployment reference](https://learn.microsoft.com/azure/templates/microsoft.recoveryservices/vaults/backupconfig)
diff --git a/src/PSRule.Rules.Azure/rules/Azure.MySQL.Rule.ps1 b/src/PSRule.Rules.Azure/rules/Azure.MySQL.Rule.ps1
@@ -56,7 +56,7 @@ Rule 'Azure.MySQL.GeoRedundantBackup' -Ref 'AZR-000323' -Type 'Microsoft.DBforMy
 }
 
 # Synopsis: Use Azure Database for MySQL Flexible Server deployment model.
-Rule 'Azure.MySQL.UseFlexible' -Ref 'AZR-000325' -Type 'Microsoft.DBforMySQL/flexibleServers', 'Microsoft.DBforMySQL/servers' -Level Warning -Tag @{ release = 'GA'; ruleSet = '2022_12'; } {
+Rule 'Azure.MySQL.UseFlexible' -Ref 'AZR-000325' -Type 'Microsoft.DBforMySQL/flexibleServers', 'Microsoft.DBforMySQL/servers' -Level Warning -Tag @{ release = 'GA'; ruleSet = '2022_12'; 'Azure.WAF/pillar' = 'Reliability'; } {
     $Assert.Create($PSRule.TargetType -eq 'Microsoft.DBforMySQL/flexibleServers', $LocalizedData.SingleDeploymentModelRetirement)
 }
 
diff --git a/src/PSRule.Rules.Azure/rules/Azure.RSV.Rule.ps1 b/src/PSRule.Rules.Azure/rules/Azure.RSV.Rule.ps1
@@ -6,7 +6,7 @@
 #
 
 # Synopsis: Recovery Services Vault (RSV) not using geo-replicated storage (GRS) may be at risk.
-Rule 'Azure.RSV.StorageType' -Ref 'AZR-000170' -Type 'Microsoft.RecoveryServices/vaults', 'Microsoft.RecoveryServices/vaults/backupconfig' -Tag @{ release = 'GA'; ruleSet = '2022_03' } {
+Rule 'Azure.RSV.StorageType' -Ref 'AZR-000170' -Type 'Microsoft.RecoveryServices/vaults', 'Microsoft.RecoveryServices/vaults/backupconfig' -Tag @{ release = 'GA'; ruleSet = '2022_03'; 'Azure.WAF/pillar' = 'Reliability'; } {
     $backupConfig = @($TargetObject);
     if ($PSRule.TargetType -eq 'Microsoft.RecoveryServices/vaults') {
         $backupConfig = @(GetSubResources -ResourceType 'Microsoft.RecoveryServices/vaults/backupconfig');
@@ -28,7 +28,7 @@ Rule 'Azure.RSV.StorageType' -Ref 'AZR-000170' -Type 'Microsoft.RecoveryServices
 }
 
 # Synopsis: Recovery Services Vault (RSV) without a replication alert may be at risk.
-Rule 'Azure.RSV.ReplicationAlert' -Ref 'AZR-000171' -Type 'Microsoft.RecoveryServices/vaults', 'Microsoft.RecoveryServices/vaults/replicationAlertSettings' -Tag @{ release = 'GA'; ruleSet = '2022_03' } {
+Rule 'Azure.RSV.ReplicationAlert' -Ref 'AZR-000171' -Type 'Microsoft.RecoveryServices/vaults', 'Microsoft.RecoveryServices/vaults/replicationAlertSettings' -Tag @{ release = 'GA'; ruleSet = '2022_03'; 'Azure.WAF/pillar' = 'Reliability'; } {
     $replicationAlert = @($TargetObject);
     if ($PSRule.TargetType -eq 'Microsoft.RecoveryServices/vaults') {
         $replicationAlert = @(GetSubResources -ResourceType 'Microsoft.RecoveryServices/vaults/replicationAlertSettings');
diff --git a/src/PSRule.Rules.Azure/rules/Azure.SQL.Rule.ps1 b/src/PSRule.Rules.Azure/rules/Azure.SQL.Rule.ps1
@@ -79,7 +79,7 @@ Rule 'Azure.SQL.AAD' -Ref 'AZR-000188' -Type 'Microsoft.Sql/servers', 'Microsoft
 }
 
 # Synopsis: Azure SQL logical server names should meet naming requirements.
-Rule 'Azure.SQL.ServerName' -Ref 'AZR-000190' -Type 'Microsoft.Sql/servers' -Tag @{ release = 'GA'; ruleSet = '2020_12'; } {
+Rule 'Azure.SQL.ServerName' -Ref 'AZR-000190' -Type 'Microsoft.Sql/servers' -Tag @{ release = 'GA'; ruleSet = '2020_12'; 'Azure.WAF/pillar' = 'Operational Excellence'; } {
     # https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules#microsoftsql
 
     # Between 1 and 63 characters long

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ Rule 'Rule.Pillar' -Type 'PSRule.Rules.Rule' {`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`# Synopsis: Add tag to rules for a valid Well-Architected Framework pillar.`
`57`		`-Rule 'Rule.PillarTag' -Type 'PSRule.Rules.Rule' -Level Warning {`
	`57`	`+Rule 'Rule.PillarTag' -Type 'PSRule.Rules.Rule' {`
`58`	`58`	`$Assert.In($TargetObject, 'Tag.''Azure.WAF/pillar''', @(`
`59`	`59`	`# English`
`60`	`60`	`'Cost Optimization'`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`"description": "Rule definition for Azure",`
`6`	`6`	`"body": [`
`7`	`7`	`"# Synopsis: ${2}",`
`8`		`- "Rule '${1}' -Type '${3}' -Tag @{ release = ''; ruleSet = ''; } {",`
	`8`	`+ "Rule '${1}' -Type '${3}' -Tag @{ release = ''; ruleSet = ''; 'Azure.WAF/pillar' = ''; } {",`
`9`	`9`	`"\t$0",`
`10`	`10`	`"}"`
`11`	`11`	`]`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ Rule 'Azure.MySQL.GeoRedundantBackup' -Ref 'AZR-000323' -Type 'Microsoft.DBforMy`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`# Synopsis: Use Azure Database for MySQL Flexible Server deployment model.`
`59`		`-Rule 'Azure.MySQL.UseFlexible' -Ref 'AZR-000325' -Type 'Microsoft.DBforMySQL/flexibleServers', 'Microsoft.DBforMySQL/servers' -Level Warning -Tag @{ release = 'GA'; ruleSet = '2022_12'; } {`
	`59`	`+Rule 'Azure.MySQL.UseFlexible' -Ref 'AZR-000325' -Type 'Microsoft.DBforMySQL/flexibleServers', 'Microsoft.DBforMySQL/servers' -Level Warning -Tag @{ release = 'GA'; ruleSet = '2022_12'; 'Azure.WAF/pillar' = 'Reliability'; } {`
`60`	`60`	`$Assert.Create($PSRule.TargetType -eq 'Microsoft.DBforMySQL/flexibleServers', $LocalizedData.SingleDeploymentModelRetirement)`
`61`	`61`	`}`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ Rule 'Azure.SQL.AAD' -Ref 'AZR-000188' -Type 'Microsoft.Sql/servers', 'Microsoft`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`# Synopsis: Azure SQL logical server names should meet naming requirements.`
`82`		`-Rule 'Azure.SQL.ServerName' -Ref 'AZR-000190' -Type 'Microsoft.Sql/servers' -Tag @{ release = 'GA'; ruleSet = '2020_12'; } {`
	`82`	`+Rule 'Azure.SQL.ServerName' -Ref 'AZR-000190' -Type 'Microsoft.Sql/servers' -Tag @{ release = 'GA'; ruleSet = '2020_12'; 'Azure.WAF/pillar' = 'Operational Excellence'; } {`
`83`	`83`	`# https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules#microsoftsql`
`84`	`84`
`85`	`85`	`# Between 1 and 63 characters long`