Domain interface

Package:

@azure/arm-domainregistration

Information about a domain.

Extends

TrackedResource

Properties

authCode	Authorization code for the domain.
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.
kind	Kind of resource
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 \n it is hosted on name servers Azure has programmatic access to.
registrationStatus	Domain registration status.
targetDnsType	Target DNS type (would be used for migration)

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

authCode

Authorization code for the domain.

authCode?: string

Property Value

string

autoRenew

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

autoRenew?: boolean

Property Value

boolean

consent

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.

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.

domainNotRenewableReasons?: string[]

Property Value

string[]

expirationTime

Domain expiration timestamp.

expirationTime?: Date

Property Value

Date

kind

Kind of resource

kind?: string

Property Value

string

lastRenewedTime

Timestamp when the domain was renewed last time.

lastRenewedTime?: Date

Property Value

Date

managedHostNames

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

managedHostNames?: HostName[]

Property Value

HostName[]

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?: 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 \n it is hosted on name servers Azure has programmatic access to.

readyForDnsRecordManagement?: boolean

Property Value

boolean

registrationStatus

Domain registration status.

registrationStatus?: DomainStatus

Property Value

DomainStatus

targetDnsType

Target DNS type (would be used for migration)

targetDnsType?: DnsType

Property Value

DnsType

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type