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
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoGeneratedDomainNameLabelScope	string	Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse". (TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse)
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
enabledState	string	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
hostName	string	The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
location	string	The geo-location where the resource lives. Required.
profileName	string	The name of the profile which holds the endpoint.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_profile

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoGeneratedDomainNameLabelScope	string	Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse". (TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse)
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
enabledState	string	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
hostName	string	The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
location	string	The geo-location where the resource lives. Required.
profileName	string	The name of the profile which holds the endpoint.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, profile_name, endpoint_name, subscription_id		Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
list_by_profile	select	resource_group_name, profile_name, subscription_id		Lists existing AzureFrontDoor endpoints.
create	insert	resource_group_name, profile_name, endpoint_name, subscription_id, location		Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
update	update	resource_group_name, profile_name, endpoint_name, subscription_id		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	resource_group_name, profile_name, endpoint_name, subscription_id		Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
list_resource_usage	exec	resource_group_name, profile_name, endpoint_name, subscription_id		Checks the quota and actual usage of endpoints under the given Azure Front Door profile.
purge_content	exec	resource_group_name, profile_name, endpoint_name, subscription_id, contentPaths		Removes a content from AzureFrontDoor.
validate_custom_domain	exec	resource_group_name, profile_name, endpoint_name, subscription_id, 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
endpoint_name	string	Name of the endpoint under the profile which is unique globally. Required.
profile_name	string	Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
autoGeneratedDomainNameLabelScope,
deploymentStatus,
enabledState,
hostName,
location,
profileName,
provisioningState,
systemData,
tags,
type
FROM azure.cdn.afd_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_profile

Lists existing AzureFrontDoor endpoints.

SELECT
id,
name,
autoGeneratedDomainNameLabelScope,
deploymentStatus,
enabledState,
hostName,
location,
profileName,
provisioningState,
systemData,
tags,
type
FROM azure.cdn.afd_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
tags,
location,
properties,
resource_group_name,
profile_name,
endpoint_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: afd_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the afd_endpoints resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the afd_endpoints resource.
  - name: endpoint_name
    value: "{{ endpoint_name }}"
    description: Required parameter for the afd_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the afd_endpoints resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The JSON object that contains the properties required to create an endpoint.
    value:
      profileName: "{{ profileName }}"
      enabledState: "{{ enabledState }}"
      provisioningState: "{{ provisioningState }}"
      deploymentStatus: "{{ deploymentStatus }}"
      hostName: "{{ hostName }}"
      autoGeneratedDomainNameLabelScope: "{{ autoGeneratedDomainNameLabelScope }}"

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 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

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 resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_resource_usage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

EXEC azure.cdn.afd_endpoints.list_resource_usage 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@endpoint_name='{{ endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

purge_content

Removes a content from AzureFrontDoor.

EXEC azure.cdn.afd_endpoints.purge_content 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@endpoint_name='{{ endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@endpoint_name='{{ endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"hostName": "{{ hostName }}"
}'
;