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
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.
azureDnsZone	object	Resource reference to the Azure DNS zone.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
domainValidationState	string	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. Known values are: "Unknown", "Submitting", "Pending", "Rejected", "TimedOut", "PendingRevalidation", "Approved", "RefreshingValidationToken", and "InternalError". (Unknown, Submitting, Pending, Rejected, TimedOut, PendingRevalidation, Approved, RefreshingValidationToken, InternalError)
extendedProperties	object	Key-Value pair representing migration properties for domains.
hostName	string	The host name of the domain. Must be a domain name. Required.
preValidatedCustomDomainResourceId	object	Resource reference to the Azure resource where custom domain ownership was prevalidated.
profileName	string	The name of the profile which holds the domain.
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.
tlsSettings	object	The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationProperties	object	Values the customer needs to validate domain ownership.

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.
azureDnsZone	object	Resource reference to the Azure DNS zone.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
domainValidationState	string	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. Known values are: "Unknown", "Submitting", "Pending", "Rejected", "TimedOut", "PendingRevalidation", "Approved", "RefreshingValidationToken", and "InternalError". (Unknown, Submitting, Pending, Rejected, TimedOut, PendingRevalidation, Approved, RefreshingValidationToken, InternalError)
extendedProperties	object	Key-Value pair representing migration properties for domains.
hostName	string	The host name of the domain. Must be a domain name. Required.
preValidatedCustomDomainResourceId	object	Resource reference to the Azure resource where custom domain ownership was prevalidated.
profileName	string	The name of the profile which holds the domain.
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.
tlsSettings	object	The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationProperties	object	Values the customer needs to validate domain ownership.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, profile_name, custom_domain_name, subscription_id		Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
list_by_profile	select	resource_group_name, profile_name, subscription_id		Lists existing AzureFrontDoor domains.
create	insert	resource_group_name, profile_name, custom_domain_name, subscription_id		Creates a new domain within the specified profile.
update	update	resource_group_name, profile_name, custom_domain_name, subscription_id		Updates an existing domain within a profile.
delete	delete	resource_group_name, profile_name, custom_domain_name, subscription_id		Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
refresh_validation_token	exec	resource_group_name, profile_name, custom_domain_name, subscription_id		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
custom_domain_name	string	Name of the domain 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 domain with the specified domain name under the specified subscription, resource group and profile.

SELECT
id,
name,
azureDnsZone,
deploymentStatus,
domainValidationState,
extendedProperties,
hostName,
preValidatedCustomDomainResourceId,
profileName,
provisioningState,
systemData,
tlsSettings,
type,
validationProperties
FROM azure.cdn.afd_custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND custom_domain_name = '{{ custom_domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_profile

Lists existing AzureFrontDoor domains.

SELECT
id,
name,
azureDnsZone,
deploymentStatus,
domainValidationState,
extendedProperties,
hostName,
preValidatedCustomDomainResourceId,
profileName,
provisioningState,
systemData,
tlsSettings,
type,
validationProperties
FROM azure.cdn.afd_custom_domains
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 domain within the specified profile.

INSERT INTO azure.cdn.afd_custom_domains (
properties,
resource_group_name,
profile_name,
custom_domain_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ custom_domain_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: afd_custom_domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the afd_custom_domains resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the afd_custom_domains resource.
  - name: custom_domain_name
    value: "{{ custom_domain_name }}"
    description: Required parameter for the afd_custom_domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the afd_custom_domains resource.
  - name: properties
    description: |
      The JSON object that contains the properties of the domain to create.
    value:
      profileName: "{{ profileName }}"
      tlsSettings:
        certificateType: "{{ certificateType }}"
        cipherSuiteSetType: "{{ cipherSuiteSetType }}"
        minimumTlsVersion: "{{ minimumTlsVersion }}"
        customizedCipherSuiteSet:
          cipherSuiteSetForTls12:
            - "{{ cipherSuiteSetForTls12 }}"
          cipherSuiteSetForTls13:
            - "{{ cipherSuiteSetForTls13 }}"
        secret:
          id: "{{ id }}"
      azureDnsZone:
        id: "{{ id }}"
      preValidatedCustomDomainResourceId:
        id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      deploymentStatus: "{{ deploymentStatus }}"
      domainValidationState: "{{ domainValidationState }}"
      hostName: "{{ hostName }}"
      extendedProperties: "{{ extendedProperties }}"
      validationProperties:
        validationToken: "{{ validationToken }}"
        expirationDate: "{{ expirationDate }}"

UPDATE examples

update

Updates an existing domain within a profile.

UPDATE azure.cdn.afd_custom_domains
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND custom_domain_name = '{{ custom_domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

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

Lifecycle Methods

refresh_validation_token

Updates the domain validation token.

EXEC azure.cdn.afd_custom_domains.refresh_validation_token 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@custom_domain_name='{{ custom_domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;