front_doors

Creates, updates, deletes, gets or lists a front_doors resource.

Overview

Name	front_doors
Type	Resource
Id	azure.front_door.front_doors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
backendPools	array	Backend pools available to routing rules.
backendPoolsSettings	object	Settings for all backendPools.
cname	string	The host that each frontendEndpoint must CNAME to.
enabledState	string	Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
extendedProperties	object	Key-Value pair representing additional properties for frontdoor.
friendlyName	string	A friendly name for the frontDoor.
frontdoorId	string	The Id of the frontdoor.
frontendEndpoints	array	Frontend endpoints available to routing rules.
healthProbeSettings	array	Health probe settings associated with this Front Door instance.
loadBalancingSettings	array	Load balancing settings associated with this Front Door instance.
location	string	Resource location.
provisioningState	string	Provisioning state of the Front Door.
resourceState	string	Resource status of the Front Door or Front Door SubResource. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", "Deleting", "Migrating", and "Migrated". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting, Migrating, Migrated)
routingRules	array	Routing rules associated with this Front Door.
rulesEngines	array	Rules Engine Configurations available to routing rules.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
backendPools	array	Backend pools available to routing rules.
backendPoolsSettings	object	Settings for all backendPools.
cname	string	The host that each frontendEndpoint must CNAME to.
enabledState	string	Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
extendedProperties	object	Key-Value pair representing additional properties for frontdoor.
friendlyName	string	A friendly name for the frontDoor.
frontdoorId	string	The Id of the frontdoor.
frontendEndpoints	array	Frontend endpoints available to routing rules.
healthProbeSettings	array	Health probe settings associated with this Front Door instance.
loadBalancingSettings	array	Load balancing settings associated with this Front Door instance.
location	string	Resource location.
provisioningState	string	Provisioning state of the Front Door.
resourceState	string	Resource status of the Front Door or Front Door SubResource. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", "Deleting", "Migrating", and "Migrated". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting, Migrating, Migrated)
routingRules	array	Routing rules associated with this Front Door.
rulesEngines	array	Rules Engine Configurations available to routing rules.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
backendPools	array	Backend pools available to routing rules.
backendPoolsSettings	object	Settings for all backendPools.
cname	string	The host that each frontendEndpoint must CNAME to.
enabledState	string	Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
extendedProperties	object	Key-Value pair representing additional properties for frontdoor.
friendlyName	string	A friendly name for the frontDoor.
frontdoorId	string	The Id of the frontdoor.
frontendEndpoints	array	Frontend endpoints available to routing rules.
healthProbeSettings	array	Health probe settings associated with this Front Door instance.
loadBalancingSettings	array	Load balancing settings associated with this Front Door instance.
location	string	Resource location.
provisioningState	string	Provisioning state of the Front Door.
resourceState	string	Resource status of the Front Door or Front Door SubResource. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", "Deleting", "Migrating", and "Migrated". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting, Migrating, Migrated)
routingRules	array	Routing rules associated with this Front Door.
rulesEngines	array	Rules Engine Configurations available to routing rules.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, front_door_name, subscription_id		Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all of the Front Doors within a resource group under a subscription.
list	select	subscription_id		Lists all of the Front Doors within an Azure subscription.
create_or_update	insert	resource_group_name, front_door_name, subscription_id		Creates a new Front Door with a Front Door name under the specified subscription and resource group.
create_or_update	replace	resource_group_name, front_door_name, subscription_id		Creates a new Front Door with a Front Door name under the specified subscription and resource group.
delete	delete	resource_group_name, front_door_name, subscription_id		Deletes an existing Front Door with the specified parameters.
validate_custom_domain	exec	resource_group_name, front_door_name, subscription_id, hostName		Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
front_door_name	string	Name of the Front Door which is globally unique. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a Front Door with the specified Front Door name under the specified subscription and resource group.

SELECT
id,
name,
backendPools,
backendPoolsSettings,
cname,
enabledState,
extendedProperties,
friendlyName,
frontdoorId,
frontendEndpoints,
healthProbeSettings,
loadBalancingSettings,
location,
provisioningState,
resourceState,
routingRules,
rulesEngines,
tags,
type
FROM azure.front_door.front_doors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND front_door_name = '{{ front_door_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all of the Front Doors within a resource group under a subscription.

SELECT
id,
name,
backendPools,
backendPoolsSettings,
cname,
enabledState,
extendedProperties,
friendlyName,
frontdoorId,
frontendEndpoints,
healthProbeSettings,
loadBalancingSettings,
location,
provisioningState,
resourceState,
routingRules,
rulesEngines,
tags,
type
FROM azure.front_door.front_doors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all of the Front Doors within an Azure subscription.

SELECT
id,
name,
backendPools,
backendPoolsSettings,
cname,
enabledState,
extendedProperties,
friendlyName,
frontdoorId,
frontendEndpoints,
healthProbeSettings,
loadBalancingSettings,
location,
provisioningState,
resourceState,
routingRules,
rulesEngines,
tags,
type
FROM azure.front_door.front_doors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new Front Door with a Front Door name under the specified subscription and resource group.

