Share via

CustomDomain interface

  • Reference
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

customHttpsParameters

Certificate parameters for securing custom HTTPS
customHttpsProvisioningState

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

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

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

Provisioning status of Custom Https of the custom domain. NOTE: This property will not be serialized. It can only be populated by the server.
resourceState

Resource status of the custom domain. NOTE: This property will not be serialized. It can only be populated by the server.
validationData

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.

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

customHttpsParameters

Certificate parameters for securing custom HTTPS

customHttpsParameters?: CustomDomainHttpsParametersUnion

Property Value

CustomDomainHttpsParametersUnion

customHttpsProvisioningState

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

customHttpsProvisioningState?: string

Property Value

string

customHttpsProvisioningSubstate

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

customHttpsProvisioningSubstate?: string

Property Value

string

hostName

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

hostName?: string

Property Value

string

provisioningState

Provisioning status of Custom Https of the custom domain. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceState

Resource status of the custom domain. NOTE: This property will not be serialized. It can only be populated by the server.

resourceState?: string

Property Value

string

validationData

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.

validationData?: string

Property Value

string

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