refactor: Allow option to specify virtual network gateway ip configur…

…ation names (#921) * fix: Add missing private dns zones to applicable policy assignment and module (#903) * Fix private dns zone list in policy assignment * Remove unused dns zone ids and update param names * Remove unused dns zone ids and update param names * Update generated docs * Add param to accelerator * Generate Parameter Markdowns [oZakari/1618d0f4] * Fix value for param * Add prefix to dependabot title * Update test values * Updated param table * Generate Parameter Markdowns [oZakari/640a1dbc] * Update logic * Update spacing * Add params to parameter file * Generate Parameter Markdowns [oZakari/0a582834] --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * Transition back vnetGatewayConfig reference * Generate Parameter Markdowns [oZakari/c151f035] * Remove duplicate `parPrivateDnsZonesLocation` entry. --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Azure · Jan 7, 2025 · 04b3a3a · 04b3a3a
1 parent f025098
commit 04b3a3a
Show file tree

Hide file tree

Showing 10 changed files with 81 additions and 31 deletions.
diff --git a/...de/bicep/modules/hubNetworking/generateddocs/hubNetworking-multiRegion.bicep.md b/...de/bicep/modules/hubNetworking/generateddocs/hubNetworking-multiRegion.bicep.md
@@ -735,15 +735,15 @@ Switch to enable/disable VPN virtual network gateway deployment in secondary loc
 
 Configuration for VPN virtual network gateway to be deployed.
 
-- Default value: `@{name=[format('{0}-Vpn-Gateway-{1}', parameters('parCompanyPrefix'), parameters('parLocation'))]; gatewayType=Vpn; sku=VpnGw1; vpnType=RouteBased; generation=Generation1; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; vpnClientConfiguration=}`
+- Default value: `@{name=[format('{0}-Vpn-Gateway-{1}', parameters('parCompanyPrefix'), parameters('parLocation'))]; gatewayType=Vpn; sku=VpnGw1; vpnType=RouteBased; generation=Generation1; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; vpnClientConfiguration=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
 
 ### parVpnGatewayConfigSecondaryLocation
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
 Configuration for VPN virtual network gateway to be deployed in secondary location.
 
-- Default value: `@{name=[format('{0}-Vpn-Gateway-{1}', parameters('parCompanyPrefix'), parameters('parSecondaryLocation'))]; gatewayType=Vpn; sku=VpnGw1; vpnType=RouteBased; generation=Generation1; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; vpnClientConfiguration=}`
+- Default value: `@{name=[format('{0}-Vpn-Gateway-{1}', parameters('parCompanyPrefix'), parameters('parSecondaryLocation'))]; gatewayType=Vpn; sku=VpnGw1; vpnType=RouteBased; generation=Generation1; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; vpnClientConfiguration=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
 
 ### parExpressRouteGatewayEnabled
 
@@ -767,15 +767,15 @@ Switch to enable/disable ExpressRoute virtual network gateway deployment in seco
 
 Configuration for ExpressRoute virtual network gateway to be deployed.
 
-- Default value: `@{name=[format('{0}-ExpressRoute-Gateway', parameters('parCompanyPrefix'))]; gatewayType=ExpressRoute; sku=ErGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=None; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=}`
+- Default value: `@{name=[format('{0}-ExpressRoute-Gateway', parameters('parCompanyPrefix'))]; gatewayType=ExpressRoute; sku=ErGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=None; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
 
 ### parExpressRouteGatewayConfigSecondaryLocation
 
 ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square)
 
 Configuration for ExpressRoute virtual network gateway to be deployed in secondary location.
 
-- Default value: `@{name=[format('{0}-ExpressRoute-Gateway', parameters('parCompanyPrefix'))]; gatewayType=ExpressRoute; sku=ErGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=None; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=}`
+- Default value: `@{name=[format('{0}-ExpressRoute-Gateway', parameters('parCompanyPrefix'))]; gatewayType=ExpressRoute; sku=ErGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=None; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
 
 ### parVirtualNetworkGatewayLock
 
@@ -1173,7 +1173,9 @@ outBastionNsgNameSecondaryLocation | string |
                     "bgpPeeringAddress": "",
                     "peerWeight": 5
                 },
-                "vpnClientConfiguration": {}
+                "vpnClientConfiguration": {},
+                "ipConfigurationName": "vnetGatewayConfig",
+                "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
             }
         },
         "parVpnGatewayConfigSecondaryLocation": {
@@ -1193,7 +1195,9 @@ outBastionNsgNameSecondaryLocation | string |
                     "bgpPeeringAddress": "",
                     "peerWeight": 5
                 },
