Share via

Domain Class

  • Reference

Information about a domain.

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

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.web.v2018_02_01.models._models_py3.Resource
Domain

Constructor

Domain(*, location: str, kind: str | None = None, tags: Dict[str, str] | None = None, contact_admin: _models.Contact | None = None, contact_billing: _models.Contact | None = None, contact_registrant: _models.Contact | None = None, contact_tech: _models.Contact | None = None, privacy: bool | None = None, auto_renew: bool = True, consent: _models.DomainPurchaseConsent | None = None, dns_type: str | _models.DnsType | None = None, dns_zone_id: str | None = None, target_dns_type: str | _models.DnsType | None = None, auth_code: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
kind
str

Kind of resource.
location
str

Resource Location. Required.
tags
dict[str, str]

Resource tags.
contact_admin
Contact

Administrative contact.
contact_billing
Contact

Billing contact.
contact_registrant
Contact

Registrant contact.
contact_tech
Contact

Technical contact.
privacy
bool

<code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>.
auto_renew
bool

<code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>.

Default value: True
consent
DomainPurchaseConsent

Legal agreement consent.
dns_type
str or DnsType

Current DNS type. Known values are: "AzureDns" and "DefaultDomainRegistrarDns".
dns_zone_id
str

Azure DNS Zone to use.
target_dns_type
str or DnsType

Target DNS type (would be used for migration). Known values are: "AzureDns" and "DefaultDomainRegistrarDns".
auth_code
str

Variables

Name Description
id
str

Resource Id.
name
str

Resource Name.
kind
str

Kind of resource.
location
str

Resource Location. Required.
type
str

Resource type.
tags
dict[str, str]

Resource tags.
contact_admin
Contact

Administrative contact.
contact_billing
Contact

Billing contact.
contact_registrant
Contact

Registrant contact.
contact_tech
Contact

Technical contact.
registration_status
str or DomainStatus

Domain registration status. Known values are: "Active", "Awaiting", "Cancelled", "Confiscated", "Disabled", "Excluded", "Expired", "Failed", "Held", "Locked", "Parked", "Pending", "Reserved", "Reverted", "Suspended", "Transferred", "Unknown", "Unlocked", "Unparked", "Updated", and "JsonConverterFailed".
provisioning_state
str or ProvisioningState

Domain provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".
name_servers
list[str]

Name servers.
privacy
bool

<code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>.
created_time
datetime

Domain creation timestamp.
expiration_time
datetime

Domain expiration timestamp.
last_renewed_time
datetime

Timestamp when the domain was renewed last time.
auto_renew
bool

<code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>.
ready_for_dns_record_management
bool

<code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and

it is hosted on name servers Azure has programmatic access to.
managed_host_names
list[HostName]

All hostnames derived from the domain and assigned to Azure resources.
consent
DomainPurchaseConsent

Legal agreement consent.
domain_not_renewable_reasons
list[str or DomainPropertiesDomainNotRenewableReasonsItem]

Reasons why domain is not renewable.
dns_type
str or DnsType

Current DNS type. Known values are: "AzureDns" and "DefaultDomainRegistrarDns".
dns_zone_id
str

Azure DNS Zone to use.
target_dns_type
str or DnsType

Target DNS type (would be used for migration). Known values are: "AzureDns" and "DefaultDomainRegistrarDns".
auth_code
str