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.
properties	object	Properties of the Frontend endpoint
type	string	Resource type.

list_by_front_door

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	Properties of the Frontend endpoint
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, frontendEndpointName		Gets a Frontend endpoint with the specified name within the specified Front Door.
list_by_front_door	select	subscriptionId, resourceGroupName, frontDoorName		Lists all of the frontend endpoints within a Front Door.
enable_https	exec	subscriptionId, resourceGroupName, frontDoorName, frontendEndpointName, minimumTlsVersion, certificateSource, protocolType		Enables a frontendEndpoint for HTTPS traffic
disable_https	exec	subscriptionId, resourceGroupName, frontDoorName, frontendEndpointName		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
frontDoorName	string	Name of the Front Door which is globally unique.
frontendEndpointName	string	Name of the Frontend endpoint which is unique within the Front Door.
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 Frontend endpoint with the specified name within the specified Front Door.

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

list_by_front_door

Lists all of the frontend endpoints within a Front Door.

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

Lifecycle Methods

enable_https

Enables a frontendEndpoint for HTTPS traffic

EXEC azure.front_door.frontend_endpoints.enable_https 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@frontDoorName='{{ frontDoorName }}' --required, 
@frontendEndpointName='{{ frontendEndpointName }}' --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 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@frontDoorName='{{ frontDoorName }}' --required, 
@frontendEndpointName='{{ frontendEndpointName }}' --required
;