Skip to content

Commit 10097c9

Browse files
committed
updating documentation
1 parent 8b94eb9 commit 10097c9

File tree

4 files changed

+30
-10
lines changed

4 files changed

+30
-10
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ module "frontdoor" {
113113

114114
## **`backend_pools`** - Backends and backend pools
115115

116-
A backend pool in Front Door refers to the set of backends that receive similar traffic for their app. In other words, it's a logical grouping of your app instances across the world that receive the same traffic and respond with expected behavior. These backends are deployed across different regions or within the same region. All backends can be in Active/Active deployment mode or what is defined as Active/Passive configuration.
116+
A backend pool in Front Door refers to the set of backends that receive similar traffic for their app. In other words, A logical grouping of app instances across the world that receive the same traffic and respond with expected behavior. These backends are deployed across different regions or within the same region. All backends can be in `Active/Active` deployment mode or what is defined as `Active/Passive` configuration. Azure by default allows specifying up to `50` Backend Pools.
117117

118118
Front Door backends refers to the host name or public IP of your application that serves your client requests. Front Door supports both Azure and non-Azure resources in the backend pool. The application can either be in your on-premises datacenter or located in another cloud provider.
119119

@@ -126,7 +126,7 @@ Front Door backends refers to the host name or public IP of your application tha
126126
`health_probe_name`|Specifies the name of the `backend_pool_health_probe` block within this resource to use for this `Backend Pool`.
127127
`backend` | A backend block as defined below.
128128

129-
### `backend` - A backend block as defined below
129+
> `backend` - A backend block as defined below
130130
131131
| Name | Description
132132
|--|--
@@ -180,7 +180,7 @@ Before you can use a custom domain with your Front Door, you must first create a
180180
`web_application_firewall_policy_link_id`|Defines the Web Application Firewall policy ID for each host. By default pickup existing WAF policy if specified with module.
181181
`custom_https_configuration` | The `custom_https_configuration` block supports the following
182182

183-
### The `custom_https_configuration`- block supports the following
183+
> The `custom_https_configuration`- block supports the following
184184
185185
| Name | Description
186186
|--|--
@@ -202,7 +202,7 @@ A Front Door routing rule configuration is composed of two major parts: a "left-
202202
`accepted_protocols`|Protocol schemes to match for the Backend Routing Rule. Defaults to `Http`.
203203
`patterns_to_match`| The route patterns for the Backend Routing Rule. Defaults to `/*`.
204204

205-
### `forwarding_configuration`| A forwarding_configuration block as defined below
205+
> `forwarding_configuration`| A forwarding_configuration block as defined below
206206
207207
| Name | Description
208208
|--|--
@@ -215,7 +215,7 @@ A Front Door routing rule configuration is composed of two major parts: a "left-
215215
`custom_forwarding_path`|Path to use when constructing the request to forward to the backend. This functions as a URL Rewrite. Default behaviour preserves the URL path.
216216
forwarding_protocol | Protocol to use when redirecting. Valid options are `HttpOnly`, `HttpsOnly`, or `MatchRequest`. Defaults to `HttpsOnly`.
217217

218-
### `redirect_configuration`| A redirect_configuration block as defined below
218+
> `redirect_configuration`| A redirect_configuration block as defined below
219219
220220
| Name | Description
221221
|--|--
@@ -253,8 +253,20 @@ An effective naming convention assembles resource names by using important resou
253253

254254
Name | Description | Type | Default
255255
---- | ----------- | ---- | -------
256+
`create_resource_group`|Create new resource group and use it for all networking resources|string|`""`
256257
`resource_group_name`|The name of an existing resource group.|string|`""`
257258
`location`|The location for all resources while creating a new resource group.|string|`""`
259+
`frontdoor_name`|Specifies the name of the Front Door service. Must be globally unique|string|`""`
260+
friendly_name|A friendly name for the Front Door service|string|`""`
261+
`backend_pools_send_receive_timeout_seconds`|Specifies the send and receive timeout on forwarding request to the backend. When the timeout is reached, the request fails and returns. Possible values are between `0` - `240`. Defaults to `60`.|number|`60`
262+
string|`""`
263+
`enforce_backend_pools_certificate_name_check`|Enforce certificate name check on HTTPS requests to all backend pools, this setting will have no effect on HTTP requests. Permitted values are `true` or `false`.|string|`false`
264+
`backend_pools`|A logical grouping of app instances across the world that receive the same traffic and respond with expected behavior. These backends are deployed across different regions or within the same region. All backends can be in `Active/Active` deployment mode or what is defined as `Active/Passive` configuration. Azure by default allows specifying up to `50` Backend Pools.|list(object({}))|`[]`
265+
`backend_pool_health_probes`|The list of backend pool health probes.|list(object({}))|`[]`
266+
`backend_pool_load_balancing`|Load-balancing settings for the backend pool to determine if the backend is healthy or unhealthy. They also check how to load-balance traffic between different backends in the backend pool.|list(object({}))|`[]`
267+
`frontend_endpoints`|Lists all of the frontend endpoints within a Front Door|list(object({}))|`[]`
268+
`routing_rules`|The list of Routing Rules to determine which particular rule to match the request to and then take the defined action in the configuration|list(object({}))|`[]`
269+
web_application_firewall_policy|Manages an Azure Front Door Web Application Firewall Policy instance|map(object({}))|`null`
258270
`log_analytics_workspace_name`|The name of log analytics workspace name|string|`null`
259271
`storage_account_name`|The name of the hub storage account to store logs|string|`null`
260272
`Tags`|A map of tags to add to all resources|map|`{}`
@@ -266,6 +278,14 @@ Name | Description
266278
`resource_group_name`| The name of the resource group in which resources are created
267279
`resource_group_id`| The id of the resource group in which resources are created
268280
`resource_group_location`| The location of the resource group in which resources are created
281+
`backend_pool_ids`|The ID's of the Azure Front Door Backend Pool
282+
`backend_pool_health_probes`|The ID's of the Azure Front Door Backend Health Probe
283+
`backend_pool_load_balancing`|The ID of the Azure Front Door Backend Load Balancer
284+
`frontend_endpoint_id`|The ID of the Azure Front Door Frontend Endpoint
285+
`frontdoor_id`|The ID of the FrontDoor
286+
`frontdoor_waf_policy_id`|The ID of the FrontDoor Firewall Policy
287+
`frontdoor_waf_policy_location`|The Azure Region where this FrontDoor Firewall Policy exists
288+
`frontdoor_waf_policy_frontend_endpoint_ids`|The Frontend Endpoints associated with this Front Door Web Application Firewall policy
269289

270290
## Resource Graph
271291

examples/frontdoor_with_custom_https_configuration/output.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
output "backend_pools" {
1+
output "backend_pool_ids" {
22
description = "The ID of the Azure Front Door Backend Pool"
3-
value = module.frontdoor.backend_pools
3+
value = module.frontdoor.backend_pool_ids
44
}
55

66
output "backend_pool_health_probes" {

examples/frontdoor_with_waf_policies/output.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
output "backend_pools" {
1+
output "backend_pool_ids" {
22
description = "The ID of the Azure Front Door Backend Pool"
3-
value = module.frontdoor.backend_pools
3+
value = module.frontdoor.backend_pool_ids
44
}
55

66
output "backend_pool_health_probes" {

output.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ output "resource_group_location" {
1313
value = element(coalescelist(data.azurerm_resource_group.rgrp.*.location, azurerm_resource_group.rg.*.location, [""]), 0)
1414
}
1515

16-
output "backend_pools" {
16+
output "backend_pool_ids" {
1717
description = "The ID's of the Azure Front Door Backend Pool"
1818
value = azurerm_frontdoor.main.backend_pool.*.id
1919
}

0 commit comments

Comments
 (0)