Share via

Front Doors - List

Service:
Front Door Service
API Version:
2021-06-01

Lists all of the Front Doors within an Azure subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoors?api-version=2021-06-01

URI Parameters

Name In Required Type Description
subscriptionId
 path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version
 query True

string

Client API version.

Responses

Name Type Description
200 OK

FrontDoorListResult

OK
Other Status Codes

ErrorResponse

Front Door error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List all Front Doors

Sample request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/frontDoors?api-version=2021-06-01

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1",
      "name": "frontDoor1",
      "type": "Microsoft.Network/frontDoor",
      "location": "westus",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "properties": {
        "routingRules": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1",
            "name": "routingRule1",
            "properties": {
              "frontendEndpoints": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default"
                }
              ],
              "acceptedProtocols": [
                "Http"
              ],
              "patternsToMatch": [
                "/*"
              ],
              "routeConfiguration": {
                "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
                "customForwardingPath": "",
                "forwardingProtocol": "MatchRequest",
                "backendPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
                }
              },
              "rulesEngine": {
                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1"
              },
              "enabledState": "Enabled",
              "webApplicationFirewallPolicyLink": {
                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
              }
            }
          }
        ],
        "healthProbeSettings": [
          {
            "name": "healthProbeSettings1",
            "properties": {
              "path": "/",
              "protocol": "Http",
              "intervalInSeconds": 120,
              "enabledState": "Enabled",
              "healthProbeMethod": "HEAD"
            }
          }
        ],
        "loadBalancingSettings": [
          {
            "name": "loadBalancingSettings1",
            "properties": {
              "sampleSize": 4,
              "successfulSamplesRequired": 2
            }
          }
        ],
        "backendPools": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
            "name": "backendPool1",
            "properties": {
              "backends": [
                {
                  "address": "w3.contoso.com",
                  "httpPort": 80,
                  "httpsPort": 443,
                  "enabledState": "Enabled",
                  "weight": 1,
                  "priority": 2
                },
                {
                  "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
                  "privateLinkLocation": "eastus",
                  "privateEndpointStatus": "Approved",
                  "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
                  "address": "contoso.com.website-us-west-2.othercloud.net",
                  "httpPort": 80,
                  "httpsPort": 443,
                  "enabledState": "Enabled",
                  "weight": 2,
                  "priority": 1
                },
                {
                  "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice",
                  "privateEndpointStatus": "Approved",
                  "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
                  "address": "10.0.1.5",
                  "httpPort": 80,
                  "httpsPort": 443,
                  "enabledState": "Enabled",
                  "weight": 1,
                  "priority": 1
                }
              ],
              "loadBalancingSettings": {
                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1"
              },
              "healthProbeSettings": {
                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1"
              }
            }
          }
        ],
        "frontendEndpoints": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1",
            "name": "frontendEndpoint1",
            "properties": {
              "hostName": "www.contoso.com",
              "sessionAffinityEnabledState": "Enabled",
              "sessionAffinityTtlSeconds": 60,
              "webApplicationFirewallPolicyLink": {
                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
              }
            }
          },
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default",
            "name": "default",
            "properties": {
              "hostName": "frontDoor1.azurefd.net"
            }
          }
        ],
        "rulesEngines": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/rulesEngine1",
            "name": "rulesEngine1",
            "properties": {
              "rules": [
                {
                  "name": "Rule1",
                  "priority": 1,
                  "action": {
                    "routeConfigurationOverride": {
                      "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
                      "redirectType": "Moved",
                      "redirectProtocol": "HttpsOnly",
                      "customHost": "www.bing.com",
                      "customPath": "/api",
                      "customFragment": "fragment",
                      "customQueryString": "a=b"
                    }
                  },
                  "matchConditions": [
                    {
                      "rulesEngineMatchVariable": "RemoteAddr",
                      "rulesEngineOperator": "GeoMatch",
                      "rulesEngineMatchValue": [
                        "CH"
                      ]
                    }
                  ],
                  "matchProcessingBehavior": "Stop"
                },
                {
                  "name": "Rule2",
                  "priority": 2,
                  "action": {
                    "responseHeaderActions": [
                      {
                        "headerActionType": "Overwrite",
                        "headerName": "Cache-Control",
                        "value": "public, max-age=31536000"
                      }
                    ]
                  },
                  "matchConditions": [
                    {
                      "rulesEngineMatchVariable": "FilenameExtension",
                      "rulesEngineOperator": "Equal",
                      "rulesEngineMatchValue": [
                        "jpg"
                      ],
                      "transforms": [
                        "Lowercase"
                      ]
                    }
                  ]
                }
              ]
            }
          }
        ],
        "backendPoolsSettings": {
          "enforceCertificateNameCheck": "Enabled"
        },
        "enabledState": "Enabled",
        "resourceState": "Enabled",
        "provisioningState": "Succeeded",
        "cname": "frontDoor1.azurefd.net"
      }
    }
  ]
}

