AFDDomainProperties Class

The JSON object that contains the properties of the domain to create.

Constructor

AFDDomainProperties()

Variables

Name Description
profile_name
str

The name of the profile which holds the domain.

tls_settings
<xref:<xref:"AFDDomainHttpsParameters">>

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.

azure_dns_zone
<xref:<xref:"ResourceReference">>

Resource reference to the Azure DNS zone.

pre_validated_custom_domain_resource_id
<xref:<xref:"ResourceReference">>

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

provisioning_state
Union[str, <xref:"AfdProvisioningState">]

Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating".

deployment_status
Union[str, <xref:"DeploymentStatus">]

Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed".

domain_validation_state
Union[str, <xref:"DomainValidationState">]

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. Known values are: "Unknown", "Submitting", "Pending", "Rejected", "TimedOut", "PendingRevalidation", "Approved", "RefreshingValidationToken", and "InternalError".

host_name
str

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

extended_properties

Key-Value pair representing migration properties for domains.

validation_properties
<xref:<xref:"DomainValidationProperties">>

Values the customer needs to validate domain ownership.

Attributes

azureDnsZone

Resource reference to the Azure DNS zone.

azureDnsZone: ResourceReference

deploymentStatus

"NotStarted", "InProgress", "Succeeded", and "Failed".

deploymentStatus: str | DeploymentStatus

domainValidationState

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. Known values are: "Unknown", "Submitting", "Pending", "Rejected", "TimedOut", "PendingRevalidation", "Approved", "RefreshingValidationToken", and "InternalError".

domainValidationState: str | DomainValidationState

extendedProperties

Key-Value pair representing migration properties for domains.

extendedProperties: dict[str, str]

hostName

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

hostName: Required[str]

preValidatedCustomDomainResourceId

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

preValidatedCustomDomainResourceId: ResourceReference

profileName

The name of the profile which holds the domain.

profileName: str

provisioningState

"Succeeded", "Failed", "Updating", "Deleting", and "Creating".

provisioningState: str | AfdProvisioningState

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

validationProperties

Values the customer needs to validate domain ownership.

validationProperties: DomainValidationProperties