This is the route server resource module for the Azure Verified Modules library. This module deploys a virtual network based route server along with common associated resources. It leverages the both the AzureRM and AzAPI providers and sets a number of initial defaults to minimize the overall inputs for simple configurations.
Important
As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules WILL NOT be published at version 1.0.0 or higher at this time.
However, it is important to note that this DOES NOT mean that this module cannot be consumed and utilized. It CAN be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat this just like any other IaC module and raise issues or feature requests against it as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc.
The following requirements are needed by this module:
The following providers are used by this module:
The following resources are used by this module:
- azapi_resource.route_server_hub (resource)
- azapi_resource.route_server_ip_config_dynamic (resource)
- azurerm_management_lock.this (resource)
- azurerm_public_ip.route_server_pip (resource)
- azurerm_resource_group_template_deployment.telemetry (resource)
- azurerm_role_assignment.this (resource)
- azurerm_virtual_hub_bgp_connection.this (resource)
- random_id.telem (resource)
- time_sleep.wait_300_seconds (resource)
- azurerm_virtual_hub.this (data source)
The following input variables are required:
Description: Azure region where the resource should be deployed.
Type: string
Description: The name of the this route server resource.
Type: string
Description: The resource group where the resources will be deployed.
Type: string
Description: The Azure Resource ID for the resource group where the resources will be deployed.
Type: string
Description: The Azure resource ID for the route server subnet where this route server resource will be deployed.
Type: string
The following input variables are optional (have default values):
Description: A map of bgp connections to make on each route server."
<map key>- An arbitrary map key to differentiate each instance of the map.name- (Required) - The name to use for the bgp connectionpeer_asn- (Required) - The ASN for the peer NVApeer_ip- (Required) - The IP address for the peer NVA
Type:
map(object({
name = string
peer_asn = string
peer_ip = string
}))Default: {}
Description: Should the branch to branch feature be enabled. Defaults to false.
Type: bool
Default: false
Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetryinfo.
If it is set to false, then no telemetry will be collected.
Type: bool
Default: true
Description: The routing preference for this route server. Valid values are ASPath, ExpressRoute, or VpnGateway. Defaults to ExpressRoute
Type: string
Default: "ExpressRoute"
Description: Controls the Resource Lock configuration for this resource. The following properties can be specified:
kind- (Required) The type of lock. Possible values are\"CanNotDelete\"and\"ReadOnly\".name- (Optional) The name of the lock. If not specified, a name will be generated based on thekindvalue. Changing this forces the creation of a new resource.
Type:
object({
kind = string
name = optional(string, null)
})Default: null
Description: The private ip address to use for the route server IP_configuration if the private_ip_allocation_method is set to Static.
Type: string
Default: null
Description: The private IP Address allocation method for this route server. Valid values are Static or Dynamic. Defaults to Dynamic.
Type: string
Default: "Dynamic"
Description: A map of role assignments to create on the . The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
role_definition_id_or_name- The ID or name of the role definition to assign to the principal.principal_id- The ID of the principal to assign the role to.description- (Optional) The description of the role assignment.skip_service_principal_aad_check- (Optional) If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.condition- (Optional) The condition which will be used to scope the role assignment.condition_version- (Optional) The version of the condition syntax. Leave asnullif you are not using a condition, if you are then valid values are '2.0'.delegated_managed_identity_resource_id- (Optional) The delegated Azure Resource Id which contains a Managed Identity. Changing this forces a new resource to be created. This field is only used in cross-tenant scenario.principal_type- (Optional) The type of theprincipal_id. Possible values areUser,GroupandServicePrincipal. It is necessary to explicitly set this attribute when creating role assignments if the principal creating the assignment is constrained by ABAC rules that filters on the PrincipalType attribute.
Note: only set
skip_service_principal_aad_checkto true if you are assigning a role to a service principal.
Type:
map(object({
role_definition_id_or_name = string
principal_id = string
description = optional(string, null)
skip_service_principal_aad_check = optional(bool, false)
condition = optional(string, null)
condition_version = optional(string, null)
delegated_managed_identity_resource_id = optional(string, null)
principal_type = optional(string, null)
}))Default: {}
Description: The name for the public ip address resource associated with the route server.
Type: string
Default: null
Description: (Optional) - The map of tags to be applied to the resource
Type: map(string)
Default: null
The following outputs are exported:
Description: This is the full output for the resource. It contains the following properties:
id- type: string - The Azure Resource ID of the virtual hub resource that this route server is associated to.location- type: string - The azure location of the route server resource.name- type: string - The name of the route server resource.- `tags' - type: map(string) - A tags map for any directly assigned tags for the route server resource.
- 'virtual_router_asn` - type: number - The ASN number for the route server resource.
virtual_router_ips- type: list(string) - A list containing the peer ip's for route server.
No modules.
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.