Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Add gateway udt and add allowed values #947

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

refactor: Add gateway udt and add allowed values #947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c941aa
Add gateway udt and add allowed values
oZakari Jan 23, 2025
191217a
Fix sku reference
oZakari Jan 23, 2025
33a53d9
Merge branch 'main' into update-gatewayskus
oZakari Jan 23, 2025
b3cecba
Generate Parameter Markdowns [oZakari/1ded2315]
github-actions[bot] Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions ...de/bicep/modules/hubNetworking/generateddocs/hubNetworking-multiRegion.bicep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ALZ Bicep - Hub Networking Module
# ALZ Bicep - Hub Networking Multi-Region Module

ALZ Bicep Module used to set up Hub Networking
ALZ Bicep Module used to set up Hub Networking in two regions.

## Parameters

Expand Down Expand Up @@ -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=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
- Default value: `@{name=[format('{0}-Vpn-Gateway-{1}', parameters('parCompanyPrefix'), parameters('parLocation'))]; gatewayType=Vpn; sku=ErGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=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=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
- Default value: `@{name=[format('{0}-Vpn-Gateway-{1}', parameters('parCompanyPrefix'), parameters('parSecondaryLocation'))]; gatewayType=Vpn; sku=VpnGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=Generation1; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpSettings=; vpnClientConfiguration=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`

### parExpressRouteGatewayEnabled

Expand All @@ -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=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
- 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=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
- 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

Expand Down Expand Up @@ -1160,15 +1160,15 @@ outBastionNsgNameSecondaryLocation | string |
"value": {
"name": "[format('{0}-Vpn-Gateway-{1}', parameters('parCompanyPrefix'), parameters('parLocation'))]",
"gatewayType": "Vpn",
"sku": "VpnGw1",
"sku": "ErGw1AZ",
"vpnType": "RouteBased",
"generation": "Generation1",
"vpnGatewayGeneration": "Generation1",
"enableBgp": false,
"activeActive": false,
"enableBgpRouteTranslationForNat": false,
"enableDnsForwarding": false,
"bgpPeeringAddress": "",
"bgpsettings": {
"bgpSettings": {
"asn": 65515,
"bgpPeeringAddress": "",
"peerWeight": 5
Expand All @@ -1182,15 +1182,15 @@ outBastionNsgNameSecondaryLocation | string |
"value": {
"name": "[format('{0}-Vpn-Gateway-{1}', parameters('parCompanyPrefix'), parameters('parSecondaryLocation'))]",
"gatewayType": "Vpn",
"sku": "VpnGw1",
"sku": "VpnGw1AZ",
"vpnType": "RouteBased",
"generation": "Generation1",
"vpnGatewayGeneration": "Generation1",
"enableBgp": false,
"activeActive": false,
"enableBgpRouteTranslationForNat": false,
"enableDnsForwarding": false,
"bgpPeeringAddress": "",
"bgpsettings": {
"bgpSettings": {
"asn": 65515,
"bgpPeeringAddress": "",
"peerWeight": 5
Expand Down Expand Up @@ -1218,10 +1218,10 @@ outBastionNsgNameSecondaryLocation | string |
"enableBgpRouteTranslationForNat": false,
"enableDnsForwarding": false,
"bgpPeeringAddress": "",
"bgpsettings": {
"asn": "65515",
"bgpSettings": {
"asn": 65515,
"bgpPeeringAddress": "",
"peerWeight": "5"
"peerWeight": 5
},
"ipConfigurationName": "vnetGatewayConfig",
"ipConfigurationActiveActiveName": "vnetGatewayConfig2"
Expand All @@ -1239,10 +1239,10 @@ outBastionNsgNameSecondaryLocation | string |
"enableBgpRouteTranslationForNat": false,
"enableDnsForwarding": false,
"bgpPeeringAddress": "",
"bgpsettings": {
"asn": "65515",
"bgpSettings": {
"asn": 65515,
"bgpPeeringAddress": "",
"peerWeight": "5"
"peerWeight": 5
},
"ipConfigurationName": "vnetGatewayConfig",
"ipConfigurationActiveActiveName": "vnetGatewayConfig2"
Expand Down
16 changes: 8 additions & 8 deletions infra-as-code/bicep/modules/hubNetworking/generateddocs/hubNetworking.bicep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
- Default value: `@{name=[format('{0}-Vpn-Gateway', parameters('parCompanyPrefix'))]; gatewayType=Vpn; sku=VpnGw1AZ; vpnType=RouteBased; vpnGatewayGeneration=Generation1; enableBgp=False; activeActive=False; enableBgpRouteTranslationForNat=False; enableDnsForwarding=False; bgpPeeringAddress=; bgpSettings=; vpnClientConfiguration=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`

### parExpressRouteGatewayEnabled

Expand All @@ -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=; ipConfigurationName=vnetGatewayConfig; ipConfigurationActiveActiveName=vnetGatewayConfig2}`
- 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

Expand Down Expand Up @@ -720,15 +720,15 @@ outBastionNsgName | string |
"value": {
"name": "[format('{0}-Vpn-Gateway', parameters('parCompanyPrefix'))]",
"gatewayType": "Vpn",
"sku": "VpnGw1",
"sku": "VpnGw1AZ",
"vpnType": "RouteBased",
"generation": "Generation1",
"vpnGatewayGeneration": "Generation1",
"enableBgp": false,
"activeActive": false,
"enableBgpRouteTranslationForNat": false,
"enableDnsForwarding": false,
"bgpPeeringAddress": "",
"bgpsettings": {
"bgpSettings": {
"asn": 65515,
"bgpPeeringAddress": "",
"peerWeight": 5
Expand All @@ -753,10 +753,10 @@ outBastionNsgName | string |
"enableBgpRouteTranslationForNat": false,
"enableDnsForwarding": false,
"bgpPeeringAddress": "",
"bgpsettings": {
"asn": "65515",
"bgpSettings": {
"asn": 65515,
"bgpPeeringAddress": "",
"peerWeight": "5"
"peerWeight": 5
},
"ipConfigurationName": "vnetGatewayConfig",
"ipConfigurationActiveActiveName": "vnetGatewayConfig2"
Expand Down
95 changes: 75 additions & 20 deletions infra-as-code/bicep/modules/hubNetworking/hubNetworking-multiRegion.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
metadata name = 'ALZ Bicep - Hub Networking Module'
metadata description = 'ALZ Bicep Module used to set up Hub Networking'
metadata name = 'ALZ Bicep - Hub Networking Multi-Region Module'
metadata description = 'ALZ Bicep Module used to set up Hub Networking in two regions.'

type subnetOptionsType = ({
@description('Name of subnet.')
Expand All @@ -18,6 +18,61 @@ type subnetOptionsType = ({
delegation: string?
})[]

type virtualNetworkGatewayOptionsType = {
@description('Name of the gateway.')
name: string

@description('Type of gateway.')
gatewayType: ('Vpn' | 'ExpressRoute')

@description('SKU of the gateway.')
sku: ('Basic' | 'VpnGw1AZ' | 'VpnGw2AZ' | 'VpnGw3AZ' | 'VpnGw4AZ' | 'VpnGw5AZ' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'ErGwScale' | 'HighPerformance' | 'Standard' | 'UltraPerformance')

@description('Type of VPN.')
vpnType: string

@description('Generation of the VPN Gateway.')
vpnGatewayGeneration: ('Generation1' | 'Generation2' | 'None' )

@description('Enable BGP on the gateway.')
enableBgp: bool

@description('Enable Active-Active on the gateway.')
activeActive: bool

@description('Enable BGP Route Translation for NAT on the gateway.')
enableBgpRouteTranslationForNat: bool

@description('Enable DNS Forwarding on the gateway.')
enableDnsForwarding: bool

@description('BGP Peering Address for the gateway.')
bgpPeeringAddress: string?

@description('BGP Settings for the gateway.')
bgpSettings: {
@minValue(0)
@maxValue(4294967295)
@description('ASN for the gateway.')
asn: int

@description('BGP Peering Address for the gateway.')
bgpPeeringAddress: string?

@description('Peer Weight for the gateway.')
peerWeight: int
}

@description('VPN Client Configuration for the gateway.')
vpnClientConfiguration: object?

@description('Name of the IP Configuration for the gateway.')
ipConfigurationName: string

@description('Name of the Active-Active IP Configuration for the gateway.')
ipConfigurationActiveActiveName: string
}

type lockType = {
@description('Optional. Specify the name of lock.')
name: string?
Expand Down Expand Up @@ -437,18 +492,18 @@ param parVpnGatewayEnabledSecondaryLocation bool = true

//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
@sys.description('Configuration for VPN virtual network gateway to be deployed.')
param parVpnGatewayConfig object = {
param parVpnGatewayConfig virtualNetworkGatewayOptionsType = {
name: '${parCompanyPrefix}-Vpn-Gateway-${parLocation}'
gatewayType: 'Vpn'
sku: 'VpnGw1'
sku: 'ErGw1AZ'
vpnType: 'RouteBased'
generation: 'Generation1'
vpnGatewayGeneration: 'Generation1'
enableBgp: false
activeActive: false
enableBgpRouteTranslationForNat: false
enableDnsForwarding: false
bgpPeeringAddress: ''
bgpsettings: {
bgpSettings: {
asn: 65515
bgpPeeringAddress: ''
peerWeight: 5
Expand All @@ -460,18 +515,18 @@ param parVpnGatewayConfig object = {

//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
@sys.description('Configuration for VPN virtual network gateway to be deployed in secondary location.')
param parVpnGatewayConfigSecondaryLocation object = {
param parVpnGatewayConfigSecondaryLocation virtualNetworkGatewayOptionsType = {
name: '${parCompanyPrefix}-Vpn-Gateway-${parSecondaryLocation}'
gatewayType: 'Vpn'
sku: 'VpnGw1'
sku: 'VpnGw1AZ'
vpnType: 'RouteBased'
generation: 'Generation1'
vpnGatewayGeneration: 'Generation1'
enableBgp: false
activeActive: false
enableBgpRouteTranslationForNat: false
enableDnsForwarding: false
bgpPeeringAddress: ''
bgpsettings: {
bgpSettings: {
asn: 65515
bgpPeeringAddress: ''
peerWeight: 5
Expand All @@ -488,7 +543,7 @@ param parExpressRouteGatewayEnabled bool = true
param parExpressRouteGatewayEnabledSecondaryLocation bool = true

@sys.description('Configuration for ExpressRoute virtual network gateway to be deployed.')
param parExpressRouteGatewayConfig object = {
param parExpressRouteGatewayConfig virtualNetworkGatewayOptionsType = {
name: '${parCompanyPrefix}-ExpressRoute-Gateway'
gatewayType: 'ExpressRoute'
sku: 'ErGw1AZ'
Expand All @@ -499,17 +554,17 @@ param parExpressRouteGatewayConfig object = {
enableBgpRouteTranslationForNat: false
enableDnsForwarding: false
bgpPeeringAddress: ''
bgpsettings: {
asn: '65515'
bgpSettings: {
asn: 65515
bgpPeeringAddress: ''
peerWeight: '5'
peerWeight: 5
}
ipConfigurationName: 'vnetGatewayConfig'
ipConfigurationActiveActiveName: 'vnetGatewayConfig2'
}

@sys.description('Configuration for ExpressRoute virtual network gateway to be deployed in secondary location.')
param parExpressRouteGatewayConfigSecondaryLocation object = {
param parExpressRouteGatewayConfigSecondaryLocation virtualNetworkGatewayOptionsType = {
name: '${parCompanyPrefix}-ExpressRoute-Gateway'
gatewayType: 'ExpressRoute'
sku: 'ErGw1AZ'
Expand All @@ -520,10 +575,10 @@ param parExpressRouteGatewayConfigSecondaryLocation object = {
enableBgpRouteTranslationForNat: false
enableDnsForwarding: false
bgpPeeringAddress: ''
bgpsettings: {
asn: '65515'
bgpSettings: {
asn: 65515
bgpPeeringAddress: ''
peerWeight: '5'
peerWeight: 5
}
ipConfigurationName: 'vnetGatewayConfig'
ipConfigurationActiveActiveName: 'vnetGatewayConfig2'
Expand Down Expand Up @@ -1406,7 +1461,7 @@ resource resGateway 'Microsoft.Network/virtualNetworkGateways@2024-05-01' = [
enableDnsForwarding: gateway.enableDnsForwarding
bgpSettings: (gateway.enableBgp) ? gateway.bgpSettings : null
gatewayType: gateway.gatewayType
vpnGatewayGeneration: (toLower(gateway.gatewayType) == 'vpn') ? gateway.generation : 'None'
vpnGatewayGeneration: (toLower(gateway.gatewayType) == 'vpn') ? gateway.vpnGatewayGeneration : 'None'
vpnType: gateway.vpnType
sku: {
name: gateway.sku
Expand Down Expand Up @@ -1476,7 +1531,7 @@ resource resGatewaySecondaryLocation 'Microsoft.Network/virtualNetworkGateways@2
enableDnsForwarding: gateway.enableDnsForwarding
bgpSettings: (gateway.enableBgp) ? gateway.bgpSettings : null
gatewayType: gateway.gatewayType
vpnGatewayGeneration: (toLower(gateway.gatewayType) == 'vpn') ? gateway.generation : 'None'
vpnGatewayGeneration: (toLower(gateway.gatewayType) == 'vpn') ? gateway.vpnGatewayGeneration : 'None'
vpnType: gateway.vpnType
sku: {
name: gateway.sku
Expand Down
Loading
Loading