Issue #416 - Link description in policy definitions for China (#419)

* updated link description

* policy assignment link definitions

* updated links to reflect commercial/generic/china

* markdown lint amend

* hubnetworking blockquote lint

* linting amendment

Co-authored-by: Jack Tracey <41163455+jtracey93@users.noreply.github.com>

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

@@ -18,7 +18,11 @@ Module deploys the following resources:
 
 - [Parameters for Azure Commercial Cloud](generateddocs/hubNetworking.bicep.md)
 
-> NOTE: When deploying using the `parameters/hubNetworking.parameters.all.json` you must update the `parPrivateDnsZones` parameter by replacing the `xxxxxx` placeholders with the deployment region or geo code, for Azure Backup. Failure to do so will cause these services to be unreachable over private endpoints.
+> **NOTE:**
+> - Although there are generated parameter markdowns for Azure Commercial Cloud, this same module can still be used in Azure China. Example parameter are in the [parameters](./parameters/) folder.
+>
+> - When deploying using the `parameters/hubNetworking.parameters.all.json` you must update the `parPrivateDnsZones` parameter by replacing the `xxxxxx` placeholders with the deployment region or geo code, for Azure Backup. Failure to do so will cause these services to be unreachable over private endpoints.
+>
 > For example, if deploying to East US the following zone entries:
 > - `privatelink.xxxxxx.azmk8s.io`
 > - `privatelink.xxxxxx.backup.windowsazure.com`
