Update parameter descriptions and typos

infra-as-code/bicep/modules/hubNetworking/generateddocs/hubNetworking.bicep.md

@@ -8,17 +8,17 @@ Parameter name | Required | Description
 -------------- | -------- | -----------
 parLocation    | No       | The Azure Region to deploy the resources into.
 parCompanyPrefix | No       | Prefix value which will be prepended to all resource names.
-parHubNetworkName | No       | Prefix Used for Hub Network.
-parHubNetworkAddressPrefix | No       | The IP address range for all virtual networks to use.
-parSubnets     | No       | The name, IP address range, network security group and route table for each subnet in the virtual networks.
+parHubNetworkName | No       | Name for Hub Network.
+parHubNetworkAddressPrefix | No       | The IP address range for Hub Network.
+parSubnets     | No       | The name, IP address range, network security group and route table for each subnet in the Hub Network.
 parDnsServerIps | No       | Array of DNS Server IP addresses for VNet.
 parPublicIpSku | No       | Public IP Address SKU.
 parPublicIpPrefix | No       | Optional Prefix for Public IPs. Include a succedent dash if required. Example: prefix-
 parPublicIpSuffix | No       | Optional Suffix for Public IPs. Include a preceding dash if required. Example: -suffix
-parAzBastionEnabled | No       | Switch to enable/disable Azure Bastion deployment. Default: true
+parAzBastionEnabled | No       | Switch to enable/disable Azure Bastion deployment.
 parAzBastionName | No       | Name Associated with Bastion Service.
-parAzBastionSku | No       | Azure Bastion SKU or Tier to deploy.  Currently two options exist Basic and Standard.
-parAzBastionNsgName | No       | NSG Name for Azure Bastion Subnet NSG.
+parAzBastionSku | No       | Azure Bastion SKU.
+parAzBastionNsgName | No       | Name for Azure Bastion Subnet NSG.
 parDdosEnabled | No       | Switch to enable/disable DDoS Network Protection deployment.
 parDdosPlanName | No       | DDoS Plan Name.
 parAzFirewallEnabled | No       | Switch to enable/disable Azure Firewall deployment.
@@ -60,23 +60,23 @@ Prefix value which will be prepended to all resource names.
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Prefix Used for Hub Network.
+Name for Hub Network.
 
 - Default value: `[format('{0}-hub-{1}', parameters('parCompanyPrefix'), parameters('parLocation'))]`
 
 ### parHubNetworkAddressPrefix
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-The IP address range for all virtual networks to use.
+The IP address range for Hub Network.
 
 - Default value: `10.10.0.0/16`
 
 ### parSubnets
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-The name, IP address range, network security group and route table for each subnet in the virtual networks.
+The name, IP address range, network security group and route table for each subnet in the Hub Network.
 
 - Default value: `   `
 
@@ -114,7 +114,7 @@ Optional Suffix for Public IPs. Include a preceding dash if required. Example: -
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Switch to enable/disable Azure Bastion deployment. Default: true
+Switch to enable/disable Azure Bastion deployment.
 
 - Default value: `True`
 
@@ -130,15 +130,17 @@ Name Associated with Bastion Service.
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Azure Bastion SKU or Tier to deploy.  Currently two options exist Basic and Standard.
+Azure Bastion SKU.
 
 - Default value: `Standard`
 
+- Allowed values: `Basic`, `Standard`
+
 ### parAzBastionNsgName
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-NSG Name for Azure Bastion Subnet NSG.
+Name for Azure Bastion Subnet NSG.
 
 - Default value: `nsg-AzureBastionSubnet`
 

infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep

@@ -7,13 +7,13 @@ param parLocation string = resourceGroup().location
 @sys.description('Prefix value which will be prepended to all resource names.')
 param parCompanyPrefix string = 'alz'
 
-@sys.description('Prefix Used for Hub Network.')
+@sys.description('Name for Hub Network.')
 param parHubNetworkName string = '${parCompanyPrefix}-hub-${parLocation}'
 
-@sys.description('The IP address range for all virtual networks to use.')
+@sys.description('The IP address range for Hub Network.')
 param parHubNetworkAddressPrefix string = '10.10.0.0/16'
 