-                "vpnClientConfiguration": {}
+                "vpnClientConfiguration": {},
+                "ipConfigurationName": "vnetGatewayConfig",
+                "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
             }
         },
         "parExpressRouteGatewayEnabled": {
@@ -1218,7 +1222,9 @@ outBastionNsgNameSecondaryLocation | string |
                     "asn": "65515",
                     "bgpPeeringAddress": "",
                     "peerWeight": "5"
-                }
+                },
+                "ipConfigurationName": "vnetGatewayConfig",
+                "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
             }
         },
         "parExpressRouteGatewayConfigSecondaryLocation": {
@@ -1237,7 +1243,9 @@ outBastionNsgNameSecondaryLocation | string |
                     "asn": "65515",
                     "bgpPeeringAddress": "",
                     "peerWeight": "5"
-                }
+                },
+                "ipConfigurationName": "vnetGatewayConfig",
+                "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
             }
         },
         "parVirtualNetworkGatewayLock": {

diff --git a/infra-as-code/bicep/modules/hubNetworking/generateddocs/hubNetworking.bicep.md b/infra-as-code/bicep/modules/hubNetworking/generateddocs/hubNetworking.bicep.md
@@ -454,7 +454,7 @@ Switch to enable/disable VPN virtual network gateway deployment.
 
 Configuration for VPN virtual network gateway to be deployed.
 
-- Default value: `@{name=[format('{0}-Vpn-Gateway', parameters('parCompanyPrefix'))]; gatewayType=Vpn; sku=VpnGw1; vpnType=RouteBased; generation=Generation1; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; vpnClientConfiguration=}`
+- Default value: `@{name=[format('{0}-Vpn-Gateway', parameters('parCompanyPrefix'))]; gatewayType=Vpn; sku=VpnGw1; vpnType=RouteBased; generation=Generation1; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; vpnClientConfiguration=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
 
 ### parExpressRouteGatewayEnabled
 
@@ -470,7 +470,7 @@ Switch to enable/disable ExpressRoute virtual network gateway deployment.
 
 Configuration for ExpressRoute virtual network gateway to be deployed.
 
-- Default value: `@{name=[format('{0}-ExpressRoute-Gateway', parameters('parCompanyPrefix'))]; gatewayType=ExpressRoute; sku=ErGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=None; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=}`
+- Default value: `@{name=[format('{0}-ExpressRoute-Gateway', parameters('parCompanyPrefix'))]; gatewayType=ExpressRoute; sku=ErGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=None; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpsettings=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
 
 ### parVirtualNetworkGatewayLock
 
@@ -733,7 +733,9 @@ outBastionNsgName | string |
                     "bgpPeeringAddress": "",
                     "peerWeight": 5
                 },
-                "vpnClientConfiguration": {}
+                "vpnClientConfiguration": {},
+                "ipConfigurationName": "vnetGatewayConfig",
+                "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
             }
         },
         "parExpressRouteGatewayEnabled": {
@@ -755,7 +757,9 @@ outBastionNsgName | string |
                     "asn": "65515",
                     "bgpPeeringAddress": "",
                     "peerWeight": "5"
-                }
+                },
+                "ipConfigurationName": "vnetGatewayConfig",
+                "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
             }
         },
         "parVirtualNetworkGatewayLock": {

diff --git a/infra-as-code/bicep/modules/hubNetworking/hubNetworking-multiRegion.bicep b/infra-as-code/bicep/modules/hubNetworking/hubNetworking-multiRegion.bicep
@@ -454,6 +454,8 @@ param parVpnGatewayConfig object = {
     peerWeight: 5
   }
   vpnClientConfiguration: {}
+  ipConfigurationName: 'vnetGatewayConfig'
+  ipConfigurationActiveActiveName: 'vnetGatewayConfig2'
 }
 
 //ASN must be 65515 if deploying VPN & ER for co-existence to work: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-howto-coexist-resource-manager#limits-and-limitations