Definitions

Name Description
Backend

Backend address of a frontDoor load balancer.
backendEnabledState

Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'
BackendPool

A backend pool is a collection of backends that can be routed to.
BackendPoolsSettings

Settings that apply to all backend pools.
CacheConfiguration

Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
CustomHttpsConfiguration

Https settings for a domain
CustomHttpsProvisioningState

Provisioning status of Custom Https of the frontendEndpoint.
CustomHttpsProvisioningSubstate

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
DynamicCompressionEnabled

Whether to use dynamic compression for cached content
enforceCertificateNameCheckEnabledState

Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.
ErrorResponse

Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
ForwardingConfiguration

Describes Forwarding Route.
FrontDoor

Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.
FrontDoorCertificateSource

Defines the source of the SSL certificate
FrontDoorCertificateType

Defines the type of the certificate used for secure connections to a frontendEndpoint
FrontDoorEnabledState

Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'
FrontDoorForwardingProtocol

Protocol this rule will use when forwarding traffic to backends.
FrontDoorHealthProbeMethod

Configures which HTTP method to use to probe the backends defined under backendPools.
FrontDoorListResult

Result of the request to list Front Doors. It contains a list of Front Door objects and a URL link to get the next set of results.
FrontDoorProtocol

Protocol schemes to match for this rule
FrontDoorQuery

Treatment of URL query terms when forming the cache key.
FrontDoorRedirectProtocol

The protocol of the destination to where the traffic is redirected
FrontDoorRedirectType

The redirect type the rule will use when redirecting traffic.
FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.
FrontDoorTlsProtocolType

Defines the TLS extension protocol that is used for secure delivery
FrontendEndpoint

A frontend endpoint used for routing.
FrontendEndpointUpdateParameters.WebApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for each host (if applicable)
HeaderAction

An action that can manipulate an http header.
headerActionType

Which type of manipulation to apply to the header.
HealthProbeEnabled

Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
HealthProbeSettingsModel

Load balancing settings for a backend pool
LoadBalancingSettingsModel

Load balancing settings for a backend pool
MatchProcessingBehavior

If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.
MinimumTLSVersion

The minimum TLS version required from the clients to establish an SSL handshake with Front Door.
PrivateEndpointStatus

The Approval status for the connection to the Private Link
RedirectConfiguration

Describes Redirect Route.
RoutingRule

A routing rule represents a specification for traffic to treat and where to send it, along with health probe information.
routingRuleEnabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
RulesEngine

A rules engine configuration containing a list of rules that will run to modify the runtime behavior of the request and response.
RulesEngineAction

One or more actions that will execute, modifying the request and/or response.
RulesEngineMatchCondition

Define a match condition
RulesEngineMatchVariable

Match Variable
RulesEngineOperator

Describes operator to apply to the match condition.
RulesEngineRule

Contains a list of match conditions, and an action on how to modify the request/response. If multiple rules match, the actions from one rule that conflict with a previous rule overwrite for a singular action, or append in the case of headers manipulation.
SessionAffinityEnabledState

Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
SubResource

Reference to another subresource.
transform

Describes what transforms are applied before matching
Vault

The Key Vault containing the SSL certificate
WebApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for each routing rule (if applicable)

Backend

Object

Backend address of a frontDoor load balancer.

Name Type Description
address

string

Location of the backend (IP address or FQDN)
backendHostHeader

string

The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.
enabledState

backendEnabledState

Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'
httpPort

integer

minimum: 1
maximum: 65535
exclusiveMinimum: False
exclusiveMaximum: False

The HTTP TCP port number. Must be between 1 and 65535.
httpsPort

integer

minimum: 1
maximum: 65535
exclusiveMinimum: False
exclusiveMaximum: False

The HTTPS TCP port number. Must be between 1 and 65535.
priority

integer

minimum: 1
maximum: 5

Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.
privateEndpointStatus

PrivateEndpointStatus

The Approval status for the connection to the Private Link
privateLinkAlias

string

The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
privateLinkApprovalMessage

string

A custom message to be included in the approval request to connect to the Private Link
privateLinkLocation

string

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
privateLinkResourceId

