frontend_endpoints

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

Overview

Name	frontend_endpoints
Type	Resource
Id	azure.front_door.frontend_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
customHttpsConfiguration	object	The configuration specifying how to enable HTTPS.
customHttpsProvisioningState	string	Provisioning status of Custom Https of the frontendEndpoint. Known values are: "Enabling", "Enabled", "Disabling", "Disabled", and "Failed". (Enabling, Enabled, Disabling, Disabled, Failed)
customHttpsProvisioningSubstate	string	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Known values are: "SubmittingDomainControlValidationRequest", "PendingDomainControlValidationREquestApproval", "DomainControlValidationRequestApproved", "DomainControlValidationRequestRejected", "DomainControlValidationRequestTimedOut", "IssuingCertificate", "DeployingCertificate", "CertificateDeployed", "DeletingCertificate", and "CertificateDeleted". (SubmittingDomainControlValidationRequest, PendingDomainControlValidationREquestApproval, DomainControlValidationRequestApproved, DomainControlValidationRequestRejected, DomainControlValidationRequestTimedOut, IssuingCertificate, DeployingCertificate, CertificateDeployed, DeletingCertificate, CertificateDeleted)
hostName	string	The host name of the frontendEndpoint. Must be a domain name.
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)
sessionAffinityEnabledState	string	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sessionAffinityTtlSeconds	integer	UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.
type	string	Resource type.
webApplicationFirewallPolicyLink	object	Defines the Web Application Firewall policy for each host (if applicable).

list_by_front_door

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
customHttpsConfiguration	object	The configuration specifying how to enable HTTPS.
customHttpsProvisioningState	string	Provisioning status of Custom Https of the frontendEndpoint. Known values are: "Enabling", "Enabled", "Disabling", "Disabled", and "Failed". (Enabling, Enabled, Disabling, Disabled, Failed)
customHttpsProvisioningSubstate	string	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Known values are: "SubmittingDomainControlValidationRequest", "PendingDomainControlValidationREquestApproval", "DomainControlValidationRequestApproved", "DomainControlValidationRequestRejected", "DomainControlValidationRequestTimedOut", "IssuingCertificate", "DeployingCertificate", "CertificateDeployed", "DeletingCertificate", and "CertificateDeleted". (SubmittingDomainControlValidationRequest, PendingDomainControlValidationREquestApproval, DomainControlValidationRequestApproved, DomainControlValidationRequestRejected, DomainControlValidationRequestTimedOut, IssuingCertificate, DeployingCertificate, CertificateDeployed, DeletingCertificate, CertificateDeleted)
hostName	string	The host name of the frontendEndpoint. Must be a domain name.
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)
sessionAffinityEnabledState	string	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sessionAffinityTtlSeconds	integer	UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.
type	string	Resource type.
webApplicationFirewallPolicyLink	object	Defines the Web Application Firewall policy for each host (if applicable).

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, frontend_endpoint_name, subscription_id		Gets a Frontend endpoint with the specified name within the specified Front Door.
list_by_front_door	select	resource_group_name, front_door_name, subscription_id		Lists all of the frontend endpoints within a Front Door.
enable_https	exec	resource_group_name, front_door_name, frontend_endpoint_name, subscription_id, certificateSource, protocolType, minimumTlsVersion		Enables a frontendEndpoint for HTTPS traffic.
disable_https	exec	resource_group_name, front_door_name, frontend_endpoint_name, subscription_id		Disables a frontendEndpoint for HTTPS traffic.

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.
frontend_endpoint_name	string	Name of the Frontend endpoint which is unique within the Front Door. 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 Frontend endpoint with the specified name within the specified Front Door.

SELECT
id,
name,
customHttpsConfiguration,
customHttpsProvisioningState,
customHttpsProvisioningSubstate,
hostName,
resourceState,
sessionAffinityEnabledState,
sessionAffinityTtlSeconds,
type,
webApplicationFirewallPolicyLink
FROM azure.front_door.frontend_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND front_door_name = '{{ front_door_name }}' -- required
AND frontend_endpoint_name = '{{ frontend_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_front_door

Lists all of the frontend endpoints within a Front Door.

SELECT
id,
name,
customHttpsConfiguration,
customHttpsProvisioningState,
customHttpsProvisioningSubstate,
hostName,
resourceState,
sessionAffinityEnabledState,
sessionAffinityTtlSeconds,
type,
webApplicationFirewallPolicyLink
FROM azure.front_door.frontend_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND front_door_name = '{{ front_door_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

enable_https

Enables a frontendEndpoint for HTTPS traffic.

EXEC azure.front_door.frontend_endpoints.enable_https 
@resource_group_name='{{ resource_group_name }}' --required, 
@front_door_name='{{ front_door_name }}' --required, 
@frontend_endpoint_name='{{ frontend_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"certificateSource": "{{ certificateSource }}", 
"protocolType": "{{ protocolType }}", 
"minimumTlsVersion": "{{ minimumTlsVersion }}", 
"keyVaultCertificateSourceParameters": "{{ keyVaultCertificateSourceParameters }}", 
"frontDoorCertificateSourceParameters": "{{ frontDoorCertificateSourceParameters }}"
}'
;

disable_https

Disables a frontendEndpoint for HTTPS traffic.

EXEC azure.front_door.frontend_endpoints.disable_https 
@resource_group_name='{{ resource_group_name }}' --required, 
@front_door_name='{{ front_door_name }}' --required, 
@frontend_endpoint_name='{{ frontend_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;