-@sys.description('The name, IP address range, network security group and route table for each subnet in the virtual networks.')
+@sys.description('The name, IP address range, network security group and route table for each subnet in the Hub Network.')
 param parSubnets array = [
   {
     name: 'AzureBastionSubnet'
@@ -57,16 +57,20 @@ param parPublicIpPrefix string = ''
 @sys.description('Optional Suffix for Public IPs. Include a preceding dash if required. Example: -suffix')
 param parPublicIpSuffix string = '-PublicIP'
 
-@sys.description('Switch to enable/disable Azure Bastion deployment. Default: true')
+@sys.description('Switch to enable/disable Azure Bastion deployment.')
 param parAzBastionEnabled bool = true
 
 @sys.description('Name Associated with Bastion Service.')
 param parAzBastionName string = '${parCompanyPrefix}-bastion'
 
-@sys.description('Azure Bastion SKU or Tier to deploy.  Currently two options exist Basic and Standard.')
+@sys.description('Azure Bastion SKU.')
+@allowed([
+  'Basic'
+  'Standard'
+])
 param parAzBastionSku string = 'Standard'
 
-@sys.description('NSG Name for Azure Bastion Subnet NSG.')
+@sys.description('Name for Azure Bastion Subnet NSG.')
 param parAzBastionNsgName string = 'nsg-AzureBastionSubnet'
 
 @sys.description('Switch to enable/disable DDoS Network Protection deployment.')

infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.all.json

@@ -36,7 +36,7 @@
         },
         {
           "name": "AzureFirewallManagementSubnet",
-          "ipAddressRange": "10.10.253.0/24",
+          "ipAddressRange": "10.20.253.0/24",
           "networkSecurityGroupId": "",
           "routeTableId": ""
         }

infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.min.json

@@ -27,7 +27,7 @@
         },
         {
           "name": "AzureFirewallManagementSubnet",
-          "ipAddressRange": "10.10.253.0/24",
+          "ipAddressRange": "10.20.253.0/24",
           "networkSecurityGroupId": "",
           "routeTableId": ""
         }

infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.all.json

@@ -36,7 +36,7 @@
         },
         {
           "name": "AzureFirewallManagementSubnet",
-          "ipAddressRange": "10.10.253.0/24",
+          "ipAddressRange": "10.20.253.0/24",
           "networkSecurityGroupId": "",
           "routeTableId": ""
         }

infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.min.json

@@ -30,7 +30,7 @@
         },
         {
           "name": "AzureFirewallManagementSubnet",
-          "ipAddressRange": "10.10.253.0/24",
+          "ipAddressRange": "10.20.253.0/24",
           "networkSecurityGroupId": "",
           "routeTableId": ""
         }

infra-as-code/bicep/orchestration/hubPeeredSpoke/generateddocs/hubPeeredSpoke.bicep.md

@@ -6,39 +6,39 @@ Orchestration module used to create and configure a spoke network to deliver the
 
 Parameter name | Required | Description
 -------------- | -------- | -----------
-parLocation    | No       | The region to deploy all resources into. Default: deployment().location
-parTopLevelManagementGroupPrefix | No       | Prefix for the management group hierarchy. Default: alz
+parLocation    | No       | The region to deploy all resources into.
+parTopLevelManagementGroupPrefix | No       | Prefix for the management group hierarchy.
 parTopLevelManagementGroupSuffix | No       | Optional suffix for the management group hierarchy. This suffix will be appended to management group names/IDs. Include a preceding dash if required. Example: -suffix
 parPeeredVnetSubscriptionId | No       | Subscription Id to the Virtual Network Hub object. Default: Empty String
 parTags        | No       | Array of Tags to be applied to all resources in module. Default: Empty Object
-parTelemetryOptOut | No       | Set Parameter to true to Opt-out of deployment telemetry. Default: false
+parTelemetryOptOut | No       | Set Parameter to true to Opt-out of deployment telemetry.
 parPeeredVnetSubscriptionMgPlacement | No       | The Management Group Id to place the subscription in. Default: Empty String
-parResourceGroupNameForSpokeNetworking | No       | Name of Resource Group to be created to contain spoke networking resources like the virtual network. Default: {parTopLevelManagementGroupPrefix}-{parLocation}-spoke-networking
+parResourceGroupNameForSpokeNetworking | No       | Name of Resource Group to be created to contain spoke networking resources like the virtual network.
 parDdosProtectionPlanId | No       | Existing DDoS Protection plan to utilize. Default: Empty string