string

The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
weight

integer

minimum: 1
maximum: 1000

Weight of this endpoint for load balancing purposes.

backendEnabledState

Enumeration

Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'

Value Description
Enabled
Disabled

BackendPool

Object

A backend pool is a collection of backends that can be routed to.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.backends

Backend[]

The set of backends for this pool
properties.healthProbeSettings

SubResource

L7 health probe settings for a backend pool
properties.loadBalancingSettings

SubResource

Load balancing settings for a backend pool
properties.resourceState

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.
Resource status.
type

string

Resource type.

BackendPoolsSettings

Object

Settings that apply to all backend pools.

Name Type Default value Description
enforceCertificateNameCheck

enforceCertificateNameCheckEnabledState

Enabled

Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.
sendRecvTimeoutSeconds

integer

minimum: 16
exclusiveMinimum: False

Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns.

CacheConfiguration

Object

Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.

Name Type Description
cacheDuration

string (duration)

The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year
dynamicCompression

DynamicCompressionEnabled

Whether to use dynamic compression for cached content
queryParameterStripDirective

FrontDoorQuery

Treatment of URL query terms when forming the cache key.
queryParameters

string

query parameters to include or exclude (comma separated).

CustomHttpsConfiguration

Object

Https settings for a domain

Name Type Description
certificateSource

FrontDoorCertificateSource

Defines the source of the SSL certificate
frontDoorCertificateSourceParameters.certificateType

FrontDoorCertificateType

Defines the type of the certificate used for secure connections to a frontendEndpoint
keyVaultCertificateSourceParameters.secretName

string

The name of the Key Vault secret representing the full certificate PFX
keyVaultCertificateSourceParameters.secretVersion

string

The version of the Key Vault secret representing the full certificate PFX
keyVaultCertificateSourceParameters.vault

Vault

The Key Vault containing the SSL certificate
minimumTlsVersion

MinimumTLSVersion

The minimum TLS version required from the clients to establish an SSL handshake with Front Door.
protocolType

FrontDoorTlsProtocolType

Defines the TLS extension protocol that is used for secure delivery

CustomHttpsProvisioningState

Enumeration

Provisioning status of Custom Https of the frontendEndpoint.

Value Description
Enabling
Enabled
Disabling
Disabled
Failed

CustomHttpsProvisioningSubstate

Enumeration

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

Value Description
SubmittingDomainControlValidationRequest
PendingDomainControlValidationREquestApproval
DomainControlValidationRequestApproved
DomainControlValidationRequestRejected
DomainControlValidationRequestTimedOut
IssuingCertificate
DeployingCertificate
CertificateDeployed
DeletingCertificate
CertificateDeleted

DynamicCompressionEnabled

Enumeration

Whether to use dynamic compression for cached content

Value Description
Enabled
Disabled

enforceCertificateNameCheckEnabledState

Enumeration

Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.

Value Description
Enabled
Disabled

ErrorResponse

Object

Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code

string

Error code.
message

string

Error message indicating why the operation failed.

ForwardingConfiguration

Object

Describes Forwarding Route.

Name Type Description
@odata.type string:

#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration

backendPool

SubResource

A reference to the BackendPool which this rule routes to.
cacheConfiguration

CacheConfiguration

The caching configuration associated with this rule.
customForwardingPath

string

A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
forwardingProtocol

FrontDoorForwardingProtocol

Protocol this rule will use when forwarding traffic to backends.

FrontDoor

Object

Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.

Name Type Description
id

string

Resource ID.
location

string

Resource location.
name

string

Resource name.
properties.backendPools

BackendPool[]

Backend pools available to routing rules.
properties.backendPoolsSettings

BackendPoolsSettings

Settings for all backendPools
properties.cname

string

The host that each frontendEndpoint must CNAME to.
properties.enabledState

FrontDoorEnabledState

Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'
properties.extendedProperties

object

Key-Value pair representing additional properties for frontdoor.
properties.friendlyName

string

A friendly name for the frontDoor
properties.frontdoorId

string

The Id of the frontdoor.
properties.frontendEndpoints

FrontendEndpoint[]

Frontend endpoints available to routing rules.
properties.healthProbeSettings

HealthProbeSettingsModel[]

Health probe settings associated with this Front Door instance.
properties.loadBalancingSettings

LoadBalancingSettingsModel[]

Load balancing settings associated with this Front Door instance.
properties.provisioningState

string

Provisioning state of the Front Door.
properties.resourceState

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.
Resource status of the Front Door.
properties.routingRules

RoutingRule[]

