Share via

Domain interface

  • Reference
Package:
@azure/arm-appservice

Information about a domain.

Extends
Resource

Properties

authCode
autoRenew

true if the domain should be automatically renewed; otherwise, false.
consent

Legal agreement consent.
contactAdmin

Administrative contact.
contactBilling

Billing contact.
contactRegistrant

Registrant contact.
contactTech

Technical contact.
createdTime

Domain creation timestamp. NOTE: This property will not be serialized. It can only be populated by the server.
dnsType

Current DNS type
dnsZoneId

Azure DNS Zone to use
domainNotRenewableReasons

Reasons why domain is not renewable. NOTE: This property will not be serialized. It can only be populated by the server.
expirationTime

Domain expiration timestamp. NOTE: This property will not be serialized. It can only be populated by the server.
lastRenewedTime

Timestamp when the domain was renewed last time. NOTE: This property will not be serialized. It can only be populated by the server.
managedHostNames

All hostnames derived from the domain and assigned to Azure resources. NOTE: This property will not be serialized. It can only be populated by the server.
nameServers

Name servers. NOTE: This property will not be serialized. It can only be populated by the server.
privacy

true if domain privacy is enabled for this domain; otherwise, false.
provisioningState

Domain provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
readyForDnsRecordManagement

true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. NOTE: This property will not be serialized. It can only be populated by the server.
registrationStatus

Domain registration status. NOTE: This property will not be serialized. It can only be populated by the server.
targetDnsType

Target DNS type (would be used for migration)

Inherited Properties

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind

Kind of resource.
location

Resource Location.
name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

authCode 

authCode?: string

Property Value

string

autoRenew

true if the domain should be automatically renewed; otherwise, false.

autoRenew?: boolean

Property Value

boolean

Legal agreement consent.

consent?: DomainPurchaseConsent

Property Value

DomainPurchaseConsent

contactAdmin

Administrative contact.

contactAdmin?: Contact

Property Value

Contact

contactBilling

Billing contact.

contactBilling?: Contact

Property Value

Contact

contactRegistrant

Registrant contact.

contactRegistrant?: Contact

Property Value

Contact

contactTech

Technical contact.

contactTech?: Contact

Property Value

Contact

createdTime

Domain creation timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

createdTime?: Date

Property Value

Date

dnsType

Current DNS type

dnsType?: DnsType

Property Value

DnsType

dnsZoneId

Azure DNS Zone to use

dnsZoneId?: string

Property Value

string

domainNotRenewableReasons

Reasons why domain is not renewable. NOTE: This property will not be serialized. It can only be populated by the server.

domainNotRenewableReasons?: string[]

Property Value

string[]

expirationTime

Domain expiration timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

expirationTime?: Date

Property Value

Date

lastRenewedTime

Timestamp when the domain was renewed last time. NOTE: This property will not be serialized. It can only be populated by the server.

lastRenewedTime?: Date

Property Value

Date

managedHostNames

All hostnames derived from the domain and assigned to Azure resources. NOTE: This property will not be serialized. It can only be populated by the server.

managedHostNames?: HostName[]

Property Value

HostName[]

nameServers

Name servers. NOTE: This property will not be serialized. It can only be populated by the server.

nameServers?: string[]

Property Value

string[]

privacy

true if domain privacy is enabled for this domain; otherwise, false.

privacy?: boolean

Property Value

boolean

provisioningState

Domain provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: ProvisioningState

Property Value

ProvisioningState

readyForDnsRecordManagement

true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. NOTE: This property will not be serialized. It can only be populated by the server.

readyForDnsRecordManagement?: boolean

Property Value

boolean

registrationStatus

Domain registration status. NOTE: This property will not be serialized. It can only be populated by the server.

registrationStatus?: DomainStatus

Property Value

DomainStatus

targetDnsType

Target DNS type (would be used for migration)

targetDnsType?: DnsType

Property Value

DnsType

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 Resource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From Resource.kind

location

Resource Location.

location: string

Property Value

string

Inherited From Resource.location

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 Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

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 Resource.type