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

OK. The request has succeeded.

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

list_by_endpoint

OK. The request has succeeded.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, endpointName, customDomainName, subscriptionId		Gets an existing custom domain within an endpoint.
list_by_endpoint	select	resourceGroupName, profileName, endpointName, subscriptionId		Lists all of the existing custom domains within an endpoint.
create	insert	resourceGroupName, profileName, endpointName, customDomainName, subscriptionId		Creates a new custom domain within an endpoint.
delete	delete	resourceGroupName, profileName, endpointName, customDomainName, subscriptionId		Deletes an existing custom domain within an endpoint.
disable_custom_https	exec	resourceGroupName, profileName, endpointName, customDomainName, subscriptionId		Disable https delivery of the custom domain.
enable_custom_https	exec	resourceGroupName, profileName, endpointName, customDomainName, subscriptionId, 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
customDomainName	string	Name of the custom domain within an endpoint.
endpointName	string	Name of the endpoint under the profile which is unique globally.
profileName	string	Name of the CDN 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 custom domain within an endpoint.

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

list_by_endpoint

Lists all of the existing custom domains within an endpoint.

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

INSERT examples

create

Creates a new custom domain within an endpoint.

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

Manifest

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

DELETE examples

delete

Deletes an existing custom domain within an endpoint.

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

Lifecycle Methods

disable_custom_https

Disable https delivery of the custom domain.

EXEC azure.cdn.custom_domains.disable_custom_https 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@endpointName='{{ endpointName }}' --required, 
@customDomainName='{{ customDomainName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

enable_custom_https

Enable https delivery of the custom domain.

EXEC azure.cdn.custom_domains.enable_custom_https 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@endpointName='{{ endpointName }}' --required, 
@customDomainName='{{ customDomainName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"certificateSource": "{{ certificateSource }}", 
"protocolType": "{{ protocolType }}", 
"minimumTlsVersion": "{{ minimumTlsVersion }}"
}'
;