-parPrivateDnsZoneResourceIds | No       | The Resource IDs of the Private DNS Zones to associate with spokes.
-parSpokeNetworkName | No       | The Name of the Spoke Virtual Network. Default: vnet-spoke
-parSpokeNetworkAddressPrefix | No       | CIDR for Spoke Network. Default: 10.11.0.0/16
+parPrivateDnsZoneResourceIds | No       | The Resource IDs of the Private DNS Zones to associate with spokes. Default: Empty Array
+parSpokeNetworkName | No       | The Name of the Spoke Virtual Network.
+parSpokeNetworkAddressPrefix | No       | CIDR for Spoke Network.
 parDnsServerIps | No       | Array of DNS Server IP addresses for VNet. Default: Empty Array
 parNextHopIpAddress | No       | IP Address where network traffic should route to. Default: Empty string
-parDisableBgpRoutePropagation | No       | Switch which allows BGP Route Propogation to be disabled on the route table. Default: false
-parSpokeToHubRouteTableName | No       | Name of Route table to create for the default route of Hub. Default: rtb-spoke-to-hub
+parDisableBgpRoutePropagation | No       | Switch which allows BGP Route Propogation to be disabled on the route table.
+parSpokeToHubRouteTableName | No       | Name of Route table to create for the default route of Hub.
 parHubVirtualNetworkId | Yes      | Virtual Network ID of Hub Virtual Network, or Azure Virtuel WAN hub ID.
-parAllowSpokeForwardedTraffic | No       | Switch to enable/disable forwarded Traffic from outside spoke network. Default: false
-parAllowHubVpnGatewayTransit | No       | Switch to enable/disable VPN Gateway for the hub network peering. Default: false
+parAllowSpokeForwardedTraffic | No       | Switch to enable/disable forwarded Traffic from outside spoke network.
+parAllowHubVpnGatewayTransit | No       | Switch to enable/disable VPN Gateway for the hub network peering.
 
 ### parLocation
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-The region to deploy all resources into. Default: deployment().location
+The region to deploy all resources into.
 
 - Default value: `[deployment().location]`
 
 ### parTopLevelManagementGroupPrefix
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Prefix for the management group hierarchy. Default: alz
+Prefix for the management group hierarchy.
 
 - Default value: `alz`
 
@@ -64,7 +64,7 @@ Array of Tags to be applied to all resources in module. Default: Empty Object
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Set Parameter to true to Opt-out of deployment telemetry. Default: false
+Set Parameter to true to Opt-out of deployment telemetry.
 
 - Default value: `False`
 
@@ -78,7 +78,7 @@ The Management Group Id to place the subscription in. Default: Empty String
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Name of Resource Group to be created to contain spoke networking resources like the virtual network. Default: {parTopLevelManagementGroupPrefix}-{parLocation}-spoke-networking
+Name of Resource Group to be created to contain spoke networking resources like the virtual network.
 
 - Default value: `[format('{0}-{1}-spoke-networking', parameters('parTopLevelManagementGroupPrefix'), parameters('parLocation'))]`
 
@@ -92,21 +92,21 @@ Existing DDoS Protection plan to utilize. Default: Empty string
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-The Resource IDs of the Private DNS Zones to associate with spokes.
+The Resource IDs of the Private DNS Zones to associate with spokes. Default: Empty Array
 
 ### parSpokeNetworkName
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-The Name of the Spoke Virtual Network. Default: vnet-spoke
+The Name of the Spoke Virtual Network.
 
 - Default value: `vnet-spoke`
 
 ### parSpokeNetworkAddressPrefix
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-CIDR for Spoke Network. Default: 10.11.0.0/16
+CIDR for Spoke Network.
 
 - Default value: `10.11.0.0/16`
 
@@ -126,15 +126,15 @@ IP Address where network traffic should route to. Default: Empty string
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Switch which allows BGP Route Propogation to be disabled on the route table. Default: false
+Switch which allows BGP Route Propogation to be disabled on the route table.
 
 - Default value: `False`
 
 ### parSpokeToHubRouteTableName
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Name of Route table to create for the default route of Hub. Default: rtb-spoke-to-hub
+Name of Route table to create for the default route of Hub.
 
 - Default value: `rtb-spoke-to-hub`
 
