AFDDomain interface

Package:

@azure/arm-cdn

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

Extends

ProxyResource

Properties

azureDnsZone	Resource reference to the Azure DNS zone
deploymentStatus	NOTE: This property will not be serialized. It can only be populated by the server.
domainValidationState	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. NOTE: This property will not be serialized. It can only be populated by the server.
extendedProperties	Key-Value pair representing migration properties for domains.
hostName	The host name of the domain. Must be a domain name.
preValidatedCustomDomainResourceId	Resource reference to the Azure resource where custom domain ownership was prevalidated
profileName	The name of the profile which holds the domain. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Provisioning status NOTE: This property will not be serialized. It can only be populated by the server.
tlsSettings	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.
validationProperties	Values the customer needs to validate domain ownership NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Read only system data NOTE: This property will not be serialized. It can only be populated by the server.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

azureDnsZone

Resource reference to the Azure DNS zone

azureDnsZone?: ResourceReference

Property Value

ResourceReference

deploymentStatus

NOTE: This property will not be serialized. It can only be populated by the server.

deploymentStatus?: string

Property Value

string

domainValidationState

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. NOTE: This property will not be serialized. It can only be populated by the server.

domainValidationState?: string

Property Value

string

extendedProperties

Key-Value pair representing migration properties for domains.

extendedProperties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

hostName

The host name of the domain. Must be a domain name.

hostName?: string

Property Value

string

preValidatedCustomDomainResourceId

Resource reference to the Azure resource where custom domain ownership was prevalidated

preValidatedCustomDomainResourceId?: ResourceReference

Property Value

ResourceReference

profileName

The name of the profile which holds the domain. NOTE: This property will not be serialized. It can only be populated by the server.

profileName?: string

Property Value

string

provisioningState

Provisioning status NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

tlsSettings

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.

tlsSettings?: AFDDomainHttpsParameters

Property Value

AFDDomainHttpsParameters

validationProperties

Values the customer needs to validate domain ownership NOTE: This property will not be serialized. It can only be populated by the server.

validationProperties?: DomainValidationProperties

Property Value

DomainValidationProperties

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Read only system data NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type