Routing rules associated with this Front Door.
properties.rulesEngines

RulesEngine[]

Rules Engine Configurations available to routing rules.
tags

object

Resource tags.
type

string

Resource type.

FrontDoorCertificateSource

Enumeration

Defines the source of the SSL certificate

Value Description
AzureKeyVault
FrontDoor

FrontDoorCertificateType

Enumeration

Defines the type of the certificate used for secure connections to a frontendEndpoint

Value Description
Dedicated

FrontDoorEnabledState

Enumeration

Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'

Value Description
Enabled
Disabled

FrontDoorForwardingProtocol

Enumeration

Protocol this rule will use when forwarding traffic to backends.

Value Description
HttpOnly
HttpsOnly
MatchRequest

FrontDoorHealthProbeMethod

Enumeration

Configures which HTTP method to use to probe the backends defined under backendPools.

Value Description
GET
HEAD

FrontDoorListResult

Object

Result of the request to list Front Doors. It contains a list of Front Door objects and a URL link to get the next set of results.

Name Type Description
nextLink

string

URL to get the next set of Front Door objects if there are any.
value

FrontDoor[]

List of Front Doors within a resource group.

FrontDoorProtocol

Enumeration

Protocol schemes to match for this rule

Value Description
Http
Https

FrontDoorQuery

Enumeration

Treatment of URL query terms when forming the cache key.

Value Description
StripNone
StripAll
StripOnly
StripAllExcept

FrontDoorRedirectProtocol

Enumeration

The protocol of the destination to where the traffic is redirected

Value Description
HttpOnly
HttpsOnly
MatchRequest

FrontDoorRedirectType

Enumeration

The redirect type the rule will use when redirecting traffic.

Value Description
Moved
Found
TemporaryRedirect
PermanentRedirect

FrontDoorResourceState

Enumeration

Resource status of the Front Door or Front Door SubResource.

Value Description
Creating
Enabling
Enabled
Disabling
Disabled
Deleting
Migrating
Migrated

FrontDoorTlsProtocolType

Enumeration

Defines the TLS extension protocol that is used for secure delivery

Value Description
ServerNameIndication

FrontendEndpoint

Object

A frontend endpoint used for routing.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.customHttpsConfiguration

CustomHttpsConfiguration

The configuration specifying how to enable HTTPS
properties.customHttpsProvisioningState

CustomHttpsProvisioningState

Provisioning status of Custom Https of the frontendEndpoint.
properties.customHttpsProvisioningSubstate

CustomHttpsProvisioningSubstate

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
properties.hostName

string

The host name of the frontendEndpoint. Must be a domain name.
properties.resourceState

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.
Resource status.
properties.sessionAffinityEnabledState

SessionAffinityEnabledState

Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
properties.sessionAffinityTtlSeconds

integer

UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.
properties.webApplicationFirewallPolicyLink

FrontendEndpointUpdateParameters.WebApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for each host (if applicable)
type

string

Resource type.
Object

Defines the Web Application Firewall policy for each host (if applicable)

Name Type Description
id

string

Resource ID.

HeaderAction

Object

An action that can manipulate an http header.

Name Type Description
headerActionType

headerActionType

Which type of manipulation to apply to the header.
headerName

string

The name of the header this action will apply to.
value

string

The value to update the given header name with. This value is not used if the actionType is Delete.

headerActionType

Enumeration

Which type of manipulation to apply to the header.

Value Description
Append
Delete
Overwrite

HealthProbeEnabled

Enumeration

Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.

Value Description
Enabled
Disabled

HealthProbeSettingsModel

Object

Load balancing settings for a backend pool

Name Type Default value Description
id

string

Resource ID.
name

string

Resource name.
properties.enabledState

HealthProbeEnabled

Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
properties.healthProbeMethod

FrontDoorHealthProbeMethod

HEAD

Configures which HTTP method to use to probe the backends defined under backendPools.
properties.intervalInSeconds

integer

The number of seconds between health probes.
properties.path

string

The path to use for the health probe. Default is /
properties.protocol

FrontDoorProtocol

Protocol scheme to use for this probe
properties.resourceState

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.
Resource status.
type

string

Resource type.

LoadBalancingSettingsModel

Object

Load balancing settings for a backend pool

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.additionalLatencyMilliseconds

integer

The additional latency in milliseconds for probes to fall into the lowest latency bucket
properties.resourceState

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.
Resource status.
properties.sampleSize

integer

The number of samples to consider for load balancing decisions
properties.successfulSamplesRequired

integer

