Virtual Hub within a Virtual WAN

Usage - Module

Virtual Hub within a Virtual WAN

module "virtual_hub" {
  source  = "sironite/virtual_hub/azurerm"
  version = "X.X.X"

  vhub_name           = "example-vhub"
  resource_group_name = "example-rg"
  location            = "eastus"

  address_prefix = "10.45.10.0/23"
  virtual_wan_id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Network/virtualWans/example-vwan"

}

Providers

Name	Version
azurerm	>=2.0.0

Modules

Name	Source	Version
express_route_gateway	./modules/azurerm_express_route_gateway	n/a
point_to_site_vpn_gateway	./modules/azurerm_point_to_site_vpn_gateway	n/a
vpn_gateway	./modules/azurerm_vpn_gateway	n/a

Resources

Name	Type
azurerm_virtual_hub.this	resource

Inputs

Name	Description	Type	Required
address_prefix	The address prefix of the virtual hub.	string	yes
connection_configuration_name	The name of the connection configuration for the Point-to-Site VPN Gateway.	string	yes
location	The location of the virtual hub.	string	yes
resource_group_name	The name of the resource group in which to create the virtual hub.	string	yes
vhub_name	The name of the virtual hub.	string	yes
vpn_client_address_pool_address_prefixes	The list of address prefixes to use for the VPN client address pool.	list(string)	yes
vwan_id	The ID of the virtual WAN.	string	yes
allow_non_virtual_wan_traffic	Whether to allow non-virtual WAN traffic to flow through the ExpressRoute gateway.	bool	no
bgp_route_translation_for_nat_enabled	Whether BGP route translation for NAT is enabled on the VPN gateway.	bool	no
bgp_settings_asn	The ASN for the BGP settings of the VPN gateway.	number	no
bgp_settings_peer_weight	The peer weight for the BGP settings of the VPN gateway.	number	no
dns_servers	The list of DNS servers to use for the Point-to-Site VPN Gateway.	list(string)	no
enable_bgp_settings	Whether to enable BGP settings for the VPN gateway.	bool	no
enable_express_route_gateway	Whether to enable an ExpressRoute gateway for the virtual hub.	bool	no
enable_instance_0_bgp_peering_address	Whether to enable the instance 0 BGP peering address for the VPN gateway.	bool	no
enable_instance_1_bgp_peering_address	Whether to enable the instance 1 BGP peering address for the VPN gateway.	bool	no
enable_point_to_site_vpn_gateway	Whether to enable a point-to-site VPN gateway for the virtual hub.	bool	no
enable_route	Whether to enable a route for the virtual hub.	bool	no
enable_vpn_gateway	Whether to enable a VPN gateway for the virtual hub.	bool	no
express_route_gateway_name	The name of the ExpressRoute gateway.	string	no
express_route_scale_units	The number of scale units to allocate to the ExpressRoute gateway.	number	no
hub_routing_preference	The routing preference of the virtual hub.	string	no
instance_0_bgp_peering_address_custom_ips	The custom IPs for the instance 0 BGP peering address of the VPN gateway.	list(string)	no
instance_1_bgp_peering_address_custom_ips	The custom IPs for the instance 1 BGP peering address of the VPN gateway.	list(string)	no
next_hop_ip_address	The IP address of the next hop for the route.	string	no
point_to_site_vpn_gateway_name	The name of the Point-to-Site VPN Gateway.	string	no
point_to_site_vpn_gateway_scale_unit	The scale unit of the Point-to-Site VPN Gateway.	number	no
route_address_prefixes	The address prefixes for the route.	list(string)	no
route_associated_route_table_id	The ID of the associated route table for the Point-to-Site VPN Gateway.	string	no
route_inbound_route_map_id	The ID of the inbound route map for the Point-to-Site VPN Gateway.	string	no
route_outbound_route_map_id	The ID of the outbound route map for the Point-to-Site VPN Gateway.	string	no
route_propagated_route_table_ids	The ID of the propagated route table for the Point-to-Site VPN Gateway.	list(string)	no
route_propagated_route_table_labels	The label of the propagated route table for the Point-to-Site VPN Gateway.	list(string)	no
routing_preference	The routing preference for the VPN gateway.	string	no
routing_preference_internet_enabled	Whether or not to enable Internet routing preference for the Point-to-Site VPN Gateway.	bool	no
sku	The SKU of the virtual hub.	string	no
tags	A mapping of tags to assign to the resource.	map(string)	no
vpn_gateway_name	The name of the VPN gateway.	string	no
vpn_gateway_scale_unit	The scale unit for the VPN gateway.	number	no
vpn_server_configuration_id	The ID of the VPN server configuration to use for the Point-to-Site VPN Gateway.	string	no

Outputs

Name	Description
express_route_gateway_id	The ID of the ExpressRoute gateway.
point_to_site_vpn_gateway_id	The ID of the point-to-site VPN gateway.
virtual_hub_id	The ID of the virtual hub.
virtual_hub_name	The name of the virtual hub.
vpn_gateway_id	The ID of the VPN gateway.

Related documentation