@@ -31,7 +35,6 @@ Module deploys the following resources:
 >
 > See child module, [`privateDnsZones.bicep` docs](https://github.com/Azure/ALZ-Bicep/tree/main/infra-as-code/bicep/modules/privateDnsZones#dns-zones) for more info on how this works
 
-
 ## Outputs
 
 The module will generate the following outputs:

infra-as-code/bicep/modules/logging/README.md

@@ -24,6 +24,8 @@ The module will deploy the following Log Analytics Workspace solutions by defaul
 
 - [Parameters for Azure Commercial Cloud](generateddocs/logging.bicep.md)
 
+> **NOTE:** Although there are generated parameter markdowns for Azure Commercial Cloud, this same module can still be used in Azure China. Example parameter are in the [parameters](./parameters/) folder.
+
 ## Deployment
 
 In this example, a Log Analytics Workspace and Automation Account will be deployed to the resource group `alz-logging`.  The inputs for this module are defined in `logging.parameters.all.json`.

infra-as-code/bicep/modules/managementGroups/README.md

@@ -16,7 +16,7 @@ The Management Groups module deploys a management group hierarchy in a customer'
 
 ## Parameters
 
-- [Parameters for Azure Commercial Cloud](generateddocs/managementGroups.bicep.md)
+- [Link to Parameters](generateddocs/managementGroups.bicep.md)
 
 ### Child Landing Zone Management Groups Flexibility
 

infra-as-code/bicep/modules/mgDiagSettings/README.md

@@ -5,7 +5,7 @@ This module enables the supported Diagnostic Settings categories on a Management
 
 ## Parameters
 
-- [Parameters for Azure Commercial Cloud](generateddocs/mgDiagSettings.bicep.md)
+- [Link to Parameters](generateddocs/mgDiagSettings.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/policy/assignments/README.md

@@ -10,6 +10,8 @@ If you wish to add your own additional Azure Policy Assignments please review [H
 
 - [Parameters for Azure Commercial Cloud](generateddocs/policyAssignmentManagementGroup.bicep.md)
 
+> **NOTE:** Although there are generated parameter markdowns for Azure Commercial Cloud, this same module can still be used in Azure China. Example parameter are in the [parameters](./parameters/) folder.
+
 ## Outputs
 
 The module does not generate any outputs.

infra-as-code/bicep/modules/policy/assignments/alzDefaults/README.md

@@ -7,7 +7,7 @@ If you wish to add your own additional Azure Policy Assignments please review [H
 ## Parameters
 
 - [Parameters for Azure Commercial Cloud](generateddocs/alzDefaultPolicyAssignments.bicep.md)
-- [Parameters for Azure Commercial Cloud](generateddocs/mc-alzDefaultPolicyAssignments.bicep.md)
+- [Parameters for Azure China Cloud](generateddocs/mc-alzDefaultPolicyAssignments.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/policy/definitions/README.md

@@ -15,7 +15,7 @@ If you wish to add your own additional custom Azure Policy Definitions please re
 ## Parameters
 
 - [Parameters for Azure Commercial Cloud](generateddocs/customPolicyDefinitions.bicep.md)
-- [Parameters for Azure Commercial Cloud](generateddocs/mc-customPolicyDefinitions.bicep.md)
+- [Parameters for Azure China Cloud](generateddocs/mc-customPolicyDefinitions.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/privateDnsZones/README.md

@@ -11,6 +11,8 @@ Module deploys the following resources:
 
 - [Parameters for Azure Commercial Cloud](generateddocs/privateDnsZones.bicep.md)
 
+> **NOTE:** Although there are generated parameter markdowns for Azure Commercial Cloud, this same module can still be used in Azure China. Example parameter are in the [parameters](./parameters/) folder.
+
 ## DNS Zones
 
 ### Regional Zones

infra-as-code/bicep/modules/publicIp/README.md

@@ -8,7 +8,7 @@ Module deploys the following resources:
 
 ## Parameters
 
-- [Parameters for Azure Commercial Cloud](generateddocs/publicIp.bicep.md)
+- [Link to Parameters](generateddocs/publicIp.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/resourceGroup/README.md

@@ -8,7 +8,7 @@ Module deploys the following resources:
 
 ## Parameters
 
-- [Parameters for Azure Commercial Cloud](generateddocs/resourceGroup.bicep.md)
+- [Link to Parameters](generateddocs/resourceGroup.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/roleAssignments/README.md

@@ -66,19 +66,19 @@ Connect-AzureAD
 
 ### roleAssignmentManagementGroup.bicep
 
-- [Parameters for Azure Commercial Cloud](generateddocs/roleAssignmentManagementGroup.bicep.md)
+- [Link to Parameters](generateddocs/roleAssignmentManagementGroup.bicep.md)
 
 ### roleAssignmentManagementGroupMany.bicep
 
-- [Parameters for Azure Commercial Cloud](generateddocs/roleAssignmentManagementGroupMany.bicep.md)
+- [Link to Parameters](generateddocs/roleAssignmentManagementGroupMany.bicep.md)
 
 ### roleAssignmentSubscription.bicep
 
-- [Parameters for Azure Commercial Cloud](generateddocs/roleAssignmentSubscription.bicep.md)
+- [Link to Parameters](generateddocs/roleAssignmentSubscription.bicep.md)
 
 ### roleAssignmentSubscriptionMany.bicep
 
-- [Parameters for Azure Commercial Cloud](generateddocs/roleAssignmentSubscriptionMany.bicep.md)
+- [Link to Parameters](generateddocs/roleAssignmentSubscriptionMany.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/spokeNetworking/README.md

@@ -30,7 +30,7 @@ Module deploys the following resources:
 
 ## Parameters
 
-- [Parameters for Azure Commercial Cloud](generateddocs/spokeNetworking.bicep.md)
+- [Link to Parameters](generateddocs/spokeNetworking.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/subscriptionPlacement/README.md

@@ -6,7 +6,7 @@ This module moves one or more subscriptions to be a child of the specified manag
 
 ## Parameters
 
-- [Parameters for Azure Commercial Cloud](generateddocs/subscriptionPlacement.bicep.md)
+- [Link to Parameters](generateddocs/subscriptionPlacement.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/vnetPeering/README.md

@@ -15,7 +15,7 @@ Module deploys the following resources:
 
 ## Parameters
 
-- [Parameters for Azure Commercial Cloud](generateddocs/vnetPeering.bicep.md)
+- [Link to Parameters](generateddocs/vnetPeering.bicep.md)
 
 ## Outputs
 

infra-as-code/bicep/modules/vwanConnectivity/README.md

@@ -17,6 +17,9 @@ Module deploys the following resources which can be configured by parameters:
 
 - [Parameters for Azure Commercial Cloud](generateddocs/vwanConnectivity.bicep.md)
 
+> **NOTE:** Although there are generated parameter markdowns for Azure Commercial Cloud, this same module can still be used in Azure China. Example parameter are in the [parameters](./parameters/) folder.
+
+<!-- markdownlint-disable -->
 > NOTE: When deploying using the `parameters/vwanConnectivity.parameters.all.json` you must update the `parPrivateDnsZones` parameter by replacing the `xxxxxx` placeholders with the deployment region. Failure to do so will cause these services to be unreachable over private endpoints.
 > For example, if deploying to East US the following zone entries:
 > - `privatelink.xxxxxx.azmk8s.io`
@@ -27,6 +30,7 @@ Module deploys the following resources which can be configured by parameters:
 > - `privatelink.eastus.azmk8s.io`
 > - `privatelink.eastus.backup.windowsazure.com`
 > - `privatelink.eastus.batch.azure.com`
+<!-- markdownlint-restore -->
 
 ## Outputs
 
@@ -40,6 +44,7 @@ The module will generate the following outputs:
 | outVirtualHubId       | string | /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/alz-vwan-eastus/providers/Microsoft.Network/virtualHubs/alz-vhub-eastus                                                               |
 | outDdosPlanResourceId | string | /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/alz-vwan-eastus/providers/Microsoft.Network/ddosProtectionPlans/alz-ddos-plan                                                         |
 | outPrivateDnsZones    | array  | `["name": "privatelink.azurecr.io", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/net-lz-spk-eastus-rg/providers/Microsoft.Network/privateDnsZones/privatelink.azurecr.io"]` |
+
 ## Deployment
 
 In this example, the resources required for Virtual WAN connectivity will be deployed to the resource group specified. According to the Azure Landing Zone Conceptual Architecture, the Virtual WAN resources should be deployed into the Platform connectivity subscription. During the deployment step, we will take parameters provided in the example parameters file.