Feature: Added new deployment toggles to hub-spoke

[oZakari]

Overview/Summary

Add additional deployment toggles for the hub-spoke module for feature parity with the VWAN module.

This PR fixes/adds/changes/removes

1. Added VPN and ER gateway deployment toggles

Breaking Changes

1. None

Testing Evidence

Validated the following with both parVpnGatewayConfig and parExpressRouteGatewayConfig objects containing data:

• When testing with parVpnGatewayEnabled to true and parExpressRouteGatewayEnabled. Only VPN GW resources provisioned.
• When testing with parVpnGatewayEnabled to false and parExpressRouteGatewayEnabled false. Only ER GW resources provisioned.
• When both params set to true both sets of resources created.
• When both params set to false, both sets of resources not provisioned.

As part of this Pull Request I have

• Read the Contribution Guide and ensured this PR is compliant with the guide
• Ensured the resource API versions in .bicep file/s I am adding/editing are using the latest API version possible
• Checked for duplicate Pull Requests
• Associated it with relevant GitHub Issues
• (ALZ Bicep Core Team Only) Associated it with relevant ADO Items
• Ensured my code/branch is up-to-date with the latest changes in the main branch
• Performed testing and provided evidence.
• Updated one or more of the following tests (if required)
  • Unit
  • Linting
  • E2E (End-To-End)
  • ValidateAzCloud (Base validation in Azure Cloud)
  • ValidateMcCloud (Base validation in Azure China Cloud)
• Updated relevant and associated documentation (e.g. Contribution Guide, Module READMEs, Wiki Docs etc.)
• If relevant, created or updated Code Tours here

[oZakari]

/azp run validateazcloud

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[FallenHoot]

The following is missing to make this work as it is now. Without this, it will check if a subnet is created with GatewaySubnet

resource resGatewaySubnetRef 'Microsoft.Network/virtualNetworks/subnets@2023-02-01' existing = if (parVpnGatewayEnabled || parExpressRouteGatewayEnabled) {
  parent: resHubVnet
  name: 'GatewaySubnet'
}

I also noticed that varVpnGwConfig and varErGwConfig will deploy the PublicIP by default. I want to leave the code in for GwConfig, because maybe I want to use it later. With the toggles/boolean, we are now able to remove the check if empty and simple check if true/false. If it is false, then it gives the json('{"name": "noconfigVpn"}'). Resulting in Gateway Public IP to not being created.

var varVpnGwConfig = ((parVpnGatewayEnabled) ? parVpnGatewayConfig : json('{"name": "noconfigVpn"}'))

var varErGwConfig = ((parExpressRouteGatewayEnabled) ? parExpressRouteGatewayConfig : json('{"name": "noconfigEr"}'))

Also, a minor wording issue:

@sys.description('Switch to enable/disable VPN virtual network gateway deployment.')
param parExpressRouteGatewayEnabled bool = true

Should say.

@sys.description('Switch to enable/disable ExpressRoute virtual network gateway deployment.')
param parExpressRouteGatewayEnabled bool = true

[oZakari]

Thanks @FallenHoot, as mentioned in Teams thread, going to open separate PR for subnet related changes. Have included your other recommendations though.

[oZakari]

/azp run validateazcloud

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[jtracey93]

Just a couple of comments