custom_domains

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

Overview

Name	custom_domains
Type	Resource
Id	azure.cdn.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.
customHttpsParameters	object	Certificate parameters for securing custom HTTPS.
customHttpsProvisioningState	string	Provisioning status of the custom domain. Known values are: "Enabling", "Enabled", "Disabling", "Disabled", and "Failed". (Enabling, Enabled, Disabling, Disabled, Failed)
customHttpsProvisioningSubstate	string	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Known values are: "SubmittingDomainControlValidationRequest", "PendingDomainControlValidationREquestApproval", "DomainControlValidationRequestApproved", "DomainControlValidationRequestRejected", "DomainControlValidationRequestTimedOut", "IssuingCertificate", "DeployingCertificate", "CertificateDeployed", "DeletingCertificate", and "CertificateDeleted". (SubmittingDomainControlValidationRequest, PendingDomainControlValidationREquestApproval, DomainControlValidationRequestApproved, DomainControlValidationRequestRejected, DomainControlValidationRequestTimedOut, IssuingCertificate, DeployingCertificate, CertificateDeployed, DeletingCertificate, CertificateDeleted)
hostName	string	The host name of the custom domain. Must be a domain name. Required.
provisioningState	string	Provisioning status of Custom Https of the custom domain. Known values are: "Enabling", "Enabled", "Disabling", "Disabled", and "Failed". (Enabling, Enabled, Disabling, Disabled, Failed)
resourceState	string	Resource status of the custom domain. Known values are: "Creating", "Active", and "Deleting". (Creating, Active, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationData	string	Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

list_by_endpoint

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.
customHttpsParameters	object	Certificate parameters for securing custom HTTPS.
customHttpsProvisioningState	string	Provisioning status of the custom domain. Known values are: "Enabling", "Enabled", "Disabling", "Disabled", and "Failed". (Enabling, Enabled, Disabling, Disabled, Failed)
customHttpsProvisioningSubstate	string	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Known values are: "SubmittingDomainControlValidationRequest", "PendingDomainControlValidationREquestApproval", "DomainControlValidationRequestApproved", "DomainControlValidationRequestRejected", "DomainControlValidationRequestTimedOut", "IssuingCertificate", "DeployingCertificate", "CertificateDeployed", "DeletingCertificate", and "CertificateDeleted". (SubmittingDomainControlValidationRequest, PendingDomainControlValidationREquestApproval, DomainControlValidationRequestApproved, DomainControlValidationRequestRejected, DomainControlValidationRequestTimedOut, IssuingCertificate, DeployingCertificate, CertificateDeployed, DeletingCertificate, CertificateDeleted)
hostName	string	The host name of the custom domain. Must be a domain name. Required.
provisioningState	string	Provisioning status of Custom Https of the custom domain. Known values are: "Enabling", "Enabled", "Disabling", "Disabled", and "Failed". (Enabling, Enabled, Disabling, Disabled, Failed)
resourceState	string	Resource status of the custom domain. Known values are: "Creating", "Active", and "Deleting". (Creating, Active, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationData	string	Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

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, custom_domain_name, subscription_id		Gets an existing custom domain within an endpoint.
list_by_endpoint	select	resource_group_name, profile_name, endpoint_name, subscription_id		Lists all of the existing custom domains within an endpoint.
create	insert	resource_group_name, profile_name, endpoint_name, custom_domain_name, subscription_id		Creates a new custom domain within an endpoint.
delete	delete	resource_group_name, profile_name, endpoint_name, custom_domain_name, subscription_id		Deletes an existing custom domain within an endpoint.
disable_custom_https	exec	resource_group_name, profile_name, endpoint_name, custom_domain_name, subscription_id		Disable https delivery of the custom domain.
enable_custom_https	exec	resource_group_name, profile_name, endpoint_name, custom_domain_name, subscription_id, certificateSource, protocolType		Enable https delivery of the custom domain.

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 custom domain within an endpoint. Required.
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 custom domain within an endpoint.

SELECT
id,
name,
customHttpsParameters,
customHttpsProvisioningState,
customHttpsProvisioningSubstate,
hostName,
provisioningState,
resourceState,
systemData,
type,
validationData
FROM azure.cdn.custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND custom_domain_name = '{{ custom_domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_endpoint

Lists all of the existing custom domains within an endpoint.

SELECT
id,
name,
customHttpsParameters,
customHttpsProvisioningState,
customHttpsProvisioningSubstate,
hostName,
provisioningState,
resourceState,
systemData,
type,
validationData
FROM azure.cdn.custom_domains
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
;

INSERT examples

create

Creates a new custom domain within an endpoint.

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

Manifest

# Description fields are for documentation purposes
- name: custom_domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the custom_domains resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the custom_domains resource.
  - name: endpoint_name
    value: "{{ endpoint_name }}"
    description: Required parameter for the custom_domains resource.
  - name: custom_domain_name
    value: "{{ custom_domain_name }}"
    description: Required parameter for the custom_domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the custom_domains resource.
  - name: properties
    description: |
      The JSON object that contains the properties of the custom domain to create.
    value:
      hostName: "{{ hostName }}"

DELETE examples

delete

Deletes an existing custom domain within an endpoint.

DELETE FROM azure.cdn.custom_domains
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND custom_domain_name = '{{ custom_domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

disable_custom_https

Disable https delivery of the custom domain.

EXEC azure.cdn.custom_domains.disable_custom_https 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@endpoint_name='{{ endpoint_name }}' --required, 
@custom_domain_name='{{ custom_domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable_custom_https

Enable https delivery of the custom domain.

EXEC azure.cdn.custom_domains.enable_custom_https 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@endpoint_name='{{ endpoint_name }}' --required, 
@custom_domain_name='{{ custom_domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"certificateSource": "{{ certificateSource }}", 
"protocolType": "{{ protocolType }}", 
"minimumTlsVersion": "{{ minimumTlsVersion }}"
}'
;