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.
location	string	Resource location.
properties	object	Properties of the Front Door Load Balancer
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
location	string	Resource location.
properties	object	Properties of the Front Door Load Balancer
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
location	string	Resource location.
properties	object	Properties of the Front Door Load Balancer
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	subscriptionId, resourceGroupName, frontDoorName		Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all of the Front Doors within a resource group under a subscription.
list	select	subscriptionId		Lists all of the Front Doors within an Azure subscription.
create_or_update	insert	subscriptionId, resourceGroupName, frontDoorName		Creates a new Front Door with a Front Door name under the specified subscription and resource group.
delete	delete	subscriptionId, resourceGroupName, frontDoorName		Deletes an existing Front Door with the specified parameters.
validate_custom_domain	exec	subscriptionId, resourceGroupName, frontDoorName, 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
frontDoorName	string	Name of the Front Door which is globally unique.
resourceGroupName	string	Name of the Resource group within the Azure subscription.
subscriptionId	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

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

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.front_door.front_doors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND frontDoorName = '{{ frontDoorName }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.front_door.front_doors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Lists all of the Front Doors within an Azure subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.front_door.front_doors
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
frontDoorName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ frontDoorName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: front_doors
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the front_doors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the front_doors resource.
    - name: frontDoorName
      value: string
      description: Required parameter for the front_doors resource.
    - name: properties
      value: object
      description: |
        Properties of the Front Door Load Balancer
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.

DELETE examples

delete

Deletes an existing Front Door with the specified parameters.

DELETE FROM azure.front_door.front_doors
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND frontDoorName = '{{ frontDoorName }}' --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 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@frontDoorName='{{ frontDoorName }}' --required 
@@json=
'{
"hostName": "{{ hostName }}"
}'
;