Skip to content

Commit 8b94eb9

Browse files
committed
updating docs and graph
1 parent 75f16cc commit 8b94eb9

File tree

2 files changed

+48
-2
lines changed

2 files changed

+48
-2
lines changed

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,12 @@ Front Door backends refers to the host name or public IP of your application tha
124124
`name`| Specifies the name of the Backend Pool
125125
`load_balancing_name`|Specifies the name of the `backend_pool_load_balancing` block within this resource to use for this `Backend Pool`.
126126
`health_probe_name`|Specifies the name of the `backend_pool_health_probe` block within this resource to use for this `Backend Pool`.
127-
||**`backend` - A backend block as defined below**||
127+
`backend` | A backend block as defined below.
128+
129+
### `backend` - A backend block as defined below
130+
131+
| Name | Description
132+
|--|--
128133
`address`|Location of the backend (IP address or FQDN)
129134
`host_header`|The value to use as the host header sent to the backend.
130135
`http_port`|The HTTP TCP port number. Possible values are between `1` - `65535`.
@@ -173,12 +178,53 @@ Before you can use a custom domain with your Front Door, you must first create a
173178
`session_affinity_enabled`|Whether to allow session affinity on this host. Valid options are true or false Defaults to false.
174179
`session_affinity_ttl_seconds`|The TTL to use in seconds for session affinity, if applicable. Defaults to 0.
175180
`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.
176-
||**The `custom_https_configuration`- block supports the following**||
181+
`custom_https_configuration` | The `custom_https_configuration` block supports the following
182+
183+
### The `custom_https_configuration`- block supports the following
184+
185+
| Name | Description
186+
|--|--
177187
`certificate_source`|Certificate source to encrypted `HTTPS` traffic with. Allowed values are `FrontDoor` or `AzureKeyVault`. Defaults to `FrontDoor`.
178188
`azure_key_vault_certificate_vault_id`|The ID of the Key Vault containing the SSL certificate. Only valid if `certificate_source` is set to `AzureKeyVault`
179189
`azure_key_vault_certificate_secret_name`|The name of the Key Vault secret representing the full certificate PFX. Only valid if `certificate_source` is set to `AzureKeyVault`
180190
`azure_key_vault_certificate_secret_version`|The version of the Key Vault secret representing the full certificate PFX. Defaults to Latest. Only valid if `certificate_source` is set to `AzureKeyVault`
181191

192+
## **`routing_rules`** - How requests are matched to a routing rule
193+
194+
After establishing a connection and completing a TLS handshake, when a request lands on a Front Door environment one of the first things that Front Door does is determine which particular routing rule to match the request to and then take the defined action in the configuration.
195+
196+
A Front Door routing rule configuration is composed of two major parts: a "left-hand side" and a "right-hand side". We match the incoming request to the left-hand side of the route while the right-hand side defines how we process the request. The following settings are available for `routing_rules` object:
197+
198+
| Name | Description
199+
|--|--
200+
`name`|Specifies the name of the Routing Rule.
201+
`frontend_endpoints`|The names of the `frontend_endpoint` blocks within this resource to associate with this `routing_rule`.
202+
`accepted_protocols`|Protocol schemes to match for the Backend Routing Rule. Defaults to `Http`.
203+
`patterns_to_match`| The route patterns for the Backend Routing Rule. Defaults to `/*`.
204+
205+
### `forwarding_configuration`| A forwarding_configuration block as defined below
206+
207+
| Name | Description
208+
|--|--
209+
`backend_pool_name`|Specifies the name of the Backend Pool to forward the incoming traffic to.
210+
`cache_enabled`|Specifies whether to Enable caching or not. Valid options are `true` or `false`. Defaults to `false`.
211+
`cache_use_dynamic_compression`|Whether to use dynamic compression when caching. Valid options are `true` or `false`. Defaults to `false`.
212+
`cache_query_parameter_strip_directive`|Defines cache behaviour in relation to query string parameters. Valid options are `StripAll`, `StripAllExcept`, `StripOnly` or `StripNone`. Defaults to `StripAll`.
213+
`cache_query_parameters`|Specify query parameters (array). Works only in combination with `cache_query_parameter_strip_directive` set to `StripAllExcept` or `StripOnly`.
214+
`cache_duration`|Specify the caching duration (in ISO8601 notation e.g. `P1DT2H` for 1 day and 2 hours). Needs to be greater than 0 and smaller than 365 days. `cache_duration` works only in combination with `cache_enabled` set to `true`.
215+
`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.
216+
forwarding_protocol | Protocol to use when redirecting. Valid options are `HttpOnly`, `HttpsOnly`, or `MatchRequest`. Defaults to `HttpsOnly`.
217+
218+
### `redirect_configuration`| A redirect_configuration block as defined below
219+
220+
| Name | Description
221+
|--|--
222+
`custom_host`|Set this to change the URL for the redirection.
223+
`redirect_protocol`|Protocol to use when redirecting. Valid options are `HttpOnly`, `HttpsOnly`, or `MatchRequest`. Defaults to `MatchRequest`
224+
`redirect_type`|Status code for the redirect. Valida options are `Moved`, `Found`, `TemporaryRedirect`, `PermanentRedirect`.
225+
`custom_fragment`|The destination fragment in the portion of URL after '#'. Set this to add a fragment to the redirect URL.
226+
`custom_path`|The path to retain as per the incoming request, or update in the URL for the redirection.
227+
`custom_query_string`|Replace any existing query string from the incoming request URL.
182228

183229
## Recommended naming and tagging conventions
184230

graph.png

235 KB
Loading

0 commit comments

Comments
 (0)