Skip to content

Commit 1eb52c6

Browse files
docs(readme): update module usage
1 parent bad7cf6 commit 1eb52c6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ The advantage of the PIP is that it will stay, whenever you need to redo the Fir
3838

3939
| Name | Description | Type | Default | Required |
4040
|------|-------------|------|---------|:--------:|
41-
| <a name="input_create_new_resource_group"></a> [create\_new\_resource\_group](#input\_create\_new\_resource\_group) | If true, a new Resourcegroup will be created | `bool` | `false` | no |
42-
| <a name="input_hub_bgp_peers"></a> [hub\_bgp\_peers](#input\_hub\_bgp\_peers) | This variable defines the configuration for BGP peers.<br/>- virtual\_hub\_id: The ID of the virtual hub (string).<br/>- name: The name of the BGP peer (string).<br/>- peer\_asn: The ASN of the BGP peer (number).<br/>- peer\_ip: The IP address of the BGP peer (string).<br/>- vnet\_connection\_id: The ID of the VNET Hub connection (string). | <pre>map(object({<br/> virtual_hub_id = string<br/> name = string<br/> peer_asn = number<br/> peer_ip = string<br/> vnet_connection_id = string<br/> }))</pre> | `{}` | no |
4341
| <a name="input_location"></a> [location](#input\_location) | The location/region where the VWAN will be created | `string` | n/a | yes |
4442
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | The name of the resource group where the VWAN will be created | `string` | n/a | yes |
45-
| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to assign to the resource. | `map(string)` | `{}` | no |
4643
| <a name="input_virtual_hubs"></a> [virtual\_hubs](#input\_virtual\_hubs) | This variable defines the configuration for virtual hubs, including firewall settings, routing, and security configurations.<br/><br/>- virtual\_hub\_name: The name of the virtual hub (string).<br/>- location: The Azure region where the virtual hub is deployed (string).<br/>- address\_prefix: The IP address prefix assigned to the virtual hub (string).<br/>- routing\_intent\_name: The name of the routing intent associated with the hub (string).<br/>- firewall\_deploy: Whether to deploy an Azure Firewall in the Virtual Hub (optional, defaults to true) (bool).<br/>- firewall\_classic\_ip\_config: Whether to use classic IP configuration for the firewall (optional, defaults to false) (bool).<br/>- firewall\_name: The name of the Azure Firewall deployed within the virtual hub (string).<br/>- firewall\_zones: Availability zones where the firewall is deployed (set of strings).<br/>- firewall\_policy\_name: The name of the firewall policy applied to the firewall (string).<br/>- firewall\_sku\_tier**: The SKU tier of the firewall (e.g., "Standard" or "Premium") (string).<br/>- firewall\_public\_ip\_count: The number of public IPs allocated to the firewall (optional, either this or firewall\_public\_ip\_prefix\_length should be specified) (number).<br/>- firewall\_public\_ip\_prefix\_length: The prefix length for the public IP prefix reservation (optional, either this or firewall\_public\_ip\_count should be specified) (number).<br/>- firewall\_public\_ip\_ddos\_protection\_mode: The DDoS protection mode for public IPs (optional, default is "VirtualNetworkInherited") (string).<br/>- firewall\_public\_ip\_ddos\_protection\_plan\_id: The ID of the DDoS protection plan for public IPs (optional, required if ddos\_protection\_mode is "Enabled") (string).<br/>- firewall\_threat\_intelligence\_mode: The mode of threat intelligence for the firewall (string).<br/>- firewall\_intrusion\_detection\_mode: The mode of intrusion detection (e.g., "Alert" or "Deny") (optional, defaults to "Alert") (string).<br/>- firewall\_dns\_proxy\_enabled: Indicates whether the DNS proxy is enabled for the firewall (bool).<br/>- firewall\_dns\_servers**: A list of DNS servers configured for the firewall (list of strings).<br/>- firewall\_intrusion\_detection\_private\_ranges: A list of private IP ranges for intrusion detection (optional, defaults to an empty list) (list of strings).<br/>- firewall\_custom\_ip\_configurations: A list of custom IP configurations to add to the firewall (optional, defaults to an empty list).<br/> - name: The name of the IP configuration (string).<br/> - public\_ip\_address\_id: The ID of the public IP address (string).<br/>- firewall\_intrusion\_detection\_signature\_overrides: A list of firewall intrusion detection signature overrides (optional, defaults to an empty list).<br/> - id: The signature ID (string).<br/> - state: The override state for the signature (string).<br/>- firewall\_intrusion\_detection\_traffic\_bypass: A list of rules for bypassing intrusion detection (optional, defaults to an empty list).<br/> - name: The name of the bypass rule (string).<br/> - protocol: The network protocol (e.g., "TCP", "UDP") (string).<br/> - description: A description of the bypass rule (optional) (string).<br/> - source\_addresses: A list of source IP addresses (optional, defaults to an empty list) (list of strings).<br/> - source\_ip\_groups: A list of source IP groups (optional, defaults to an empty list) (list of strings).<br/> - destination\_addresses: A list of destination IP addresses (optional, defaults to an empty list) (list of strings).<br/> - destination\_ports: A list of destination ports (optional, defaults to an empty list) (list of strings).<br/> - destination\_ip\_groups: A list of destination IP groups (optional, defaults to an empty list) (list of strings).<br/>- firewall\_intrusion\_detection\_tls\_certificate: A list of TLS certificates for intrusion detection (optional, defaults to an empty list).<br/> - key\_vault\_secret\_id: The Key Vault secret ID storing the certificate (string).<br/> - name: The name of the TLS certificate (string). | <pre>map(object({<br/> virtual_hub_name = string<br/> address_prefix = string<br/> location = string<br/> enable_routing_intent = optional(bool, true)<br/> routing_intent_name = optional(string)<br/> firewall_deploy = optional(bool, true)<br/> firewall_classic_ip_config = optional(bool, false)<br/> firewall_name = optional(string)<br/> firewall_zones = optional(set(string), ["1", "2", "3"])<br/> firewall_policy_name = optional(string)<br/> firewall_sku_tier = optional(string)<br/> firewall_public_ip_count = optional(number)<br/> firewall_public_ip_prefix_length = optional(number, 0)<br/> firewall_public_ip_ddos_protection_mode = optional(string, "VirtualNetworkInherited")<br/> firewall_public_ip_ddos_protection_plan_id = optional(string)<br/> firewall_threat_intelligence_mode = optional(string, "Deny")<br/> firewall_intrusion_detection_mode = optional(string, "Deny")<br/> firewall_dns_proxy_enabled = optional(bool, true)<br/> firewall_dns_servers = optional(list(string))<br/> firewall_intrusion_detection_private_ranges = optional(list(string), [])<br/> firewall_custom_ip_configurations = optional(list(object({<br/> name = string<br/> public_ip_address_id = string<br/> })), [])<br/> firewall_intrusion_detection_signature_overrides = optional(list(object({<br/> id = string<br/> state = string<br/> })), [])<br/> firewall_intrusion_detection_traffic_bypass = optional(list(object({<br/> name = string<br/> protocol = string<br/> description = optional(string)<br/> source_addresses = optional(list(string), [])<br/> source_ip_groups = optional(list(string), [])<br/> destination_addresses = optional(list(string), [])<br/> destination_ports = optional(list(string), [])<br/> destination_ip_groups = optional(list(string), [])<br/> })), [])<br/> firewall_intrusion_detection_tls_certificate = optional(object({<br/> key_vault_secret_id = string<br/> name = string<br/> }), null)<br/> }))</pre> | n/a | yes |
4744
| <a name="input_virtual_wan"></a> [virtual\_wan](#input\_virtual\_wan) | This variable defines the configuration for the virtual WAN.<br/>- name: The name of the virtual WAN (string).<br/>- type: The type of the virtual WAN (string).<br/>- disable\_vpn\_encryption: Whether VPN encryption is disabled (bool).<br/>- allow\_branch\_to\_branch\_traffic: Whether branch-to-branch traffic is allowed (bool).<br/>- office365\_local\_breakout\_category: The category for Office 365 local breakout (string). | <pre>object({<br/> name = string<br/> type = optional(string, "Standard")<br/> disable_vpn_encryption = optional(bool, false)<br/> allow_branch_to_branch_traffic = optional(bool, true)<br/> office365_local_breakout_category = optional(string, "None")<br/> })</pre> | n/a | yes |
45+
| <a name="input_create_new_resource_group"></a> [create\_new\_resource\_group](#input\_create\_new\_resource\_group) | If true, a new Resourcegroup will be created | `bool` | `false` | no |
46+
| <a name="input_hub_bgp_peers"></a> [hub\_bgp\_peers](#input\_hub\_bgp\_peers) | This variable defines the configuration for BGP peers.<br/>- virtual\_hub\_id: The ID of the virtual hub (string).<br/>- name: The name of the BGP peer (string).<br/>- peer\_asn: The ASN of the BGP peer (number).<br/>- peer\_ip: The IP address of the BGP peer (string).<br/>- vnet\_connection\_id: The ID of the VNET Hub connection (string). | <pre>map(object({<br/> virtual_hub_id = string<br/> name = string<br/> peer_asn = number<br/> peer_ip = string<br/> vnet_connection_id = string<br/> }))</pre> | `{}` | no |
47+
| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to assign to the resource. | `map(string)` | `{}` | no |
4848

4949
## Outputs
5050

0 commit comments

Comments
 (0)