afd_endpoints

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

Overview

Name	afd_endpoints
Type	Resource
Id	azure.cdn.afd_endpoints

Fields

vw_afd_endpoints

Name	Datatype	Description
auto_generated_domain_name_label_scope	text	field from the properties object
deployment_status	text	field from the properties object
enabled_state	text	field from the properties object
endpointName	text	field from the properties object
host_name	text	field from the properties object
location	text	Resource location.
profileName	text	field from the properties object
profile_name	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

afd_endpoints

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

Name	Accessible by	Required Params	Description
get	SELECT	endpointName, profileName, resourceGroupName, subscriptionId	Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
list_by_profile	SELECT	profileName, resourceGroupName, subscriptionId	Lists existing AzureFrontDoor endpoints.
create	INSERT	endpointName, profileName, resourceGroupName, subscriptionId	Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
delete	DELETE	endpointName, profileName, resourceGroupName, subscriptionId	Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
update	UPDATE	endpointName, profileName, resourceGroupName, 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.
purge_content	EXEC	endpointName, profileName, resourceGroupName, subscriptionId, data__contentPaths	Removes a content from AzureFrontDoor.
validate_custom_domain	EXEC	endpointName, profileName, resourceGroupName, subscriptionId, data__hostName	Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.

SELECT examples

Lists existing AzureFrontDoor endpoints.

vw_afd_endpoints

SELECT
auto_generated_domain_name_label_scope,
deployment_status,
enabled_state,
endpointName,
host_name,
location,
profileName,
profile_name,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.cdn.vw_afd_endpoints
WHERE profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

afd_endpoints

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

INSERT example

Use the following StackQL query and manifest file to create a new afd_endpoints resource.

All Properties

/*+ create */
INSERT INTO azure.cdn.afd_endpoints (
endpointName,
profileName,
resourceGroupName,
subscriptionId,
location,
tags,
properties
)
SELECT 
'{{ endpointName }}',
'{{ profileName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: profileName
          value: string
        - name: enabledState
          value: string
        - name: provisioningState
          value: string
        - name: deploymentStatus
          value: string
        - name: hostName
          value: string
        - name: autoGeneratedDomainNameLabelScope
          value: []

UPDATE example

Updates a afd_endpoints resource.

/*+ update */
UPDATE azure.cdn.afd_endpoints
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
endpointName = '{{ endpointName }}'
AND profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified afd_endpoints resource.

/*+ delete */
DELETE FROM azure.cdn.afd_endpoints
WHERE endpointName = '{{ endpointName }}'
AND profileName = '{{ profileName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';