From 882251bf8ddab24cb17fd7d23a6d7f1c354570b9 Mon Sep 17 00:00:00 2001 From: Ed Smith Date: Thu, 19 Sep 2024 13:21:20 +0100 Subject: [PATCH] fix: hashicorp/terraform-provider-azurerm#2597 revert erroneous markdown lint changes --- .../docs/r/application_gateway.html.markdown | 511 +++++++++--------- 1 file changed, 252 insertions(+), 259 deletions(-) diff --git a/website/docs/r/application_gateway.html.markdown b/website/docs/r/application_gateway.html.markdown index 4a525889a17f..4a28c064cb07 100644 --- a/website/docs/r/application_gateway.html.markdown +++ b/website/docs/r/application_gateway.html.markdown @@ -11,8 +11,8 @@ description: |- Manages an Application Gateway. ~> **NOTE:** The `backend_address_pool`, `backend_http_settings`, `http_listener`, `private_link_configuration`, `request_routing_rule`, `redirect_configuration`, `probe`, `ssl_certificate`, -and `frontend_port` properties are Sets as the service API returns these lists of objects in a different order from how the provider sends them. As Sets are stored using a hash, if one -value is added or removed from the Set, Terraform considers the entire list of objects changed and the plan shows that it is removing every value in the list and re-adding it with the +and `frontend_port` properties are Sets as the service API returns these lists of objects in a different order from how the provider sends them. As Sets are stored using a hash, if one +value is added or removed from the Set, Terraform considers the entire list of objects changed and the plan shows that it is removing every value in the list and re-adding it with the new information. Though Terraform is showing all the values being removed and re-added, we are not actually removing anything unless the user specifies a removal in the configfile. ## Example Usage @@ -116,227 +116,227 @@ resource "azurerm_application_gateway" "network" { The following arguments are supported: -- `name` - (Required) The name of the Application Gateway. Changing this forces a new resource to be created. +* `name` - (Required) The name of the Application Gateway. Changing this forces a new resource to be created. -- `resource_group_name` - (Required) The name of the resource group in which to the Application Gateway should exist. Changing this forces a new resource to be created. +* `resource_group_name` - (Required) The name of the resource group in which to the Application Gateway should exist. Changing this forces a new resource to be created. -- `location` - (Required) The Azure region where the Application Gateway should exist. Changing this forces a new resource to be created. +* `location` - (Required) The Azure region where the Application Gateway should exist. Changing this forces a new resource to be created. -- `backend_address_pool` - (Required) One or more `backend_address_pool` blocks as defined below. +* `backend_address_pool` - (Required) One or more `backend_address_pool` blocks as defined below. -- `backend_http_settings` - (Required) One or more `backend_http_settings` blocks as defined below. +* `backend_http_settings` - (Required) One or more `backend_http_settings` blocks as defined below. -- `frontend_ip_configuration` - (Required) One or more `frontend_ip_configuration` blocks as defined below. +* `frontend_ip_configuration` - (Required) One or more `frontend_ip_configuration` blocks as defined below. -- `frontend_port` - (Required) One or more `frontend_port` blocks as defined below. +* `frontend_port` - (Required) One or more `frontend_port` blocks as defined below. -- `gateway_ip_configuration` - (Required) One or more `gateway_ip_configuration` blocks as defined below. +* `gateway_ip_configuration` - (Required) One or more `gateway_ip_configuration` blocks as defined below. -- `http_listener` - (Required) One or more `http_listener` blocks as defined below. +* `http_listener` - (Required) One or more `http_listener` blocks as defined below. -- `request_routing_rule` - (Required) One or more `request_routing_rule` blocks as defined below. +* `request_routing_rule` - (Required) One or more `request_routing_rule` blocks as defined below. -- `sku` - (Required) A `sku` block as defined below. +* `sku` - (Required) A `sku` block as defined below. --- -- `fips_enabled` - (Optional) Is FIPS enabled on the Application Gateway? +* `fips_enabled` - (Optional) Is FIPS enabled on the Application Gateway? -- `global` - (Optional) A `global` block as defined below. +* `global` - (Optional) A `global` block as defined below. -- `identity` - (Optional) An `identity` block as defined below. +* `identity` - (Optional) An `identity` block as defined below. -- `private_link_configuration` - (Optional) One or more `private_link_configuration` blocks as defined below. +* `private_link_configuration` - (Optional) One or more `private_link_configuration` blocks as defined below. -- `zones` - (Optional) Specifies a list of Availability Zones in which this Application Gateway should be located. Changing this forces a new Application Gateway to be created. +* `zones` - (Optional) Specifies a list of Availability Zones in which this Application Gateway should be located. Changing this forces a new Application Gateway to be created. -> **Please Note**: Availability Zones are not supported in all regions at this time, please check the [official documentation](https://docs.microsoft.com/azure/availability-zones/az-overview) for more information. They are also only supported for [v2 SKUs](https://docs.microsoft.com/azure/application-gateway/application-gateway-autoscaling-zone-redundant) -- `trusted_client_certificate` - (Optional) One or more `trusted_client_certificate` blocks as defined below. +* `trusted_client_certificate` - (Optional) One or more `trusted_client_certificate` blocks as defined below. -- `ssl_profile` - (Optional) One or more `ssl_profile` blocks as defined below. +* `ssl_profile` - (Optional) One or more `ssl_profile` blocks as defined below. -- `authentication_certificate` - (Optional) One or more `authentication_certificate` blocks as defined below. +* `authentication_certificate` - (Optional) One or more `authentication_certificate` blocks as defined below. -- `trusted_root_certificate` - (Optional) One or more `trusted_root_certificate` blocks as defined below. +* `trusted_root_certificate` - (Optional) One or more `trusted_root_certificate` blocks as defined below. -- `ssl_policy` - (Optional) a `ssl_policy` block as defined below. +* `ssl_policy` - (Optional) a `ssl_policy` block as defined below. -- `enable_http2` - (Optional) Is HTTP2 enabled on the application gateway resource? Defaults to `false`. +* `enable_http2` - (Optional) Is HTTP2 enabled on the application gateway resource? Defaults to `false`. -- `force_firewall_policy_association` - (Optional) Is the Firewall Policy associated with the Application Gateway? +* `force_firewall_policy_association` - (Optional) Is the Firewall Policy associated with the Application Gateway? -- `probe` - (Optional) One or more `probe` blocks as defined below. +* `probe` - (Optional) One or more `probe` blocks as defined below. -- `ssl_certificate` - (Optional) One or more `ssl_certificate` blocks as defined below. +* `ssl_certificate` - (Optional) One or more `ssl_certificate` blocks as defined below. -- `tags` - (Optional) A mapping of tags to assign to the resource. +* `tags` - (Optional) A mapping of tags to assign to the resource. -- `url_path_map` - (Optional) One or more `url_path_map` blocks as defined below. +* `url_path_map` - (Optional) One or more `url_path_map` blocks as defined below. -- `waf_configuration` - (Optional) A `waf_configuration` block as defined below. +* `waf_configuration` - (Optional) A `waf_configuration` block as defined below. -- `custom_error_configuration` - (Optional) One or more `custom_error_configuration` blocks as defined below. +* `custom_error_configuration` - (Optional) One or more `custom_error_configuration` blocks as defined below. -- `firewall_policy_id` - (Optional) The ID of the Web Application Firewall Policy. +* `firewall_policy_id` - (Optional) The ID of the Web Application Firewall Policy. -- `redirect_configuration` - (Optional) One or more `redirect_configuration` blocks as defined below. +* `redirect_configuration` - (Optional) One or more `redirect_configuration` blocks as defined below. -- `autoscale_configuration` - (Optional) An `autoscale_configuration` block as defined below. This option is not supported for `Basic` SKUs. +* `autoscale_configuration` - (Optional) An `autoscale_configuration` block as defined below. -- `rewrite_rule_set` - (Optional) One or more `rewrite_rule_set` blocks as defined below. Only valid for v2 SKUs. +* `rewrite_rule_set` - (Optional) One or more `rewrite_rule_set` blocks as defined below. Only valid for v2 SKUs. --- An `authentication_certificate` block supports the following: -- `name` - (Required) The Name of the Authentication Certificate to use. +* `name` - (Required) The Name of the Authentication Certificate to use. -- `data` - (Required) The contents of the Authentication Certificate which should be used. +* `data` - (Required) The contents of the Authentication Certificate which should be used. --- A `trusted_root_certificate` block supports the following: -- `name` - (Required) The Name of the Trusted Root Certificate to use. +* `name` - (Required) The Name of the Trusted Root Certificate to use. -- `data` - (Optional) The contents of the Trusted Root Certificate which should be used. Required if `key_vault_secret_id` is not set. +* `data` - (Optional) The contents of the Trusted Root Certificate which should be used. Required if `key_vault_secret_id` is not set. -- `key_vault_secret_id` - (Optional) The Secret ID of (base-64 encoded unencrypted pfx) `Secret` or `Certificate` object stored in Azure KeyVault. You need to enable soft delete for the Key Vault to use this feature. Required if `data` is not set. +* `key_vault_secret_id` - (Optional) The Secret ID of (base-64 encoded unencrypted pfx) `Secret` or `Certificate` object stored in Azure KeyVault. You need to enable soft delete for the Key Vault to use this feature. Required if `data` is not set. -> **NOTE:** TLS termination with Key Vault certificates is limited to the [v2 SKUs](https://docs.microsoft.com/azure/application-gateway/key-vault-certs). --> **NOTE:** For TLS termination with Key Vault certificates to work properly existing user-assigned managed identity, which Application Gateway uses to retrieve certificates from Key Vault, should be defined via `identity` block. Additionally, access policies in the Key Vault to allow the identity to be granted _get_ access to the secret should be defined. +-> **NOTE:** For TLS termination with Key Vault certificates to work properly existing user-assigned managed identity, which Application Gateway uses to retrieve certificates from Key Vault, should be defined via `identity` block. Additionally, access policies in the Key Vault to allow the identity to be granted *get* access to the secret should be defined. --- A `backend_address_pool` block supports the following: -- `name` - (Required) The name of the Backend Address Pool. +* `name` - (Required) The name of the Backend Address Pool. -- `fqdns` - (Optional) A list of FQDN's which should be part of the Backend Address Pool. +* `fqdns` - (Optional) A list of FQDN's which should be part of the Backend Address Pool. -- `ip_addresses` - (Optional) A list of IP Addresses which should be part of the Backend Address Pool. +* `ip_addresses` - (Optional) A list of IP Addresses which should be part of the Backend Address Pool. --- A `backend_http_settings` block supports the following: -- `cookie_based_affinity` - (Required) Is Cookie-Based Affinity enabled? Possible values are `Enabled` and `Disabled`. +* `cookie_based_affinity` - (Required) Is Cookie-Based Affinity enabled? Possible values are `Enabled` and `Disabled`. -- `affinity_cookie_name` - (Optional) The name of the affinity cookie. +* `affinity_cookie_name` - (Optional) The name of the affinity cookie. -- `name` - (Required) The name of the Backend HTTP Settings Collection. +* `name` - (Required) The name of the Backend HTTP Settings Collection. -- `path` - (Optional) The Path which should be used as a prefix for all HTTP requests. +* `path` - (Optional) The Path which should be used as a prefix for all HTTP requests. -- `port` - (Required) The port which should be used for this Backend HTTP Settings Collection. +* `port` - (Required) The port which should be used for this Backend HTTP Settings Collection. -- `probe_name` - (Optional) The name of an associated HTTP Probe. +* `probe_name` - (Optional) The name of an associated HTTP Probe. -- `protocol` - (Required) The Protocol which should be used. Possible values are `Http` and `Https`. +* `protocol` - (Required) The Protocol which should be used. Possible values are `Http` and `Https`. -- `request_timeout` - (Optional) The request timeout in seconds, which must be between 1 and 86400 seconds. Defaults to `30`. +* `request_timeout` - (Optional) The request timeout in seconds, which must be between 1 and 86400 seconds. Defaults to `30`. -- `host_name` - (Optional) Host header to be sent to the backend servers. Cannot be set if `pick_host_name_from_backend_address` is set to `true`. +* `host_name` - (Optional) Host header to be sent to the backend servers. Cannot be set if `pick_host_name_from_backend_address` is set to `true`. -- `pick_host_name_from_backend_address` - (Optional) Whether host header should be picked from the host name of the backend server. Defaults to `false`. +* `pick_host_name_from_backend_address` - (Optional) Whether host header should be picked from the host name of the backend server. Defaults to `false`. -- `authentication_certificate` - (Optional) One or more `authentication_certificate_backend` blocks as defined below. +* `authentication_certificate` - (Optional) One or more `authentication_certificate_backend` blocks as defined below. -- `trusted_root_certificate_names` - (Optional) A list of `trusted_root_certificate` names. +* `trusted_root_certificate_names` - (Optional) A list of `trusted_root_certificate` names. -- `connection_draining` - (Optional) A `connection_draining` block as defined below. +* `connection_draining` - (Optional) A `connection_draining` block as defined below. --- A `authentication_certificate_backend` block, within the `backend_http_settings` block supports the following: -- `name` - (Required) The name of the Authentication Certificate. +* `name` - (Required) The name of the Authentication Certificate. --- A `connection_draining` block supports the following: -- `enabled` - (Required) If connection draining is enabled or not. +* `enabled` - (Required) If connection draining is enabled or not. -- `drain_timeout_sec` - (Required) The number of seconds connection draining is active. Acceptable values are from `1` second to `3600` seconds. +* `drain_timeout_sec` - (Required) The number of seconds connection draining is active. Acceptable values are from `1` second to `3600` seconds. --- A `frontend_ip_configuration` block supports the following: -- `name` - (Required) The name of the Frontend IP Configuration. +* `name` - (Required) The name of the Frontend IP Configuration. -- `subnet_id` - (Optional) The ID of the Subnet. +* `subnet_id` - (Optional) The ID of the Subnet. -- `private_ip_address` - (Optional) The Private IP Address to use for the Application Gateway. +* `private_ip_address` - (Optional) The Private IP Address to use for the Application Gateway. -- `public_ip_address_id` - (Optional) The ID of a Public IP Address which the Application Gateway should use. The allocation method for the Public IP Address depends on the `sku` of this Application Gateway. Please refer to the [Azure documentation for public IP addresses](https://docs.microsoft.com/azure/virtual-network/public-ip-addresses#application-gateways) for details. +* `public_ip_address_id` - (Optional) The ID of a Public IP Address which the Application Gateway should use. The allocation method for the Public IP Address depends on the `sku` of this Application Gateway. Please refer to the [Azure documentation for public IP addresses](https://docs.microsoft.com/azure/virtual-network/public-ip-addresses#application-gateways) for details. -- `private_ip_address_allocation` - (Optional) The Allocation Method for the Private IP Address. Possible values are `Dynamic` and `Static`. Defaults to `Dynamic`. +* `private_ip_address_allocation` - (Optional) The Allocation Method for the Private IP Address. Possible values are `Dynamic` and `Static`. Defaults to `Dynamic`. -- `private_link_configuration_name` - (Optional) The name of the private link configuration to use for this frontend IP configuration. +* `private_link_configuration_name` - (Optional) The name of the private link configuration to use for this frontend IP configuration. --- A `frontend_port` block supports the following: -- `name` - (Required) The name of the Frontend Port. +* `name` - (Required) The name of the Frontend Port. -- `port` - (Required) The port used for this Frontend Port. +* `port` - (Required) The port used for this Frontend Port. --- A `gateway_ip_configuration` block supports the following: -- `name` - (Required) The Name of this Gateway IP Configuration. +* `name` - (Required) The Name of this Gateway IP Configuration. -- `subnet_id` - (Required) The ID of the Subnet which the Application Gateway should be connected to. +* `subnet_id` - (Required) The ID of the Subnet which the Application Gateway should be connected to. --- A `http_listener` block supports the following: -- `name` - (Required) The Name of the HTTP Listener. +* `name` - (Required) The Name of the HTTP Listener. -- `frontend_ip_configuration_name` - (Required) The Name of the Frontend IP Configuration used for this HTTP Listener. +* `frontend_ip_configuration_name` - (Required) The Name of the Frontend IP Configuration used for this HTTP Listener. -- `frontend_port_name` - (Required) The Name of the Frontend Port use for this HTTP Listener. +* `frontend_port_name` - (Required) The Name of the Frontend Port use for this HTTP Listener. -- `host_name` - (Optional) The Hostname which should be used for this HTTP Listener. Setting this value changes Listener Type to 'Multi site'. +* `host_name` - (Optional) The Hostname which should be used for this HTTP Listener. Setting this value changes Listener Type to 'Multi site'. -- `host_names` - (Optional) A list of Hostname(s) should be used for this HTTP Listener. It allows special wildcard characters. +* `host_names` - (Optional) A list of Hostname(s) should be used for this HTTP Listener. It allows special wildcard characters. -> **NOTE** The `host_names` and `host_name` are mutually exclusive and cannot both be set. -- `protocol` - (Required) The Protocol to use for this HTTP Listener. Possible values are `Http` and `Https`. +* `protocol` - (Required) The Protocol to use for this HTTP Listener. Possible values are `Http` and `Https`. -- `require_sni` - (Optional) Should Server Name Indication be Required? Defaults to `false`. +* `require_sni` - (Optional) Should Server Name Indication be Required? Defaults to `false`. -- `ssl_certificate_name` - (Optional) The name of the associated SSL Certificate which should be used for this HTTP Listener. +* `ssl_certificate_name` - (Optional) The name of the associated SSL Certificate which should be used for this HTTP Listener. -- `custom_error_configuration` - (Optional) One or more `custom_error_configuration` blocks as defined below. +* `custom_error_configuration` - (Optional) One or more `custom_error_configuration` blocks as defined below. -- `firewall_policy_id` - (Optional) The ID of the Web Application Firewall Policy which should be used for this HTTP Listener. +* `firewall_policy_id` - (Optional) The ID of the Web Application Firewall Policy which should be used for this HTTP Listener. -- `ssl_profile_name` - (Optional) The name of the associated SSL Profile which should be used for this HTTP Listener. +* `ssl_profile_name` - (Optional) The name of the associated SSL Profile which should be used for this HTTP Listener. --- An `identity` block supports the following: -- `type` - (Required) Specifies the type of Managed Service Identity that should be configured on this Application Gateway. Only possible value is `UserAssigned`. +* `type` - (Required) Specifies the type of Managed Service Identity that should be configured on this Application Gateway. Only possible value is `UserAssigned`. -- `identity_ids` - (Required) Specifies a list of User Assigned Managed Identity IDs to be assigned to this Application Gateway. +* `identity_ids` - (Required) Specifies a list of User Assigned Managed Identity IDs to be assigned to this Application Gateway. --- A `private_link_configuration` block supports the following: -- `name` - (Required) The name of the private link configuration. +* `name` - (Required) The name of the private link configuration. -- `ip_configuration` - (Required) One or more `ip_configuration` blocks as defined below. +* `ip_configuration` - (Required) One or more `ip_configuration` blocks as defined below. -> **Please Note**: The `AllowApplicationGatewayPrivateLink` feature must be registered on the subscription before enabling private link @@ -348,91 +348,91 @@ az feature register --name AllowApplicationGatewayPrivateLink --namespace Micros An `ip_configuration` block supports the following: -- `name` - (Required) The name of the IP configuration. +* `name` - (Required) The name of the IP configuration. -- `subnet_id` - (Required) The ID of the subnet the private link configuration should connect to. +* `subnet_id` - (Required) The ID of the subnet the private link configuration should connect to. -- `private_ip_address_allocation` - (Required) The allocation method used for the Private IP Address. Possible values are `Dynamic` and `Static`. +* `private_ip_address_allocation` - (Required) The allocation method used for the Private IP Address. Possible values are `Dynamic` and `Static`. -- `primary` - (Required) Is this the Primary IP Configuration? +* `primary` - (Required) Is this the Primary IP Configuration? -- `private_ip_address` - (Optional) The Static IP Address which should be used. +* `private_ip_address` - (Optional) The Static IP Address which should be used. --- A `match` block supports the following: -- `body` - (Optional) A snippet from the Response Body which must be present in the Response. +* `body` - (Optional) A snippet from the Response Body which must be present in the Response. -- `status_code` - (Required) A list of allowed status codes for this Health Probe. +* `status_code` - (Required) A list of allowed status codes for this Health Probe. --- A `path_rule` block supports the following: -- `name` - (Required) The Name of the Path Rule. +* `name` - (Required) The Name of the Path Rule. -- `paths` - (Required) A list of Paths used in this Path Rule. +* `paths` - (Required) A list of Paths used in this Path Rule. -- `backend_address_pool_name` - (Optional) The Name of the Backend Address Pool to use for this Path Rule. Cannot be set if `redirect_configuration_name` is set. +* `backend_address_pool_name` - (Optional) The Name of the Backend Address Pool to use for this Path Rule. Cannot be set if `redirect_configuration_name` is set. -- `backend_http_settings_name` - (Optional) The Name of the Backend HTTP Settings Collection to use for this Path Rule. Cannot be set if `redirect_configuration_name` is set. +* `backend_http_settings_name` - (Optional) The Name of the Backend HTTP Settings Collection to use for this Path Rule. Cannot be set if `redirect_configuration_name` is set. -- `redirect_configuration_name` - (Optional) The Name of a Redirect Configuration to use for this Path Rule. Cannot be set if `backend_address_pool_name` or `backend_http_settings_name` is set. +* `redirect_configuration_name` - (Optional) The Name of a Redirect Configuration to use for this Path Rule. Cannot be set if `backend_address_pool_name` or `backend_http_settings_name` is set. -- `rewrite_rule_set_name` - (Optional) The Name of the Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs. +* `rewrite_rule_set_name` - (Optional) The Name of the Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs. -- `firewall_policy_id` - (Optional) The ID of the Web Application Firewall Policy which should be used as an HTTP Listener. +* `firewall_policy_id` - (Optional) The ID of the Web Application Firewall Policy which should be used as an HTTP Listener. --- A `probe` block supports the following: -- `host` - (Optional) The Hostname used for this Probe. If the Application Gateway is configured for a single site, by default the Host name should be specified as `127.0.0.1`, unless otherwise configured in custom probe. Cannot be set if `pick_host_name_from_backend_http_settings` is set to `true`. +* `host` - (Optional) The Hostname used for this Probe. If the Application Gateway is configured for a single site, by default the Host name should be specified as `127.0.0.1`, unless otherwise configured in custom probe. Cannot be set if `pick_host_name_from_backend_http_settings` is set to `true`. -- `interval` - (Required) The Interval between two consecutive probes in seconds. Possible values range from 1 second to a maximum of 86,400 seconds. +* `interval` - (Required) The Interval between two consecutive probes in seconds. Possible values range from 1 second to a maximum of 86,400 seconds. -- `name` - (Required) The Name of the Probe. +* `name` - (Required) The Name of the Probe. -- `protocol` - (Required) The Protocol used for this Probe. Possible values are `Http` and `Https`. +* `protocol` - (Required) The Protocol used for this Probe. Possible values are `Http` and `Https`. -- `path` - (Required) The Path used for this Probe. +* `path` - (Required) The Path used for this Probe. -- `timeout` - (Required) The Timeout used for this Probe, which indicates when a probe becomes unhealthy. Possible values range from 1 second to a maximum of 86,400 seconds. +* `timeout` - (Required) The Timeout used for this Probe, which indicates when a probe becomes unhealthy. Possible values range from 1 second to a maximum of 86,400 seconds. -- `unhealthy_threshold` - (Required) The Unhealthy Threshold for this Probe, which indicates the amount of retries which should be attempted before a node is deemed unhealthy. Possible values are from 1 to 20. +* `unhealthy_threshold` - (Required) The Unhealthy Threshold for this Probe, which indicates the amount of retries which should be attempted before a node is deemed unhealthy. Possible values are from 1 to 20. -- `port` - (Optional) Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from HTTP settings will be used. This property is valid for Standard_v2 and WAF_v2 only. +* `port` - (Optional) Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from HTTP settings will be used. This property is valid for Standard_v2 and WAF_v2 only. -- `pick_host_name_from_backend_http_settings` - (Optional) Whether the host header should be picked from the backend HTTP settings. Defaults to `false`. +* `pick_host_name_from_backend_http_settings` - (Optional) Whether the host header should be picked from the backend HTTP settings. Defaults to `false`. -- `match` - (Optional) A `match` block as defined above. +* `match` - (Optional) A `match` block as defined above. -- `minimum_servers` - (Optional) The minimum number of servers that are always marked as healthy. Defaults to `0`. +* `minimum_servers` - (Optional) The minimum number of servers that are always marked as healthy. Defaults to `0`. --- A `request_routing_rule` block supports the following: -- `name` - (Required) The Name of this Request Routing Rule. +* `name` - (Required) The Name of this Request Routing Rule. -- `rule_type` - (Required) The Type of Routing that should be used for this Rule. Possible values are `Basic` and `PathBasedRouting`. +* `rule_type` - (Required) The Type of Routing that should be used for this Rule. Possible values are `Basic` and `PathBasedRouting`. -- `http_listener_name` - (Required) The Name of the HTTP Listener which should be used for this Routing Rule. +* `http_listener_name` - (Required) The Name of the HTTP Listener which should be used for this Routing Rule. -- `backend_address_pool_name` - (Optional) The Name of the Backend Address Pool which should be used for this Routing Rule. Cannot be set if `redirect_configuration_name` is set. +* `backend_address_pool_name` - (Optional) The Name of the Backend Address Pool which should be used for this Routing Rule. Cannot be set if `redirect_configuration_name` is set. -- `backend_http_settings_name` - (Optional) The Name of the Backend HTTP Settings Collection which should be used for this Routing Rule. Cannot be set if `redirect_configuration_name` is set. +* `backend_http_settings_name` - (Optional) The Name of the Backend HTTP Settings Collection which should be used for this Routing Rule. Cannot be set if `redirect_configuration_name` is set. -- `redirect_configuration_name` - (Optional) The Name of the Redirect Configuration which should be used for this Routing Rule. Cannot be set if either `backend_address_pool_name` or `backend_http_settings_name` is set. +* `redirect_configuration_name` - (Optional) The Name of the Redirect Configuration which should be used for this Routing Rule. Cannot be set if either `backend_address_pool_name` or `backend_http_settings_name` is set. -- `rewrite_rule_set_name` - (Optional) The Name of the Rewrite Rule Set which should be used for this Routing Rule. Only valid for v2 SKUs. +* `rewrite_rule_set_name` - (Optional) The Name of the Rewrite Rule Set which should be used for this Routing Rule. Only valid for v2 SKUs. -> **NOTE:** `backend_address_pool_name`, `backend_http_settings_name`, `redirect_configuration_name`, and `rewrite_rule_set_name` are applicable only when `rule_type` is `Basic`. -- `url_path_map_name` - (Optional) The Name of the URL Path Map which should be associated with this Routing Rule. +* `url_path_map_name` - (Optional) The Name of the URL Path Map which should be associated with this Routing Rule. -- `priority` - (Optional) Rule evaluation order can be dictated by specifying an integer value from `1` to `20000` with `1` being the highest priority and `20000` being the lowest priority. +* `priority` - (Optional) Rule evaluation order can be dictated by specifying an integer value from `1` to `20000` with `1` being the highest priority and `20000` being the lowest priority. -> **NOTE:** `priority` is required when `sku[0].tier` is set to `*_v2`. @@ -440,442 +440,435 @@ A `request_routing_rule` block supports the following: A `global` block supports the following: -- `request_buffering_enabled` - (Required) Whether Application Gateway's Request buffer is enabled. +* `request_buffering_enabled` - (Required) Whether Application Gateway's Request buffer is enabled. -- `response_buffering_enabled` - (Required) Whether Application Gateway's Response buffer is enabled. +* `response_buffering_enabled` - (Required) Whether Application Gateway's Response buffer is enabled. --- A `sku` block supports the following: -- `name` - (Required) The Name of the SKU to use for this Application Gateway. Possible values are `Basic`, `Standard_Small`, `Standard_Medium`, `Standard_Large`, `Standard_v2`, `WAF_Medium`, `WAF_Large`, and `WAF_v2`. +* `name` - (Required) The Name of the SKU to use for this Application Gateway. Possible values are `Standard_Small`, `Standard_Medium`, `Standard_Large`, `Standard_v2`, `WAF_Medium`, `WAF_Large`, and `WAF_v2`. -- `tier` - (Required) The Tier of the SKU to use for this Application Gateway. Possible values are `Basic`, `Standard`, `Standard_v2`, `WAF` and `WAF_v2`. +* `tier` - (Required) The Tier of the SKU to use for this Application Gateway. Possible values are `Standard`, `Standard_v2`, `WAF` and `WAF_v2`. !> **NOTE:** The `Standard` and `WAF` SKU have been deprecated in favour of the `Standard_v2` and `WAF_v2` SKU. Please see the [Azure documentation](https://aka.ms/V1retirement) for more details. -!> **NOTE:** The `Basic` SKU feature is currently in preview and must be registered on the subscription before using. - -```bash -az feature register --name AllowApplicationGatewayBasicSku --namespace Microsoft.Network -``` - -- `capacity` - (Optional) The Capacity of the SKU to use for this Application Gateway. When using a V1 SKU this value must be between `1` and `32`, and `1` to `125` for a V2 SKU. This property is optional if `autoscale_configuration` is set. This property is not supported for `Basic` SKUs. +* `capacity` - (Optional) The Capacity of the SKU to use for this Application Gateway. When using a V1 SKU this value must be between `1` and `32`, and `1` to `125` for a V2 SKU. This property is optional if `autoscale_configuration` is set. --- A `ssl_certificate` block supports the following: -- `name` - (Required) The Name of the SSL certificate that is unique within this Application Gateway +* `name` - (Required) The Name of the SSL certificate that is unique within this Application Gateway -- `data` - (Optional) The base64-encoded PFX certificate data. Required if `key_vault_secret_id` is not set. +* `data` - (Optional) The base64-encoded PFX certificate data. Required if `key_vault_secret_id` is not set. -> **NOTE:** When specifying a file, use `data = filebase64("path/to/file")` to encode the contents of that file. -- `password` - (Optional) Password for the pfx file specified in data. Required if `data` is set. +* `password` - (Optional) Password for the pfx file specified in data. Required if `data` is set. -- `key_vault_secret_id` - (Optional) The Secret ID of (base-64 encoded unencrypted pfx) the `Secret` or `Certificate` object stored in Azure KeyVault. You need to enable soft delete for Key Vault to use this feature. Required if `data` is not set. +* `key_vault_secret_id` - (Optional) The Secret ID of (base-64 encoded unencrypted pfx) the `Secret` or `Certificate` object stored in Azure KeyVault. You need to enable soft delete for Key Vault to use this feature. Required if `data` is not set. -> **NOTE:** TLS termination with Key Vault certificates is limited to the [v2 SKUs](https://docs.microsoft.com/azure/application-gateway/key-vault-certs). --> **NOTE:** For TLS termination with Key Vault certificates to work properly existing user-assigned managed identity, which Application Gateway uses to retrieve certificates from Key Vault, should be defined via `identity` block. Additionally, access policies in the Key Vault to allow the identity to be granted _get_ access to the secret should be defined. +-> **NOTE:** For TLS termination with Key Vault certificates to work properly existing user-assigned managed identity, which Application Gateway uses to retrieve certificates from Key Vault, should be defined via `identity` block. Additionally, access policies in the Key Vault to allow the identity to be granted *get* access to the secret should be defined. --- A `url_path_map` block supports the following: -- `name` - (Required) The Name of the URL Path Map. +* `name` - (Required) The Name of the URL Path Map. -- `default_backend_address_pool_name` - (Optional) The Name of the Default Backend Address Pool which should be used for this URL Path Map. Cannot be set if `default_redirect_configuration_name` is set. +* `default_backend_address_pool_name` - (Optional) The Name of the Default Backend Address Pool which should be used for this URL Path Map. Cannot be set if `default_redirect_configuration_name` is set. -- `default_backend_http_settings_name` - (Optional) The Name of the Default Backend HTTP Settings Collection which should be used for this URL Path Map. Cannot be set if `default_redirect_configuration_name` is set. +* `default_backend_http_settings_name` - (Optional) The Name of the Default Backend HTTP Settings Collection which should be used for this URL Path Map. Cannot be set if `default_redirect_configuration_name` is set. -- `default_redirect_configuration_name` - (Optional) The Name of the Default Redirect Configuration which should be used for this URL Path Map. Cannot be set if either `default_backend_address_pool_name` or `default_backend_http_settings_name` is set. +* `default_redirect_configuration_name` - (Optional) The Name of the Default Redirect Configuration which should be used for this URL Path Map. Cannot be set if either `default_backend_address_pool_name` or `default_backend_http_settings_name` is set. -> **NOTE:** Both `default_backend_address_pool_name` and `default_backend_http_settings_name` or `default_redirect_configuration_name` should be specified. -- `default_rewrite_rule_set_name` - (Optional) The Name of the Default Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs. +* `default_rewrite_rule_set_name` - (Optional) The Name of the Default Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs. -- `path_rule` - (Required) One or more `path_rule` blocks as defined above. +* `path_rule` - (Required) One or more `path_rule` blocks as defined above. --- - A `trusted_client_certificate` block supports the following: -- `name` - (Required) The name of the Trusted Client Certificate that is unique within this Application Gateway. +* `name` - (Required) The name of the Trusted Client Certificate that is unique within this Application Gateway. -- `data` - (Required) The base-64 encoded certificate. +* `data` - (Required) The base-64 encoded certificate. --- A `ssl_profile` block supports the following: -- `name` - (Required) The name of the SSL Profile that is unique within this Application Gateway. - -- `trusted_client_certificate_names` - (Optional) The name of the Trusted Client Certificate that will be used to authenticate requests from clients. +* `name` - (Required) The name of the SSL Profile that is unique within this Application Gateway. -- `verify_client_cert_issuer_dn` - (Optional) Should client certificate issuer DN be verified? Defaults to `false`. +* `trusted_client_certificate_names` - (Optional) The name of the Trusted Client Certificate that will be used to authenticate requests from clients. -- `verify_client_certificate_revocation` - (Optional) Specify the method to check client certificate revocation status. Possible value is `OCSP`. +* `verify_client_cert_issuer_dn` - (Optional) Should client certificate issuer DN be verified? Defaults to `false`. + +* `verify_client_certificate_revocation` - (Optional) Specify the method to check client certificate revocation status. Possible value is `OCSP`. -- `ssl_policy` - (Optional) a `ssl_policy` block as defined below. +* `ssl_policy` - (Optional) a `ssl_policy` block as defined below. --- A `ssl_policy` block supports the following: -- `disabled_protocols` - (Optional) A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are `TLSv1_0`, `TLSv1_1`, `TLSv1_2` and `TLSv1_3`. +* `disabled_protocols` - (Optional) A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are `TLSv1_0`, `TLSv1_1`, `TLSv1_2` and `TLSv1_3`. ~> **NOTE:** `disabled_protocols` cannot be set when `policy_name` or `policy_type` are set. -- `policy_type` - (Optional) The Type of the Policy. Possible values are `Predefined`, `Custom` and `CustomV2`. +* `policy_type` - (Optional) The Type of the Policy. Possible values are `Predefined`, `Custom` and `CustomV2`. ~> **NOTE:** `policy_type` is Required when `policy_name` is set - cannot be set if `disabled_protocols` is set. When using a `policy_type` of `Predefined` the following fields are supported: -- `policy_name` - (Optional) The Name of the Policy e.g. AppGwSslPolicy20170401S. Required if `policy_type` is set to `Predefined`. Possible values can change over time and are published here . Not compatible with `disabled_protocols`. +* `policy_name` - (Optional) The Name of the Policy e.g. AppGwSslPolicy20170401S. Required if `policy_type` is set to `Predefined`. Possible values can change over time and are published here . Not compatible with `disabled_protocols`. When using a `policy_type` of `Custom` the following fields are supported: -- `cipher_suites` - (Optional) A List of accepted cipher suites. Possible values are: `TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA`, `TLS_DHE_DSS_WITH_AES_128_CBC_SHA`, `TLS_DHE_DSS_WITH_AES_128_CBC_SHA256`, `TLS_DHE_DSS_WITH_AES_256_CBC_SHA`, `TLS_DHE_DSS_WITH_AES_256_CBC_SHA256`, `TLS_DHE_RSA_WITH_AES_128_CBC_SHA`, `TLS_DHE_RSA_WITH_AES_128_GCM_SHA256`, `TLS_DHE_RSA_WITH_AES_256_CBC_SHA`, `TLS_DHE_RSA_WITH_AES_256_GCM_SHA384`, `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA`, `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256`, `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256`, `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA`, `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384`, `TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384`, `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA`, `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256`, `TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256`, `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA`, `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384`, `TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384`, `TLS_RSA_WITH_3DES_EDE_CBC_SHA`, `TLS_RSA_WITH_AES_128_CBC_SHA`, `TLS_RSA_WITH_AES_128_CBC_SHA256`, `TLS_RSA_WITH_AES_128_GCM_SHA256`, `TLS_RSA_WITH_AES_256_CBC_SHA`, `TLS_RSA_WITH_AES_256_CBC_SHA256` and `TLS_RSA_WITH_AES_256_GCM_SHA384`. +* `cipher_suites` - (Optional) A List of accepted cipher suites. Possible values are: `TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA`, `TLS_DHE_DSS_WITH_AES_128_CBC_SHA`, `TLS_DHE_DSS_WITH_AES_128_CBC_SHA256`, `TLS_DHE_DSS_WITH_AES_256_CBC_SHA`, `TLS_DHE_DSS_WITH_AES_256_CBC_SHA256`, `TLS_DHE_RSA_WITH_AES_128_CBC_SHA`, `TLS_DHE_RSA_WITH_AES_128_GCM_SHA256`, `TLS_DHE_RSA_WITH_AES_256_CBC_SHA`, `TLS_DHE_RSA_WITH_AES_256_GCM_SHA384`, `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA`, `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256`, `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256`, `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA`, `TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384`, `TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384`, `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA`, `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256`, `TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256`, `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA`, `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384`, `TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384`, `TLS_RSA_WITH_3DES_EDE_CBC_SHA`, `TLS_RSA_WITH_AES_128_CBC_SHA`, `TLS_RSA_WITH_AES_128_CBC_SHA256`, `TLS_RSA_WITH_AES_128_GCM_SHA256`, `TLS_RSA_WITH_AES_256_CBC_SHA`, `TLS_RSA_WITH_AES_256_CBC_SHA256` and `TLS_RSA_WITH_AES_256_GCM_SHA384`. -- `min_protocol_version` - (Optional) The minimal TLS version. Possible values are `TLSv1_0`, `TLSv1_1`, `TLSv1_2` and `TLSv1_3`. +* `min_protocol_version` - (Optional) The minimal TLS version. Possible values are `TLSv1_0`, `TLSv1_1`, `TLSv1_2` and `TLSv1_3`. --- A `waf_configuration` block supports the following: -- `enabled` - (Required) Is the Web Application Firewall enabled? +* `enabled` - (Required) Is the Web Application Firewall enabled? -- `firewall_mode` - (Required) The Web Application Firewall Mode. Possible values are `Detection` and `Prevention`. +* `firewall_mode` - (Required) The Web Application Firewall Mode. Possible values are `Detection` and `Prevention`. -- `rule_set_type` - (Optional) The Type of the Rule Set used for this Web Application Firewall. Possible values are `OWASP`, `Microsoft_BotManagerRuleSet` and `Microsoft_DefaultRuleSet`. Defaults to `OWASP`. +* `rule_set_type` - (Optional) The Type of the Rule Set used for this Web Application Firewall. Possible values are `OWASP`, `Microsoft_BotManagerRuleSet` and `Microsoft_DefaultRuleSet`. Defaults to `OWASP`. -- `rule_set_version` - (Required) The Version of the Rule Set used for this Web Application Firewall. Possible values are `0.1`, `1.0`, `2.1`, `2.2.9`, `3.0`, `3.1` and `3.2`. +* `rule_set_version` - (Required) The Version of the Rule Set used for this Web Application Firewall. Possible values are `0.1`, `1.0`, `2.1`, `2.2.9`, `3.0`, `3.1` and `3.2`. -- `disabled_rule_group` - (Optional) One or more `disabled_rule_group` blocks as defined below. +* `disabled_rule_group` - (Optional) One or more `disabled_rule_group` blocks as defined below. -- `file_upload_limit_mb` - (Optional) The File Upload Limit in MB. Accepted values are in the range `1`MB to `750`MB for the `WAF_v2` SKU, and `1`MB to `500`MB for all other SKUs. Defaults to `100`MB. +* `file_upload_limit_mb` - (Optional) The File Upload Limit in MB. Accepted values are in the range `1`MB to `750`MB for the `WAF_v2` SKU, and `1`MB to `500`MB for all other SKUs. Defaults to `100`MB. -- `request_body_check` - (Optional) Is Request Body Inspection enabled? Defaults to `true`. +* `request_body_check` - (Optional) Is Request Body Inspection enabled? Defaults to `true`. -- `max_request_body_size_kb` - (Optional) The Maximum Request Body Size in KB. Accepted values are in the range `1`KB to `128`KB. Defaults to `128`KB. +* `max_request_body_size_kb` - (Optional) The Maximum Request Body Size in KB. Accepted values are in the range `1`KB to `128`KB. Defaults to `128`KB. -- `exclusion` - (Optional) One or more `exclusion` blocks as defined below. +* `exclusion` - (Optional) One or more `exclusion` blocks as defined below. --- A `disabled_rule_group` block supports the following: -- `rule_group_name` - (Required) The rule group where specific rules should be disabled. Possible values are `BadBots`, `crs_20_protocol_violations`, `crs_21_protocol_anomalies`, `crs_23_request_limits`, `crs_30_http_policy`, `crs_35_bad_robots`, `crs_40_generic_attacks`, `crs_41_sql_injection_attacks`, `crs_41_xss_attacks`, `crs_42_tight_security`, `crs_45_trojans`, `crs_49_inbound_blocking`, `General`, `GoodBots`, `KnownBadBots`, `Known-CVEs`, `REQUEST-911-METHOD-ENFORCEMENT`, `REQUEST-913-SCANNER-DETECTION`, `REQUEST-920-PROTOCOL-ENFORCEMENT`, `REQUEST-921-PROTOCOL-ATTACK`, `REQUEST-930-APPLICATION-ATTACK-LFI`, `REQUEST-931-APPLICATION-ATTACK-RFI`, `REQUEST-932-APPLICATION-ATTACK-RCE`, `REQUEST-933-APPLICATION-ATTACK-PHP`, `REQUEST-941-APPLICATION-ATTACK-XSS`, `REQUEST-942-APPLICATION-ATTACK-SQLI`, `REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION`, `REQUEST-944-APPLICATION-ATTACK-JAVA`, `UnknownBots`, `METHOD-ENFORCEMENT`, `PROTOCOL-ENFORCEMENT`, `PROTOCOL-ATTACK`, `LFI`, `RFI`, `RCE`, `PHP`, `NODEJS`, `XSS`, `SQLI`, `FIX`, `JAVA`, `MS-ThreatIntel-WebShells`, `MS-ThreatIntel-AppSec`, `MS-ThreatIntel-SQLI` and `MS-ThreatIntel-CVEs`. +* `rule_group_name` - (Required) The rule group where specific rules should be disabled. Possible values are `BadBots`, `crs_20_protocol_violations`, `crs_21_protocol_anomalies`, `crs_23_request_limits`, `crs_30_http_policy`, `crs_35_bad_robots`, `crs_40_generic_attacks`, `crs_41_sql_injection_attacks`, `crs_41_xss_attacks`, `crs_42_tight_security`, `crs_45_trojans`, `crs_49_inbound_blocking`, `General`, `GoodBots`, `KnownBadBots`, `Known-CVEs`, `REQUEST-911-METHOD-ENFORCEMENT`, `REQUEST-913-SCANNER-DETECTION`, `REQUEST-920-PROTOCOL-ENFORCEMENT`, `REQUEST-921-PROTOCOL-ATTACK`, `REQUEST-930-APPLICATION-ATTACK-LFI`, `REQUEST-931-APPLICATION-ATTACK-RFI`, `REQUEST-932-APPLICATION-ATTACK-RCE`, `REQUEST-933-APPLICATION-ATTACK-PHP`, `REQUEST-941-APPLICATION-ATTACK-XSS`, `REQUEST-942-APPLICATION-ATTACK-SQLI`, `REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION`, `REQUEST-944-APPLICATION-ATTACK-JAVA`, `UnknownBots`, `METHOD-ENFORCEMENT`, `PROTOCOL-ENFORCEMENT`, `PROTOCOL-ATTACK`, `LFI`, `RFI`, `RCE`, `PHP`, `NODEJS`, `XSS`, `SQLI`, `FIX`, `JAVA`, `MS-ThreatIntel-WebShells`, `MS-ThreatIntel-AppSec`, `MS-ThreatIntel-SQLI` and `MS-ThreatIntel-CVEs`. -- `rules` - (Optional) A list of rules which should be disabled in that group. Disables all rules in the specified group if `rules` is not specified. +* `rules` - (Optional) A list of rules which should be disabled in that group. Disables all rules in the specified group if `rules` is not specified. --- A `exclusion` block supports the following: -- `match_variable` - (Required) Match variable of the exclusion rule to exclude header, cookie or GET arguments. Possible values are `RequestArgKeys`, `RequestArgNames`, `RequestArgValues`, `RequestCookieKeys`, `RequestCookieNames`, `RequestCookieValues`, `RequestHeaderKeys`, `RequestHeaderNames` and `RequestHeaderValues` +* `match_variable` - (Required) Match variable of the exclusion rule to exclude header, cookie or GET arguments. Possible values are `RequestArgKeys`, `RequestArgNames`, `RequestArgValues`, `RequestCookieKeys`, `RequestCookieNames`, `RequestCookieValues`, `RequestHeaderKeys`, `RequestHeaderNames` and `RequestHeaderValues` -- `selector_match_operator` - (Optional) Operator which will be used to search in the variable content. Possible values are `Contains`, `EndsWith`, `Equals`, `EqualsAny` and `StartsWith`. If empty will exclude all traffic on this `match_variable` +* `selector_match_operator` - (Optional) Operator which will be used to search in the variable content. Possible values are `Contains`, `EndsWith`, `Equals`, `EqualsAny` and `StartsWith`. If empty will exclude all traffic on this `match_variable` -- `selector` - (Optional) String value which will be used for the filter operation. If empty will exclude all traffic on this `match_variable` +* `selector` - (Optional) String value which will be used for the filter operation. If empty will exclude all traffic on this `match_variable` --- A `custom_error_configuration` block supports the following: -- `status_code` - (Required) Status code of the application gateway customer error. Possible values are `HttpStatus403` and `HttpStatus502` +* `status_code` - (Required) Status code of the application gateway customer error. Possible values are `HttpStatus403` and `HttpStatus502` -- `custom_error_page_url` - (Required) Error page URL of the application gateway customer error. +* `custom_error_page_url` - (Required) Error page URL of the application gateway customer error. --- A `redirect_configuration` block supports the following: -- `name` - (Required) Unique name of the redirect configuration block +* `name` - (Required) Unique name of the redirect configuration block -- `redirect_type` - (Required) The type of redirect. Possible values are `Permanent`, `Temporary`, `Found` and `SeeOther` +* `redirect_type` - (Required) The type of redirect. Possible values are `Permanent`, `Temporary`, `Found` and `SeeOther` -- `target_listener_name` - (Optional) The name of the listener to redirect to. Cannot be set if `target_url` is set. +* `target_listener_name` - (Optional) The name of the listener to redirect to. Cannot be set if `target_url` is set. -- `target_url` - (Optional) The URL to redirect the request to. Cannot be set if `target_listener_name` is set. +* `target_url` - (Optional) The URL to redirect the request to. Cannot be set if `target_listener_name` is set. -- `include_path` - (Optional) Whether to include the path in the redirected URL. Defaults to `false` +* `include_path` - (Optional) Whether to include the path in the redirected URL. Defaults to `false` -- `include_query_string` - (Optional) Whether to include the query string in the redirected URL. Default to `false` +* `include_query_string` - (Optional) Whether to include the query string in the redirected URL. Default to `false` --- An `autoscale_configuration` block supports the following: -- `min_capacity` - (Required) Minimum capacity for autoscaling. Accepted values are in the range `0` to `100`. +* `min_capacity` - (Required) Minimum capacity for autoscaling. Accepted values are in the range `0` to `100`. -- `max_capacity` - (Optional) Maximum capacity for autoscaling. Accepted values are in the range `2` to `125`. +* `max_capacity` - (Optional) Maximum capacity for autoscaling. Accepted values are in the range `2` to `125`. --- A `rewrite_rule_set` block supports the following: -- `name` - (Required) Unique name of the rewrite rule set block +* `name` - (Required) Unique name of the rewrite rule set block -- `rewrite_rule` - (Optional) One or more `rewrite_rule` blocks as defined below. +* `rewrite_rule` - (Optional) One or more `rewrite_rule` blocks as defined below. --- A `rewrite_rule` block supports the following: -- `name` - (Required) Unique name of the rewrite rule block +* `name` - (Required) Unique name of the rewrite rule block -- `rule_sequence` - (Required) Rule sequence of the rewrite rule that determines the order of execution in a set. +* `rule_sequence` - (Required) Rule sequence of the rewrite rule that determines the order of execution in a set. -- `condition` - (Optional) One or more `condition` blocks as defined above. +* `condition` - (Optional) One or more `condition` blocks as defined above. -- `request_header_configuration` - (Optional) One or more `request_header_configuration` blocks as defined above. +* `request_header_configuration` - (Optional) One or more `request_header_configuration` blocks as defined above. -- `response_header_configuration` - (Optional) One or more `response_header_configuration` blocks as defined above. +* `response_header_configuration` - (Optional) One or more `response_header_configuration` blocks as defined above. -- `url` - (Optional) One `url` block as defined below +* `url` - (Optional) One `url` block as defined below --- A `condition` block supports the following: -- `variable` - (Required) The [variable](https://docs.microsoft.com/azure/application-gateway/rewrite-http-headers#server-variables) of the condition. +* `variable` - (Required) The [variable](https://docs.microsoft.com/azure/application-gateway/rewrite-http-headers#server-variables) of the condition. -- `pattern` - (Required) The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* `pattern` - (Required) The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -- `ignore_case` - (Optional) Perform a case in-sensitive comparison. Defaults to `false` +* `ignore_case` - (Optional) Perform a case in-sensitive comparison. Defaults to `false` -- `negate` - (Optional) Negate the result of the condition evaluation. Defaults to `false` +* `negate` - (Optional) Negate the result of the condition evaluation. Defaults to `false` --- A `request_header_configuration` block supports the following: -- `header_name` - (Required) Header name of the header configuration. +* `header_name` - (Required) Header name of the header configuration. -- `header_value` - (Required) Header value of the header configuration. To delete a request header set this property to an empty string. +* `header_value` - (Required) Header value of the header configuration. To delete a request header set this property to an empty string. --- A `response_header_configuration` block supports the following: -- `header_name` - (Required) Header name of the header configuration. +* `header_name` - (Required) Header name of the header configuration. -- `header_value` - (Required) Header value of the header configuration. To delete a response header set this property to an empty string. +* `header_value` - (Required) Header value of the header configuration. To delete a response header set this property to an empty string. --- A `url` block supports the following: -- `path` - (Optional) The URL path to rewrite. +* `path` - (Optional) The URL path to rewrite. -- `query_string` - (Optional) The query string to rewrite. +* `query_string` - (Optional) The query string to rewrite. -- `components` - (Optional) The components used to rewrite the URL. Possible values are `path_only` and `query_string_only` to limit the rewrite to the URL Path or URL Query String only. +* `components` - (Optional) The components used to rewrite the URL. Possible values are `path_only` and `query_string_only` to limit the rewrite to the URL Path or URL Query String only. ~> **Note:** One or both of `path` and `query_string` must be specified. If one of these is not specified, it means the value will be empty. If you only want to rewrite `path` or `query_string`, use `components`. -- `reroute` - (Optional) Whether the URL path map should be reevaluated after this rewrite has been applied. [More info on rewrite configuration](https://docs.microsoft.com/azure/application-gateway/rewrite-http-headers-url#rewrite-configuration) +* `reroute` - (Optional) Whether the URL path map should be reevaluated after this rewrite has been applied. [More info on rewrite configuration](https://docs.microsoft.com/azure/application-gateway/rewrite-http-headers-url#rewrite-configuration) ## Attributes Reference In addition to the Arguments listed above - the following Attributes are exported: -- `id` - The ID of the Application Gateway. +* `id` - The ID of the Application Gateway. -- `authentication_certificate` - A list of `authentication_certificate` blocks as defined below. +* `authentication_certificate` - A list of `authentication_certificate` blocks as defined below. -- `backend_address_pool` - A list of `backend_address_pool` blocks as defined below. +* `backend_address_pool` - A list of `backend_address_pool` blocks as defined below. -- `backend_http_settings` - A list of `backend_http_settings` blocks as defined below. +* `backend_http_settings` - A list of `backend_http_settings` blocks as defined below. -- `frontend_ip_configuration` - A list of `frontend_ip_configuration` blocks as defined below. +* `frontend_ip_configuration` - A list of `frontend_ip_configuration` blocks as defined below. -- `frontend_port` - A list of `frontend_port` blocks as defined below. +* `frontend_port` - A list of `frontend_port` blocks as defined below. -- `gateway_ip_configuration` - A list of `gateway_ip_configuration` blocks as defined below. +* `gateway_ip_configuration` - A list of `gateway_ip_configuration` blocks as defined below. -- `http_listener` - A list of `http_listener` blocks as defined below. +* `http_listener` - A list of `http_listener` blocks as defined below. -- `private_endpoint_connection` - A list of `private_endpoint_connection` blocks as defined below. +* `private_endpoint_connection` - A list of `private_endpoint_connection` blocks as defined below. -- `private_link_configuration` - A list of `private_link_configuration` blocks as defined below. +* `private_link_configuration` - A list of `private_link_configuration` blocks as defined below. -- `probe` - A `probe` block as defined below. +* `probe` - A `probe` block as defined below. -- `request_routing_rule` - A list of `request_routing_rule` blocks as defined below. +* `request_routing_rule` - A list of `request_routing_rule` blocks as defined below. -- `ssl_certificate` - A list of `ssl_certificate` blocks as defined below. +* `ssl_certificate` - A list of `ssl_certificate` blocks as defined below. -- `url_path_map` - A list of `url_path_map` blocks as defined below. +* `url_path_map` - A list of `url_path_map` blocks as defined below. -- `custom_error_configuration` - A list of `custom_error_configuration` blocks as defined below. +* `custom_error_configuration` - A list of `custom_error_configuration` blocks as defined below. -- `redirect_configuration` - A list of `redirect_configuration` blocks as defined below. +* `redirect_configuration` - A list of `redirect_configuration` blocks as defined below. --- A `authentication_certificate` block exports the following: -- `id` - The ID of the Authentication Certificate. +* `id` - The ID of the Authentication Certificate. --- A `authentication_certificate` block, within the `backend_http_settings` block exports the following: -- `id` - The ID of the Authentication Certificate. +* `id` - The ID of the Authentication Certificate. --- A `backend_address_pool` block exports the following: -- `id` - The ID of the Backend Address Pool. +* `id` - The ID of the Backend Address Pool. --- A `backend_http_settings` block exports the following: -- `id` - The ID of the Backend HTTP Settings Configuration. +* `id` - The ID of the Backend HTTP Settings Configuration. -- `probe_id` - The ID of the associated Probe. +* `probe_id` - The ID of the associated Probe. --- A `frontend_ip_configuration` block exports the following: -- `id` - The ID of the Frontend IP Configuration. +* `id` - The ID of the Frontend IP Configuration. -- `private_link_configuration_id` - The ID of the associated private link configuration. +* `private_link_configuration_id` - The ID of the associated private link configuration. --- A `frontend_port` block exports the following: -- `id` - The ID of the Frontend Port. +* `id` - The ID of the Frontend Port. --- A `gateway_ip_configuration` block exports the following: -- `id` - The ID of the Gateway IP Configuration. +* `id` - The ID of the Gateway IP Configuration. --- A `http_listener` block exports the following: -- `id` - The ID of the HTTP Listener. +* `id` - The ID of the HTTP Listener. -- `frontend_ip_configuration_id` - The ID of the associated Frontend Configuration. +* `frontend_ip_configuration_id` - The ID of the associated Frontend Configuration. -- `frontend_port_id` - The ID of the associated Frontend Port. +* `frontend_port_id` - The ID of the associated Frontend Port. -- `ssl_certificate_id` - The ID of the associated SSL Certificate. +* `ssl_certificate_id` - The ID of the associated SSL Certificate. -- `ssl_profile_id` - The ID of the associated SSL Profile. +* `ssl_profile_id` - The ID of the associated SSL Profile. --- A `path_rule` block exports the following: -- `id` - The ID of the Path Rule. +* `id` - The ID of the Path Rule. -- `backend_address_pool_id` - The ID of the Backend Address Pool used in this Path Rule. +* `backend_address_pool_id` - The ID of the Backend Address Pool used in this Path Rule. -- `backend_http_settings_id` - The ID of the Backend HTTP Settings Collection used in this Path Rule. +* `backend_http_settings_id` - The ID of the Backend HTTP Settings Collection used in this Path Rule. -- `redirect_configuration_id` - The ID of the Redirect Configuration used in this Path Rule. +* `redirect_configuration_id` - The ID of the Redirect Configuration used in this Path Rule. -- `rewrite_rule_set_id` - The ID of the Rewrite Rule Set used in this Path Rule. +* `rewrite_rule_set_id` - The ID of the Rewrite Rule Set used in this Path Rule. --- A `private_endpoint_connection` block exports the following: -- `name` - The name of the private endpoint connection. +* `name` - The name of the private endpoint connection. -- `id` - The ID of the private endpoint connection. +* `id` - The ID of the private endpoint connection. --- A `private_link_configuration` block exports the following: -- `id` - The ID of the private link configuration. +* `id` - The ID of the private link configuration. --- A `probe` block exports the following: -- `id` - The ID of the Probe. +* `id` - The ID of the Probe. --- A `request_routing_rule` block exports the following: -- `id` - The ID of the Request Routing Rule. +* `id` - The ID of the Request Routing Rule. -- `http_listener_id` - The ID of the associated HTTP Listener. +* `http_listener_id` - The ID of the associated HTTP Listener. -- `backend_address_pool_id` - The ID of the associated Backend Address Pool. +* `backend_address_pool_id` - The ID of the associated Backend Address Pool. -- `backend_http_settings_id` - The ID of the associated Backend HTTP Settings Configuration. +* `backend_http_settings_id` - The ID of the associated Backend HTTP Settings Configuration. -- `redirect_configuration_id` - The ID of the associated Redirect Configuration. +* `redirect_configuration_id` - The ID of the associated Redirect Configuration. -- `rewrite_rule_set_id` - The ID of the associated Rewrite Rule Set. +* `rewrite_rule_set_id` - The ID of the associated Rewrite Rule Set. -- `url_path_map_id` - The ID of the associated URL Path Map. +* `url_path_map_id` - The ID of the associated URL Path Map. --- A `ssl_certificate` block exports the following: -- `id` - The ID of the SSL Certificate. +* `id` - The ID of the SSL Certificate. -- `public_cert_data` - The Public Certificate Data associated with the SSL Certificate. +* `public_cert_data` - The Public Certificate Data associated with the SSL Certificate. --- A `url_path_map` block exports the following: -- `id` - The ID of the URL Path Map. +* `id` - The ID of the URL Path Map. -- `default_backend_address_pool_id` - The ID of the Default Backend Address Pool. +* `default_backend_address_pool_id` - The ID of the Default Backend Address Pool. -- `default_backend_http_settings_id` - The ID of the Default Backend HTTP Settings Collection. +* `default_backend_http_settings_id` - The ID of the Default Backend HTTP Settings Collection. -- `default_redirect_configuration_id` - The ID of the Default Redirect Configuration. +* `default_redirect_configuration_id` - The ID of the Default Redirect Configuration. -- `path_rule` - (Required) A list of `path_rule` blocks as defined above. +* `path_rule` - (Required) A list of `path_rule` blocks as defined above. --- A `custom_error_configuration` block exports the following: -- `id` - The ID of the Custom Error Configuration. +* `id` - The ID of the Custom Error Configuration. --- A `redirect_configuration` block exports the following: -- `id` - The ID of the Redirect Configuration. +* `id` - The ID of the Redirect Configuration. --- A `rewrite_rule_set` block exports the following: -- `id` - The ID of the Rewrite Rule Set +* `id` - The ID of the Rewrite Rule Set ## Timeouts The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions: -- `create` - (Defaults to 90 minutes) Used when creating the Application Gateway. -- `update` - (Defaults to 90 minutes) Used when updating the Application Gateway. -- `read` - (Defaults to 5 minutes) Used when retrieving the Application Gateway. -- `delete` - (Defaults to 90 minutes) Used when deleting the Application Gateway. +* `create` - (Defaults to 90 minutes) Used when creating the Application Gateway. +* `update` - (Defaults to 90 minutes) Used when updating the Application Gateway. +* `read` - (Defaults to 5 minutes) Used when retrieving the Application Gateway. +* `delete` - (Defaults to 90 minutes) Used when deleting the Application Gateway. ## Import