@@ -475,6 +477,8 @@ param parVpnGatewayConfigSecondaryLocation object = {
     peerWeight: 5
   }
   vpnClientConfiguration: {}
+  ipConfigurationName: 'vnetGatewayConfig'
+  ipConfigurationActiveActiveName: 'vnetGatewayConfig2'
 }
 
 @sys.description('Switch to enable/disable ExpressRoute virtual network gateway deployment.')
@@ -500,6 +504,8 @@ param parExpressRouteGatewayConfig object = {
     bgpPeeringAddress: ''
     peerWeight: '5'
   }
+  ipConfigurationName: 'vnetGatewayConfig'
+  ipConfigurationActiveActiveName: 'vnetGatewayConfig2'
 }
 
 @sys.description('Configuration for ExpressRoute virtual network gateway to be deployed in secondary location.')
@@ -519,6 +525,8 @@ param parExpressRouteGatewayConfigSecondaryLocation object = {
     bgpPeeringAddress: ''
     peerWeight: '5'
   }
+  ipConfigurationName: 'vnetGatewayConfig'
+  ipConfigurationActiveActiveName: 'vnetGatewayConfig2'
 }
 
 @sys.description('''Resource Lock Configuration for ExpressRoute Virtual Network Gateway.
@@ -1422,7 +1430,7 @@ resource resGateway 'Microsoft.Network/virtualNetworkGateways@2024-01-01' = [
         [
           {
             id: resHubVnet.id
-            name: 'vnetGatewayConfig1'
+            name: gateway.ipConfigurationName
             properties: {
               publicIPAddress: {
                 id: modGatewayPublicIp[i].outputs.outPublicIpId // Primary Public IP
@@ -1438,7 +1446,7 @@ resource resGateway 'Microsoft.Network/virtualNetworkGateways@2024-01-01' = [
           ? [
               {
                 id: resHubVnet.id
-                name: 'vnetGatewayConfig2'
+                name: gateway.ipConfigurationActiveActiveName
                 properties: {
                   publicIPAddress: {
                     id: modGatewayPublicIpActiveActive[i].outputs.outPublicIpId // Secondary Public IP
@@ -1492,7 +1500,7 @@ resource resGatewaySecondaryLocation 'Microsoft.Network/virtualNetworkGateways@2
         [
           {
             id: resHubVnetSecondaryLocation.id
-            name: 'vnetGatewayConfig1'
+            name: gateway.ipConfigurationName
             properties: {
               publicIPAddress: {
                 id: modGatewayPublicIpSecondaryLocation[i].outputs.outPublicIpId // Primary Public IP
@@ -1508,7 +1516,7 @@ resource resGatewaySecondaryLocation 'Microsoft.Network/virtualNetworkGateways@2
           ? [
               {
                 id: resHubVnetSecondaryLocation.id
-                name: 'vnetGatewayConfig2'
+                name: gateway.ipConfigurationActiveActiveName
                 properties: {
                   publicIPAddress: {
                     id: modGatewayPublicIpActiveActiveSecondaryLocation[i].outputs.outPublicIpId // Secondary Public IP

diff --git a/infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep b/infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep
@@ -301,6 +301,8 @@ param parVpnGatewayConfig object = {
     peerWeight: 5
   }
   vpnClientConfiguration: {}
+  ipConfigurationName: 'vnetGatewayConfig'
+  ipConfigurationActiveActiveName: 'vnetGatewayConfig2'
 }
 
 @sys.description('Switch to enable/disable ExpressRoute virtual network gateway deployment.')
@@ -323,6 +325,8 @@ param parExpressRouteGatewayConfig object = {
     bgpPeeringAddress: ''
     peerWeight: '5'
   }
+  ipConfigurationName: 'vnetGatewayConfig'
+  ipConfigurationActiveActiveName: 'vnetGatewayConfig2'
 }
 
 @sys.description('''Resource Lock Configuration for ExpressRoute Virtual Network Gateway.
@@ -791,7 +795,7 @@ resource resGateway 'Microsoft.Network/virtualNetworkGateways@2024-01-01' = [
         [
           {
             id: resHubVnet.id
-            name: 'vnetGatewayConfig1'
+            name: gateway.ipConfigurationName
             properties: {
               publicIPAddress: {
                 id: modGatewayPublicIp[i].outputs.outPublicIpId // Primary Public IP
@@ -807,7 +811,7 @@ resource resGateway 'Microsoft.Network/virtualNetworkGateways@2024-01-01' = [
           ? [
               {
                 id: resHubVnet.id
-                name: 'vnetGatewayConfig2'
+                name: gateway.ipConfigurationActiveActiveName
                 properties: {
                   publicIPAddress: {
                     id: modGatewayPublicIpActiveActive[i].outputs.outPublicIpId // Secondary Public IP

diff --git a/infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.all.json b/infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.all.json
@@ -137,7 +137,9 @@
           "bgpPeeringAddress": "",
           "peerWeight": "5"
         },
-        "vpnClientConfiguration": {}
+        "vpnClientConfiguration": {},
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parExpressRouteGatewayEnabled": {
@@ -159,7 +161,9 @@
           "asn": "65515",
           "bgpPeeringAddress": "",
           "peerWeight": "5"
-        }
+        },
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parTags": {

diff --git a/infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.az.all.json b/infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.az.all.json
@@ -149,7 +149,9 @@
           "bgpPeeringAddress": "",
           "peerWeight": "5"
         },
-        "vpnClientConfiguration": {}
+        "vpnClientConfiguration": {},
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parExpressRouteGatewayEnabled": {
@@ -171,7 +173,9 @@
           "asn": "65515",
           "bgpPeeringAddress": "",
           "peerWeight": "5"
-        }
+        },
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parTags": {

diff --git a/...e/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.az.multiRegion.all.json b/...e/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.az.multiRegion.all.json
@@ -264,7 +264,9 @@
           "bgpPeeringAddress": "",
           "peerWeight": "5"
         },
-        "vpnClientConfiguration": {}
+        "vpnClientConfiguration": {},
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parVpnGatewayConfigSecondaryLocation": {
@@ -284,7 +286,9 @@
           "bgpPeeringAddress": "",
           "peerWeight": "5"
         },
-        "vpnClientConfiguration": {}
+        "vpnClientConfiguration": {},
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parExpressRouteGatewayEnabled": {
@@ -306,7 +310,9 @@
           "asn": "65515",
           "bgpPeeringAddress": "",
           "peerWeight": "5"
-        }
+        },
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parExpressRouteGatewayEnabledSecondaryLocation": {

diff --git a/infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.min.json b/infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.min.json
@@ -94,7 +94,9 @@
           "asn": "65515",
           "bgpPeeringAddress": "",
           "peerWeight": "5"
-        }
+        },
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parExpressRouteGatewayEnabled": {
@@ -116,7 +118,9 @@
           "asn": "65515",
           "bgpPeeringAddress": "",
           "peerWeight": "5"
-        }
+        },
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parTelemetryOptOut": {

diff --git a/infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.all.json b/infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.all.json
@@ -170,7 +170,9 @@
           "bgpPeeringAddress": "",
           "peerWeight": "5"
         },
-        "vpnClientConfiguration": {}
+        "vpnClientConfiguration": {},
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parExpressRouteGatewayEnabled": {
@@ -192,7 +194,9 @@
           "asn": "65515",
           "bgpPeeringAddress": "",
           "peerWeight": "5"
-        }
+        },
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parTags": {

diff --git a/infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.min.json b/infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.min.json
@@ -130,7 +130,9 @@
           "asn": "65515",
           "bgpPeeringAddress": "",
           "peerWeight": "5"
-        }
+        },
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parExpressRouteGatewayEnabled": {
@@ -152,7 +154,9 @@
           "asn": "65515",
           "bgpPeeringAddress": "",
           "peerWeight": "5"
-        }
+        },
+        "ipConfigurationName": "vnetGatewayConfig",
+        "ipConfigurationActiveActiveName": "vnetGatewayConfig2"
       }
     },
     "parTelemetryOptOut": {