Feedback Edit

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 Azure.

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

Constructor

Domain(*, location: str, kind: Optional[str] = None, tags: Optional[Dict[str, str]] = None, contact_admin: Optional[azure.mgmt.web.v2015_04_01.models._models_py3.Contact] = None, contact_billing: Optional[azure.mgmt.web.v2015_04_01.models._models_py3.Contact] = None, contact_registrant: Optional[azure.mgmt.web.v2015_04_01.models._models_py3.Contact] = None, contact_tech: Optional[azure.mgmt.web.v2015_04_01.models._models_py3.Contact] = None, privacy: Optional[bool] = None, auto_renew: Optional[bool] = True, consent: Optional[azure.mgmt.web.v2015_04_01.models._models_py3.DomainPurchaseConsent] = None, dns_type: Optional[Union[str, azure.mgmt.web.v2015_04_01.models._web_site_management_client_enums.DnsType]] = None, dns_zone_id: Optional[str] = None, target_dns_type: Optional[Union[str, azure.mgmt.web.v2015_04_01.models._web_site_management_client_enums.DnsType]] = None, auth_code: Optional[str] = None, **kwargs)

Parameters

kind
str
Required

Kind of resource.

location
str
Required

Required. Resource Location.

tags
dict[str, str]
Required

A set of tags. Resource tags.

contact_admin
Contact
Required

Administrative contact.

contact_billing
Contact
Required

Billing contact.

contact_registrant
Contact
Required

Registrant contact.

contact_tech
Contact
Required

Technical contact.

privacy
bool
Required

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

auto_renew
bool
Required

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

consent
DomainPurchaseConsent
Required

Legal agreement consent.

dns_type
str or DnsType
Required

Current DNS type. Possible values include: "AzureDns", "DefaultDomainRegistrarDns".

dns_zone_id
str
Required

Azure DNS Zone to use.

target_dns_type
str or DnsType
Required

Target DNS type (would be used for migration). Possible values include: "AzureDns", "DefaultDomainRegistrarDns".

auth_code
str
Required

Variables

id
str

Resource Id.

name
str

Resource Name.

type
str

Resource type.

registration_status
str or DomainStatus

Domain registration status. Possible values include: "Active", "Awaiting", "Cancelled", "Confiscated", "Disabled", "Excluded", "Expired", "Failed", "Held", "Locked", "Parked", "Pending", "Reserved", "Reverted", "Suspended", "Transferred", "Unknown", "Unlocked", "Unparked", "Updated", "JsonConverterFailed".

provisioning_state
str or ProvisioningState

Domain provisioning state. Possible values include: "Succeeded", "Failed", "Canceled", "InProgress", "Deleting".

name_servers
list[str]

Name servers.

created_time
datetime

Domain creation timestamp.

expiration_time
datetime

Domain expiration timestamp.

last_renewed_time
datetime

Timestamp when the domain was renewed last time.

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.

domain_not_renewable_reasons
list[str or DomainPropertiesDomainNotRenewableReasonsItem]

Reasons why domain is not renewable.