afd_endpoints

Creates, updates, deletes, gets or lists an afd_endpoints resource.

Overview

Name	afd_endpoints
Type	Resource
Id	azure.cdn.afd_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	Resource location.
properties	object	The JSON object that contains the properties required to create an endpoint.
tags	object	Resource tags.

list_by_profile

Name	Datatype	Description
location	string	Resource location.
properties	object	The JSON object that contains the properties required to create an endpoint.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, endpointName, subscriptionId		Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
list_by_profile	select	resourceGroupName, profileName, subscriptionId		Lists existing AzureFrontDoor endpoints.
create	insert	resourceGroupName, profileName, endpointName, subscriptionId		Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
update	update	resourceGroupName, profileName, endpointName, subscriptionId		Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.
delete	delete	resourceGroupName, profileName, endpointName, subscriptionId		Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
purge_content	exec	resourceGroupName, profileName, endpointName, subscriptionId, contentPaths		Removes a content from AzureFrontDoor.
validate_custom_domain	exec	resourceGroupName, profileName, endpointName, subscriptionId, hostName		Validates the custom domain mapping to ensure it maps to the correct Azure 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
endpointName	string	Name of the endpoint under the profile which is unique globally.
profileName	string	Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName	string	Name of the Resource group within the Azure subscription.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

SELECT
location,
properties,
tags
FROM azure.cdn.afd_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND endpointName = '{{ endpointName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_profile

Lists existing AzureFrontDoor endpoints.

SELECT
location,
properties,
tags
FROM azure.cdn.afd_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

INSERT INTO azure.cdn.afd_endpoints (
data__location,
data__tags,
data__properties,
resourceGroupName,
profileName,
endpointName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ endpointName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: afd_endpoints
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the afd_endpoints resource.
    - name: profileName
      value: string
      description: Required parameter for the afd_endpoints resource.
    - name: endpointName
      value: string
      description: Required parameter for the afd_endpoints resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the afd_endpoints resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        The JSON object that contains the properties required to create an endpoint.

UPDATE examples

update

Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.

UPDATE azure.cdn.afd_endpoints
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND endpointName = '{{ endpointName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

DELETE FROM azure.cdn.afd_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND endpointName = '{{ endpointName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

purge_content

Removes a content from AzureFrontDoor.

EXEC azure.cdn.afd_endpoints.purge_content 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@endpointName='{{ endpointName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"contentPaths": "{{ contentPaths }}", 
"domains": "{{ domains }}"
}'
;

validate_custom_domain

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

EXEC azure.cdn.afd_endpoints.validate_custom_domain 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@endpointName='{{ endpointName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"hostName": "{{ hostName }}"
}'
;