Share via

CustomDomain Class

  • Reference

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

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.cdn.models._models_py3.ProxyResource
CustomDomain

Constructor

CustomDomain(*, host_name: str | None = None, custom_https_parameters: _models.CustomDomainHttpsParameters | None = None, validation_data: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
host_name
str

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

Certificate parameters for securing custom HTTPS.
validation_data
str

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.

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
system_data
SystemData

Read only system data.
host_name
str

The host name of the custom domain. Must be a domain name.
resource_state
str or CustomDomainResourceState

Resource status of the custom domain. Known values are: "Creating", "Active", and "Deleting".
custom_https_provisioning_state
str or CustomHttpsProvisioningState

Provisioning status of the custom domain. Known values are: "Enabling", "Enabled", "Disabling", "Disabled", and "Failed".
custom_https_provisioning_substate
str or CustomHttpsProvisioningSubstate

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".
custom_https_parameters
CustomDomainHttpsParameters

Certificate parameters for securing custom HTTPS.
validation_data
str

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.
provisioning_state
str or CustomHttpsProvisioningState

Provisioning status of Custom Https of the custom domain. Known values are: "Enabling", "Enabled", "Disabling", "Disabled", and "Failed".