Share via

DomainPatchResourcePropertiesOutput interface

Package:
@azure-rest/arm-appservice

DomainPatchResource resource specific properties

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

Current DNS type
dnsZoneId

Azure DNS Zone to use
domainNotRenewableReasons

Reasons why domain is not renewable.
expirationTime

Domain expiration timestamp.
lastRenewedTime

Timestamp when the domain was renewed last time.
managedHostNames

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

Name servers.
privacy

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

Domain provisioning state.
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.
registrationStatus

Domain registration status.
targetDnsType

Target DNS type (would be used for migration)

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: DomainPurchaseConsentOutput

Property Value

DomainPurchaseConsentOutput

contactAdmin

Administrative contact.

contactAdmin: ContactOutput

Property Value

ContactOutput

contactBilling

Billing contact.

contactBilling: ContactOutput

Property Value

ContactOutput

contactRegistrant

Registrant contact.

contactRegistrant: ContactOutput

Property Value

ContactOutput

contactTech

Technical contact.

contactTech: ContactOutput

Property Value

ContactOutput

createdTime

Domain creation timestamp.

createdTime?: string

Property Value

string

dnsType

Current DNS type

dnsType?: "AzureDns" | "DefaultDomainRegistrarDns"

Property Value

"AzureDns" | "DefaultDomainRegistrarDns"

dnsZoneId

Azure DNS Zone to use

dnsZoneId?: string

Property Value

string

domainNotRenewableReasons

Reasons why domain is not renewable.

domainNotRenewableReasons?: ("RegistrationStatusNotSupportedForRenewal" | "ExpirationNotInRenewalTimeRange" | "SubscriptionNotActive")[]

Property Value

("RegistrationStatusNotSupportedForRenewal" | "ExpirationNotInRenewalTimeRange" | "SubscriptionNotActive")[]

expirationTime

Domain expiration timestamp.

expirationTime?: string

Property Value

string

lastRenewedTime

Timestamp when the domain was renewed last time.

lastRenewedTime?: string

Property Value

string

managedHostNames

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

managedHostNames?: HostNameOutput[]

Property Value

HostNameOutput[]

nameServers

Name servers.

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.

provisioningState?: "Failed" | "Succeeded" | "Canceled" | "InProgress" | "Deleting"

Property Value

"Failed" | "Succeeded" | "Canceled" | "InProgress" | "Deleting"

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.

readyForDnsRecordManagement?: boolean

Property Value

boolean

registrationStatus

Domain registration status.

registrationStatus?: "Disabled" | "Unknown" | "Failed" | "Expired" | "Active" | "Awaiting" | "Cancelled" | "Confiscated" | "Excluded" | "Held" | "Locked" | "Parked" | "Pending" | "Reserved" | "Reverted" | "Suspended" | "Transferred" | "Unlocked" | "Unparked" | "Updated" | "JsonConverterFailed"

Property Value

"Disabled" | "Unknown" | "Failed" | "Expired" | "Active" | "Awaiting" | "Cancelled" | "Confiscated" | "Excluded" | "Held" | "Locked" | "Parked" | "Pending" | "Reserved" | "Reverted" | "Suspended" | "Transferred" | "Unlocked" | "Unparked" | "Updated" | "JsonConverterFailed"

targetDnsType

Target DNS type (would be used for migration)

targetDnsType?: "AzureDns" | "DefaultDomainRegistrarDns"

Property Value

"AzureDns" | "DefaultDomainRegistrarDns"