Regenerated all docs

Azure · Sep 2, 2023 · e4a24f1 · e4a24f1
1 parent a307f05
commit e4a24f1
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 15 deletions.
diff --git a/modules/network/virtual-network/.test/common/main.test.bicep b/modules/network/virtual-network/.test/common/main.test.bicep
@@ -59,14 +59,15 @@ module diagnosticDependencies '../../../../.shared/.templates/diagnostic.depende
 // Test Execution //
 // ============== //
 
+var addressPrefix = '10.0.0.0/16'
 module testDeployment '../../main.bicep' = {
   scope: resourceGroup
   name: '${uniqueString(deployment().name, location)}-test-${serviceShort}'
   params: {
     enableDefaultTelemetry: enableDefaultTelemetry
     name: '${namePrefix}${serviceShort}001'
     addressPrefixes: [
-      '10.0.0.0/16'
+      addressPrefix
     ]
     diagnosticStorageAccountId: diagnosticDependencies.outputs.storageAccountResourceId
     diagnosticWorkspaceId: diagnosticDependencies.outputs.logAnalyticsWorkspaceResourceId
@@ -89,11 +90,11 @@ module testDeployment '../../main.bicep' = {
     flowTimeoutInMinutes: 20
     subnets: [
       {
-        addressPrefix: '10.0.255.0/24'
+        addressPrefix: cidrSubnet(addressPrefix, 24, 0)
         name: 'GatewaySubnet'
       }
       {
-        addressPrefix: '10.0.0.0/24'
+        addressPrefix: cidrSubnet(addressPrefix, 24, 1)
         name: '${namePrefix}-az-subnet-x-001'
         networkSecurityGroupId: nestedDependencies.outputs.networkSecurityGroupResourceId
         roleAssignments: [
@@ -116,7 +117,7 @@ module testDeployment '../../main.bicep' = {
         ]
       }
       {
-        addressPrefix: '10.0.3.0/24'
+        addressPrefix: cidrSubnet(addressPrefix, 24, 2)
         delegations: [
           {
             name: 'netappDel'
@@ -128,7 +129,7 @@ module testDeployment '../../main.bicep' = {
         name: '${namePrefix}-az-subnet-x-002'
       }
       {
-        addressPrefix: '10.0.6.0/24'
+        addressPrefix: cidrSubnet(addressPrefix, 24, 3)
         name: '${namePrefix}-az-subnet-x-003'
         privateEndpointNetworkPolicies: 'Disabled'
         privateLinkServiceNetworkPolicies: 'Enabled'

diff --git a/modules/network/virtual-network/README.md b/modules/network/virtual-network/README.md
@@ -375,7 +375,7 @@ module virtualNetwork './network/virtual-network/main.bicep' = {
   params: {
     // Required parameters
     addressPrefixes: [
-      '10.0.0.0/16'
+      '<addressPrefix>'
     ]
     name: 'nvncom001'
     // Non-required parameters
@@ -401,11 +401,11 @@ module virtualNetwork './network/virtual-network/main.bicep' = {
     ]
     subnets: [
       {
-        addressPrefix: '10.0.255.0/24'
+        addressPrefix: '<addressPrefix>'
         name: 'GatewaySubnet'
       }
       {
-        addressPrefix: '10.0.0.0/24'
+        addressPrefix: '<addressPrefix>'
         name: 'az-subnet-x-001'
         networkSecurityGroupId: '<networkSecurityGroupId>'
         roleAssignments: [
@@ -428,7 +428,7 @@ module virtualNetwork './network/virtual-network/main.bicep' = {
         ]
       }
       {
-        addressPrefix: '10.0.3.0/24'
+        addressPrefix: '<addressPrefix>'
         delegations: [
           {
             name: 'netappDel'
@@ -440,7 +440,7 @@ module virtualNetwork './network/virtual-network/main.bicep' = {
         name: 'az-subnet-x-002'
       }
       {
-        addressPrefix: '10.0.6.0/24'
+        addressPrefix: '<addressPrefix>'
         name: 'az-subnet-x-003'
         privateEndpointNetworkPolicies: 'Disabled'
         privateLinkServiceNetworkPolicies: 'Enabled'
@@ -470,7 +470,7 @@ module virtualNetwork './network/virtual-network/main.bicep' = {
     // Required parameters
     "addressPrefixes": {
       "value": [
-        "10.0.0.0/16"
+        "<addressPrefix>"
       ]
     },
     "name": {
@@ -518,11 +518,11 @@ module virtualNetwork './network/virtual-network/main.bicep' = {
     "subnets": {
       "value": [
         {
-          "addressPrefix": "10.0.255.0/24",
+          "addressPrefix": "<addressPrefix>",
           "name": "GatewaySubnet"
         },
         {
-          "addressPrefix": "10.0.0.0/24",
+          "addressPrefix": "<addressPrefix>",
           "name": "az-subnet-x-001",
           "networkSecurityGroupId": "<networkSecurityGroupId>",
           "roleAssignments": [
@@ -545,7 +545,7 @@ module virtualNetwork './network/virtual-network/main.bicep' = {
           ]
         },
         {
-          "addressPrefix": "10.0.3.0/24",
+          "addressPrefix": "<addressPrefix>",
           "delegations": [
             {
               "name": "netappDel",
@@ -557,7 +557,7 @@ module virtualNetwork './network/virtual-network/main.bicep' = {
           "name": "az-subnet-x-002"
         },
         {
-          "addressPrefix": "10.0.6.0/24",
+          "addressPrefix": "<addressPrefix>",
           "name": "az-subnet-x-003",
           "privateEndpointNetworkPolicies": "Disabled",
           "privateLinkServiceNetworkPolicies": "Enabled"

diff --git a/utilities/tools/Set-ModuleReadMe.ps1 b/utilities/tools/Set-ModuleReadMe.ps1
@@ -730,6 +730,9 @@ function ConvertTo-FormattedJSONParameterObject {
             if ($line -notlike '*"*"*' -and $line -like '*.*') {
                 # In case of a array value like '[ \n -> resourceGroupResources.outputs.managedIdentityPrincipalId <- \n ]' we'll only show "<managedIdentityPrincipalId>""
                 $line = '"<{0}>"' -f $line.Split('.')[-1].Trim()
+            } elseif ($line -match '^\s*[a-zA-Z]+\s*$') {
+                # If there is simply only a value such as a variable reference, we'll wrap it as a string to replace. For example a reference of a variable `addressPrefix` will be replaced with `"<addressPrefix>"`
+                $line = '"<{0}>"' -f $line.Trim()
             }
         }