afd_custom_domains

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

Overview

Name	afd_custom_domains
Type	Resource
Id	azure.cdn.afd_custom_domains

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The JSON object that contains the properties of the domain to create.

list_by_profile

Name	Datatype	Description
properties	object	The JSON object that contains the properties of the domain to create.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, customDomainName, subscriptionId		Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
list_by_profile	select	resourceGroupName, profileName, subscriptionId		Lists existing AzureFrontDoor domains.
create	insert	resourceGroupName, profileName, customDomainName, subscriptionId		Creates a new domain within the specified profile.
update	update	resourceGroupName, profileName, customDomainName, subscriptionId		Updates an existing domain within a profile.
delete	delete	resourceGroupName, profileName, customDomainName, subscriptionId		Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
refresh_validation_token	exec	resourceGroupName, profileName, customDomainName, subscriptionId		Updates the domain validation token.

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
customDomainName	string	Name of the domain 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 domain with the specified domain name under the specified subscription, resource group and profile.

SELECT
properties
FROM azure.cdn.afd_custom_domains
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND customDomainName = '{{ customDomainName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_profile

Lists existing AzureFrontDoor domains.

SELECT
properties
FROM azure.cdn.afd_custom_domains
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new domain within the specified profile.

INSERT INTO azure.cdn.afd_custom_domains (
data__properties,
resourceGroupName,
profileName,
customDomainName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ customDomainName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: afd_custom_domains
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the afd_custom_domains resource.
    - name: profileName
      value: string
      description: Required parameter for the afd_custom_domains resource.
    - name: customDomainName
      value: string
      description: Required parameter for the afd_custom_domains resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the afd_custom_domains resource.
    - name: properties
      value: object
      description: |
        The JSON object that contains the properties of the domain to create.

UPDATE examples

update

Updates an existing domain within a profile.

UPDATE azure.cdn.afd_custom_domains
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND customDomainName = '{{ customDomainName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

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

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

Lifecycle Methods

refresh_validation_token

Updates the domain validation token.

EXEC azure.cdn.afd_custom_domains.refresh_validation_token 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@customDomainName='{{ customDomainName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;