The number of samples within the sample period that must succeed
type

string

Resource type.

MatchProcessingBehavior

Enumeration

If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

Value Description
Continue
Stop

MinimumTLSVersion

Enumeration

The minimum TLS version required from the clients to establish an SSL handshake with Front Door.

Value Description
1.0
1.2

PrivateEndpointStatus

Enumeration

The Approval status for the connection to the Private Link

Value Description
Pending
Approved
Rejected
Disconnected
Timeout

RedirectConfiguration

Object

Describes Redirect Route.

Name Type Description
@odata.type string:

#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration

customFragment

string

Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
customHost

string

Host to redirect. Leave empty to use the incoming host as the destination host.
customPath

string

The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
customQueryString

string

The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>=<value> format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
redirectProtocol

FrontDoorRedirectProtocol

The protocol of the destination to where the traffic is redirected
redirectType

FrontDoorRedirectType

The redirect type the rule will use when redirecting traffic.

RoutingRule

Object

A routing rule represents a specification for traffic to treat and where to send it, along with health probe information.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.acceptedProtocols

FrontDoorProtocol[]

Protocol schemes to match for this rule
properties.enabledState

routingRuleEnabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
properties.frontendEndpoints

SubResource[]

Frontend endpoints associated with this rule
properties.patternsToMatch

string[]

The route patterns of the rule.
properties.resourceState

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.
Resource status.
properties.routeConfiguration RouteConfiguration:

A reference to the routing configuration.
properties.rulesEngine

SubResource

A reference to a specific Rules Engine Configuration to apply to this route.
properties.webApplicationFirewallPolicyLink

WebApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for each routing rule (if applicable)
type

string

Resource type.

routingRuleEnabledState

Enumeration

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'

Value Description
Enabled
Disabled

RulesEngine

Object

A rules engine configuration containing a list of rules that will run to modify the runtime behavior of the request and response.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.resourceState

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.
Resource status.
properties.rules

RulesEngineRule[]

A list of rules that define a particular Rules Engine Configuration.
type

string

Resource type.

RulesEngineAction

Object

One or more actions that will execute, modifying the request and/or response.

Name Type Description
requestHeaderActions

HeaderAction[]

A list of header actions to apply from the request from AFD to the origin.
responseHeaderActions

HeaderAction[]

A list of header actions to apply from the response from AFD to the client.
routeConfigurationOverride RouteConfiguration:

Override the route configuration.

RulesEngineMatchCondition

Object

Define a match condition

Name Type Description
negateCondition

boolean

Describes if this is negate condition or not
rulesEngineMatchValue

string[]

Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
rulesEngineMatchVariable

RulesEngineMatchVariable

Match Variable
rulesEngineOperator

RulesEngineOperator

Describes operator to apply to the match condition.
selector

string

Name of selector in RequestHeader or RequestBody to be matched
transforms

transform[]

List of transforms

RulesEngineMatchVariable

Enumeration

Match Variable

Value Description
IsMobile
RemoteAddr
RequestMethod
QueryString
PostArgs
RequestUri
RequestPath
RequestFilename
RequestFilenameExtension
RequestHeader
RequestBody
RequestScheme

RulesEngineOperator

Enumeration

Describes operator to apply to the match condition.

Value Description
Any
IPMatch
GeoMatch
Equal
Contains
LessThan
GreaterThan
LessThanOrEqual
GreaterThanOrEqual
BeginsWith
EndsWith

RulesEngineRule

Object

Contains a list of match conditions, and an action on how to modify the request/response. If multiple rules match, the actions from one rule that conflict with a previous rule overwrite for a singular action, or append in the case of headers manipulation.

Name Type Description
action

RulesEngineAction

Actions to perform on the request and response if all of the match conditions are met.
matchConditions

RulesEngineMatchCondition[]

A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
matchProcessingBehavior

MatchProcessingBehavior

If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.
name

string

A name to refer to this specific rule.
priority

integer

A priority assigned to this rule.

SessionAffinityEnabledState

Enumeration

Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'

Value Description
Enabled
Disabled

SubResource

Object

Reference to another subresource.

Name Type Description
id

string

Resource ID.

transform

Enumeration

Describes what transforms are applied before matching

Value Description
Lowercase
Uppercase
Trim
UrlDecode
UrlEncode
RemoveNulls

Vault

Object

The Key Vault containing the SSL certificate

Name Type Description
id

string

Resource ID.
Object

Defines the Web Application Firewall policy for each routing rule (if applicable)

Name Type Description
id

string

Resource ID.