INSERT INTO azure.front_door.front_doors (
location,
tags,
properties,
resource_group_name,
front_door_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ front_door_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: front_doors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the front_doors resource.
  - name: front_door_name
    value: "{{ front_door_name }}"
    description: Required parameter for the front_doors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the front_doors resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the Front Door Load Balancer.
    value:
      friendlyName: "{{ friendlyName }}"
      routingRules:
        - id: "{{ id }}"
          properties:
            frontendEndpoints:
              - id: "{{ id }}"
            acceptedProtocols:
              - "{{ acceptedProtocols }}"
            patternsToMatch:
              - "{{ patternsToMatch }}"
            enabledState: "{{ enabledState }}"
            routeConfiguration:
              @odata:
                type: "{{ type }}"
            rulesEngine:
              id: "{{ id }}"
            webApplicationFirewallPolicyLink:
              id: "{{ id }}"
            resourceState: "{{ resourceState }}"
          name: "{{ name }}"
          type: "{{ type }}"
      loadBalancingSettings:
        - id: "{{ id }}"
          properties:
            sampleSize: {{ sampleSize }}
            successfulSamplesRequired: {{ successfulSamplesRequired }}
            additionalLatencyMilliseconds: {{ additionalLatencyMilliseconds }}
            resourceState: "{{ resourceState }}"
          name: "{{ name }}"
          type: "{{ type }}"
      healthProbeSettings:
        - id: "{{ id }}"
          properties:
            path: "{{ path }}"
            protocol: "{{ protocol }}"
            intervalInSeconds: {{ intervalInSeconds }}
            healthProbeMethod: "{{ healthProbeMethod }}"
            enabledState: "{{ enabledState }}"
            resourceState: "{{ resourceState }}"
          name: "{{ name }}"
          type: "{{ type }}"
      backendPools:
        - id: "{{ id }}"
          properties:
            backends:
              - address: "{{ address }}"
                privateLinkAlias: "{{ privateLinkAlias }}"
                privateLinkResourceId: "{{ privateLinkResourceId }}"
                privateLinkLocation: "{{ privateLinkLocation }}"
                privateEndpointStatus: "{{ privateEndpointStatus }}"
                privateLinkApprovalMessage: "{{ privateLinkApprovalMessage }}"
                httpPort: {{ httpPort }}
                httpsPort: {{ httpsPort }}
                enabledState: "{{ enabledState }}"
                priority: {{ priority }}
                weight: {{ weight }}
                backendHostHeader: "{{ backendHostHeader }}"
            loadBalancingSettings:
              id: "{{ id }}"
            healthProbeSettings:
              id: "{{ id }}"
            resourceState: "{{ resourceState }}"
          name: "{{ name }}"
          type: "{{ type }}"
      frontendEndpoints:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            hostName: "{{ hostName }}"
            sessionAffinityEnabledState: "{{ sessionAffinityEnabledState }}"
            sessionAffinityTtlSeconds: {{ sessionAffinityTtlSeconds }}
            webApplicationFirewallPolicyLink:
              id: "{{ id }}"
            resourceState: "{{ resourceState }}"
            customHttpsProvisioningState: "{{ customHttpsProvisioningState }}"
            customHttpsProvisioningSubstate: "{{ customHttpsProvisioningSubstate }}"
            customHttpsConfiguration:
              certificateSource: "{{ certificateSource }}"
              protocolType: "{{ protocolType }}"
              minimumTlsVersion: "{{ minimumTlsVersion }}"
              keyVaultCertificateSourceParameters:
                vault: "{{ vault }}"
                secretName: "{{ secretName }}"
                secretVersion: "{{ secretVersion }}"
              frontDoorCertificateSourceParameters:
                certificateType: "{{ certificateType }}"
      backendPoolsSettings:
        enforceCertificateNameCheck: "{{ enforceCertificateNameCheck }}"
        sendRecvTimeoutSeconds: {{ sendRecvTimeoutSeconds }}
      enabledState: "{{ enabledState }}"
      resourceState: "{{ resourceState }}"
      provisioningState: "{{ provisioningState }}"
      cname: "{{ cname }}"
      frontdoorId: "{{ frontdoorId }}"
      rulesEngines:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            rules:
              - name: "{{ name }}"
                priority: {{ priority }}
                action:
                  requestHeaderActions: "{{ requestHeaderActions }}"
                  responseHeaderActions: "{{ responseHeaderActions }}"
                  routeConfigurationOverride: "{{ routeConfigurationOverride }}"
                matchConditions: "{{ matchConditions }}"
                matchProcessingBehavior: "{{ matchProcessingBehavior }}"
            resourceState: "{{ resourceState }}"
      extendedProperties: "{{ extendedProperties }}"

REPLACE examples

create_or_update

Creates a new Front Door with a Front Door name under the specified subscription and resource group.

REPLACE azure.front_door.front_doors
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND front_door_name = '{{ front_door_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes an existing Front Door with the specified parameters.

DELETE FROM azure.front_door.front_doors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND front_door_name = '{{ front_door_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

validate_custom_domain

Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.

EXEC azure.front_door.front_doors.validate_custom_domain 
@resource_group_name='{{ resource_group_name }}' --required, 
@front_door_name='{{ front_door_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"hostName": "{{ hostName }}"
}'
;