@@ -148,15 +148,15 @@ Virtual Network ID of Hub Virtual Network, or Azure Virtuel WAN hub ID.
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Switch to enable/disable forwarded Traffic from outside spoke network. Default: false
+Switch to enable/disable forwarded Traffic from outside spoke network.
 
 - Default value: `False`
 
 ### parAllowHubVpnGatewayTransit
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
-Switch to enable/disable VPN Gateway for the hub network peering. Default: false
+Switch to enable/disable VPN Gateway for the hub network peering.
 
 - Default value: `False`
 

infra-as-code/bicep/orchestration/hubPeeredSpoke/hubPeeredSpoke.bicep

@@ -5,10 +5,10 @@ metadata description = 'Orchestration module used to create and configure a spok
 
 // **Parameters**
 // Generic Parameters - Used in multiple modules
-@sys.description('The region to deploy all resources into. Default: deployment().location')
+@sys.description('The region to deploy all resources into.')
 param parLocation string = deployment().location
 
-@sys.description('Prefix for the management group hierarchy. Default: alz')
+@sys.description('Prefix for the management group hierarchy.')
 @minLength(2)
 @maxLength(10)
 param parTopLevelManagementGroupPrefix string = 'alz'
@@ -23,50 +23,50 @@ param parPeeredVnetSubscriptionId string = ''
 @sys.description('Array of Tags to be applied to all resources in module. Default: Empty Object')
 param parTags object = {}
 
-@sys.description('Set Parameter to true to Opt-out of deployment telemetry. Default: false')
+@sys.description('Set Parameter to true to Opt-out of deployment telemetry.')
 param parTelemetryOptOut bool = false
 
 // Subscription Module Parameters
 @sys.description('The Management Group Id to place the subscription in. Default: Empty String')
 param parPeeredVnetSubscriptionMgPlacement string = ''
 
 // Resource Group Module Parameters
-@sys.description('Name of Resource Group to be created to contain spoke networking resources like the virtual network. Default: {parTopLevelManagementGroupPrefix}-{parLocation}-spoke-networking')
+@sys.description('Name of Resource Group to be created to contain spoke networking resources like the virtual network.')
 param parResourceGroupNameForSpokeNetworking string = '${parTopLevelManagementGroupPrefix}-${parLocation}-spoke-networking'
 
 // Spoke Networking Module Parameters
 @sys.description('Existing DDoS Protection plan to utilize. Default: Empty string')
 param parDdosProtectionPlanId string = ''
 
-@sys.description('The Resource IDs of the Private DNS Zones to associate with spokes.')
+@sys.description('The Resource IDs of the Private DNS Zones to associate with spokes. Default: Empty Array')
 param parPrivateDnsZoneResourceIds array = []
 
-@sys.description('The Name of the Spoke Virtual Network. Default: vnet-spoke')
+@sys.description('The Name of the Spoke Virtual Network.')
 param parSpokeNetworkName string = 'vnet-spoke'
 
-@sys.description('CIDR for Spoke Network. Default: 10.11.0.0/16')
+@sys.description('CIDR for Spoke Network.')
 param parSpokeNetworkAddressPrefix string = '10.11.0.0/16'
 
 @sys.description('Array of DNS Server IP addresses for VNet. Default: Empty Array')
-param parDnsServerIps  array = []
+param parDnsServerIps array = []
 
 @sys.description('IP Address where network traffic should route to. Default: Empty string')
 param parNextHopIpAddress string = ''
 
-@sys.description('Switch which allows BGP Route Propogation to be disabled on the route table. Default: false')
+@sys.description('Switch which allows BGP Route Propogation to be disabled on the route table.')
 param parDisableBgpRoutePropagation bool = false
 
-@sys.description('Name of Route table to create for the default route of Hub. Default: rtb-spoke-to-hub')
+@sys.description('Name of Route table to create for the default route of Hub.')
 param parSpokeToHubRouteTableName string = 'rtb-spoke-to-hub'
 
 // Peering Modules Parameters
 @sys.description('Virtual Network ID of Hub Virtual Network, or Azure Virtuel WAN hub ID.')
 param parHubVirtualNetworkId string
 
-@sys.description('Switch to enable/disable forwarded Traffic from outside spoke network. Default: false')
+@sys.description('Switch to enable/disable forwarded Traffic from outside spoke network.')
 param parAllowSpokeForwardedTraffic bool = false
 
-@sys.description('Switch to enable/disable VPN Gateway for the hub network peering. Default: false')
+@sys.description('Switch to enable/disable VPN Gateway for the hub network peering.')
 param parAllowHubVpnGatewayTransit bool = false
 
 // **Variables**