Rule updates and fixes microsoft#29 microsoft#28 microsoft#30 microso…

…ft#27
BernieWhite · Sep 10, 2020 · b1df629 · b1df629
1 parent 46c32d4
commit b1df629
Show file tree

Hide file tree

Showing 22 changed files with 163 additions and 179 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -4,7 +4,8 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "test",
+            "label": "Test",
+            "detail": "Build and run unit tests.",
             "type": "shell",
             "command": "Invoke-Build Test -AssertStyle Client",
             "group": {
@@ -70,6 +71,13 @@
             "type": "shell",
             "command": "Invoke-Build ScaffoldHelp",
             "problemMatcher": []
+        },
+        {
+            "label": "Rule docs",
+            "detail": "Generate rule table of contents.",
+            "type": "shell",
+            "command": "Invoke-Build BuildRuleDocs",
+            "problemMatcher": []
         }
     ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,14 @@
 
 - General improvements:
   - Updated rule content to align with Microsoft Azure Well-Architected Framework pillars. [#23](https://github.com/microsoft/PSRule.Rules.CAF/issues/23)
+  - Updated naming rules to check for recommended naming prefixes. [#29](https://github.com/microsoft/PSRule.Rules.CAF/issues/29)
+    - Checks to determine if a resource name is valid are available in `PSRule.Rules.Azure`.
 - Engineering:
   - Updated to PSRule v0.20.0. [#24](https://github.com/microsoft/PSRule.Rules.CAF/issues/24)
+- Bug fixes:
+  - Fixed Storage Account `st` prefix. [#28](https://github.com/microsoft/PSRule.Rules.CAF/issues/28)
+  - Fixed Virtual Network Gateway `vgw-` prefix. [#30](https://github.com/microsoft/PSRule.Rules.CAF/issues/30)
+  - Fixed exclude `AzureFirewallSubnet` from `CAF.Name.Subnet`. [#27](https://github.com/microsoft/PSRule.Rules.CAF/issues/27)
 
 ## v0.1.0-B2008005 (pre-release)
 

diff --git a/docs/rules/en/CAF.Name.Connection.md b/docs/rules/en/CAF.Name.Connection.md
@@ -1,14 +1,14 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.Connection.md
 ---
 
 # Use standard connection names
 
 ## SYNOPSIS
 
-Virtual network gateway connection names should use a standard prefix and meet naming requirements.
+Virtual network gateway connection names should use a standard prefix.
 
 ## DESCRIPTION
 

diff --git a/docs/rules/en/CAF.Name.LoadBalancer.md b/docs/rules/en/CAF.Name.LoadBalancer.md
@@ -1,21 +1,22 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.LoadBalancer.md
 ---
 
 # Use standard load balancer names
 
 ## SYNOPSIS
 
-Load balancer names should use a standard prefix and meet naming requirements.
+Load balancer names should use a standard prefix.
 
 ## DESCRIPTION
 
 An effective naming convention allows operators to quickly identify resource type, associated workload,
 deployment environment and Azure region.
 
-For load balancers, the Cloud Adoption Framework recommends using the `lb-` prefix.
+For load balancers, the Cloud Adoption Framework recommends using the `lbi-`, and `lbe-` prefix.
+Use of different prefixes depends on the intended usage of the load balancer.
 
 Requirements for load balancers names:
 

diff --git a/docs/rules/en/CAF.Name.NSG.md b/docs/rules/en/CAF.Name.NSG.md
@@ -1,14 +1,14 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.NSG.md
 ---
 
 # Use standard NSG names
 
 ## SYNOPSIS
 
-Network security group (NSG) names should use a standard prefix and meet naming requirements.
+Network security group (NSG) names should use a standard prefix.
 
 ## DESCRIPTION
 

diff --git a/docs/rules/en/CAF.Name.PublicIP.md b/docs/rules/en/CAF.Name.PublicIP.md
@@ -1,14 +1,14 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.PublicIP.md
 ---
 
 # Use standard public IP names
 
 ## SYNOPSIS
 
-Public IP address names should use a standard prefix and meet naming requirements.
+Public IP address names should use a standard prefix.
 
 ## DESCRIPTION
 

diff --git a/docs/rules/en/CAF.Name.RG.md b/docs/rules/en/CAF.Name.RG.md
@@ -1,14 +1,14 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.RG.md
 ---
 
 # Use standard resource group names
 
 ## SYNOPSIS
 
-Resource group names should use a standard prefix and meet naming requirements.
+Resource group names should use a standard prefix.
 
 ## DESCRIPTION
 

diff --git a/docs/rules/en/CAF.Name.Route.md b/docs/rules/en/CAF.Name.Route.md
@@ -1,14 +1,14 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.Route.md
 ---
 
 # Use standard route table names
 
 ## SYNOPSIS
 
-Route table names should use a standard prefix and meet naming requirements.
+Route table names should use a standard prefix.
 
 ## DESCRIPTION
 

diff --git a/docs/rules/en/CAF.Name.Storage.md b/docs/rules/en/CAF.Name.Storage.md
@@ -1,21 +1,21 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.Storage.md
 ---
 
 # Use standard storage account names
 
 ## SYNOPSIS
 
-Storage account names should use a standard prefix and meet naming requirements.
+Storage account names should use a standard prefix.
 
 ## DESCRIPTION
 
 An effective naming convention allows operators to quickly identify resource type, associated workload,
 deployment environment and Azure region.
 
-For storage accounts, the Cloud Adoption Framework recommends using the `stor`, `stvm` and `dls` prefix.
+For storage accounts, the Cloud Adoption Framework recommends using the `st`, `stvm`, and `dls` prefix.
 Use of different prefixes depends on the intended usage of the storage account.
 
 Requirements for storage account names:

diff --git a/docs/rules/en/CAF.Name.Subnet.md b/docs/rules/en/CAF.Name.Subnet.md
@@ -1,14 +1,14 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.Subnet.md
 ---
 
 # Use standard subnet names
 
 ## SYNOPSIS
 
-Subnet names should use a standard prefix and meet naming requirements.
+Subnet names should use a standard prefix.
 
 ## DESCRIPTION
 

diff --git a/docs/rules/en/CAF.Name.VM.md b/docs/rules/en/CAF.Name.VM.md
@@ -1,14 +1,14 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.VM.md
 ---
 
 # Use standard VM names
 
 ## SYNOPSIS
 
-Virtual machine names should use a standard prefix and meet naming requirements.
+Virtual machine names should use a standard prefix.
 
 ## DESCRIPTION
 

diff --git a/docs/rules/en/CAF.Name.VNET.md b/docs/rules/en/CAF.Name.VNET.md
@@ -1,14 +1,14 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.VNET.md
 ---
 
 # Use standard VNET names
 
 ## SYNOPSIS
 
-Virtual network names should use a standard prefix and meet naming requirements.
+Virtual network names should use a standard prefix.
 
 ## DESCRIPTION
 

diff --git a/docs/rules/en/CAF.Name.VNG.md b/docs/rules/en/CAF.Name.VNG.md
@@ -1,21 +1,21 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Resource naming
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.VNG.md
 ---
 
 # Use standard virtual network gateway names
 
 ## SYNOPSIS
 
-Virtual network gateway names should use a standard prefix and meet naming requirements.
+Virtual network gateway names should use a standard prefix.
 
 ## DESCRIPTION
 
 An effective naming convention allows operators to quickly identify resource type, associated workload,
 deployment environment and Azure region.
 
-For virtual network gateways, the Cloud Adoption Framework recommends using the `vnet-gw-` prefix.
+For virtual network gateways, the Cloud Adoption Framework recommends using the `vgw-` prefix.
 
 Requirements for virtual network gateway names:
 

diff --git a/docs/rules/en/CAF.Tag.Environment.md b/docs/rules/en/CAF.Tag.Environment.md
@@ -1,6 +1,6 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Metadata tagging
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Tag.Environment.md
 ---
 

diff --git a/docs/rules/en/CAF.Tag.Required.md b/docs/rules/en/CAF.Tag.Required.md
@@ -1,6 +1,6 @@
 ---
 pillar: Operational Excellence
-category: Tagging and resource naming
+category: Metadata tagging
 online version: https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Tag.Required.md
 ---
 

diff --git a/docs/rules/en/module.md b/docs/rules/en/module.md
@@ -4,25 +4,25 @@
 
 The following rules are included within `PSRule.Rules.CAF`.
 
-### Naming
+### Metadata tagging
 
 Name | Synopsis
 ---- | --------
-[CAF.Name.Connection](CAF.Name.Connection.md) | Virtual network gateway connection names should use a standard prefix and meet naming requirements.
-[CAF.Name.LoadBalancer](CAF.Name.LoadBalancer.md) | Load balancer names should use a standard prefix and meet naming requirements.
-[CAF.Name.NSG](CAF.Name.NSG.md) | Network security group (NSG) names should use a standard prefix and meet naming requirements.
-[CAF.Name.PublicIP](CAF.Name.PublicIP.md) | Public IP address names should use a standard prefix and meet naming requirements.
-[CAF.Name.RG](CAF.Name.RG.md) | Resource group names should use a standard prefix and meet naming requirements.
-[CAF.Name.Route](CAF.Name.Route.md) | Route table names should use a standard prefix and meet naming requirements.
-[CAF.Name.Storage](CAF.Name.Storage.md) | Storage account names should use a standard prefix and meet naming requirements.
-[CAF.Name.Subnet](CAF.Name.Subnet.md) | Subnet names should use a standard prefix and meet naming requirements.
-[CAF.Name.VM](CAF.Name.VM.md) | Virtual machine names should use a standard prefix and meet naming requirements.
-[CAF.Name.VNET](CAF.Name.VNET.md) | Virtual network names should use a standard prefix and meet naming requirements.
-[CAF.Name.VNG](CAF.Name.VNG.md) | Virtual network gateway names should use a standard prefix and meet naming requirements.
+[CAF.Tag.Environment](CAF.Tag.Environment.md) | Tag resources and resource groups with a valid environment.
+[CAF.Tag.Required](CAF.Tag.Required.md) | Tag resources and resource groups with mandatory tags.
 
-### Tagging
+### Resource naming
 
 Name | Synopsis
 ---- | --------
-[CAF.Tag.Environment](CAF.Tag.Environment.md) | Tag resources and resource groups with a valid environment.
-[CAF.Tag.Required](CAF.Tag.Required.md) | Tag resources and resource groups with mandatory tags.
+[CAF.Name.Connection](CAF.Name.Connection.md) | Virtual network gateway connection names should use a standard prefix.
+[CAF.Name.LoadBalancer](CAF.Name.LoadBalancer.md) | Load balancer names should use a standard prefix.
+[CAF.Name.NSG](CAF.Name.NSG.md) | Network security group (NSG) names should use a standard prefix.
+[CAF.Name.PublicIP](CAF.Name.PublicIP.md) | Public IP address names should use a standard prefix.
+[CAF.Name.RG](CAF.Name.RG.md) | Resource group names should use a standard prefix.
+[CAF.Name.Route](CAF.Name.Route.md) | Route table names should use a standard prefix.
+[CAF.Name.Storage](CAF.Name.Storage.md) | Storage account names should use a standard prefix.
+[CAF.Name.Subnet](CAF.Name.Subnet.md) | Subnet names should use a standard prefix.
+[CAF.Name.VM](CAF.Name.VM.md) | Virtual machine names should use a standard prefix.
+[CAF.Name.VNET](CAF.Name.VNET.md) | Virtual network names should use a standard prefix.
+[CAF.Name.VNG](CAF.Name.VNG.md) | Virtual network gateway names should use a standard prefix.