Microsoft.DomainRegistration domains 2015-08-01

• Latest
• 2024-11-01
• 2024-04-01
• 2023-12-01
• 2023-01-01
• 2022-09-01
• 2022-03-01
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01
• 2020-10-01
• 2020-09-01
• 2020-06-01
• 2019-08-01
• 2018-02-01
• 2015-08-01
• 2015-04-01

Bicep resource definition

The domains resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DomainRegistration/domains resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DomainRegistration/domains@2015-08-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    autoRenew: bool
    consent: {
      agreedAt: 'string'
      agreedBy: 'string'
      agreementKeys: [
        'string'
      ]
    }
    contactAdmin: {
      addressMailing: {
        address1: 'string'
        address2: 'string'
        city: 'string'
        country: 'string'
        postalCode: 'string'
        state: 'string'
      }
      email: 'string'
      fax: 'string'
      jobTitle: 'string'
      nameFirst: 'string'
      nameLast: 'string'
      nameMiddle: 'string'
      organization: 'string'
      phone: 'string'
    }
    contactBilling: {
      addressMailing: {
        address1: 'string'
        address2: 'string'
        city: 'string'
        country: 'string'
        postalCode: 'string'
        state: 'string'
      }
      email: 'string'
      fax: 'string'
      jobTitle: 'string'
      nameFirst: 'string'
      nameLast: 'string'
      nameMiddle: 'string'
      organization: 'string'
      phone: 'string'
    }
    contactRegistrant: {
      addressMailing: {
        address1: 'string'
        address2: 'string'
        city: 'string'
        country: 'string'
        postalCode: 'string'
        state: 'string'
      }
      email: 'string'
      fax: 'string'
      jobTitle: 'string'
      nameFirst: 'string'
      nameLast: 'string'
      nameMiddle: 'string'
      organization: 'string'
      phone: 'string'
    }
    contactTech: {
      addressMailing: {
        address1: 'string'
        address2: 'string'
        city: 'string'
        country: 'string'
        postalCode: 'string'
        state: 'string'
      }
      email: 'string'
      fax: 'string'
      jobTitle: 'string'
      nameFirst: 'string'
      nameLast: 'string'
      nameMiddle: 'string'
      organization: 'string'
      phone: 'string'
    }
    createdTime: 'string'
    domainNotRenewableReasons: [
      'string'
    ]
    expirationTime: 'string'
    lastRenewedTime: 'string'
    managedHostNames: [
      {
        azureResourceName: 'string'
        azureResourceType: 'string'
        customHostNameDnsRecordType: 'string'
        hostNameType: 'string'
        name: 'string'
        siteNames: [
          'string'
        ]
      }
    ]
    nameServers: [
      'string'
    ]
    privacy: bool
    provisioningState: 'string'
    readyForDnsRecordManagement: bool
    registrationStatus: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DomainRegistration/domains

Name	Description	Value
kind	Kind of resource	string
location	Resource Location	string (required)
name	The resource name	string (required)
properties		DomainProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

Address

Name	Description	Value
address1	Address 1	string
address2	Address 2	string
city	City	string
country	Country	string
postalCode	Postal code	string
state	State	string

Contact

Name	Description	Value
addressMailing	Mailing address	Address
email	Email address	string
fax	Fax number	string
jobTitle	Job title	string
nameFirst	First name	string
nameLast	Last name	string
nameMiddle	Middle name	string
organization	Organization	string
phone	Phone number	string

DomainProperties

Name	Description	Value
autoRenew	If true then domain will renewed automatically	bool
consent	Legal agreement consent	DomainPurchaseConsent
contactAdmin	Admin contact information	Contact
contactBilling	Billing contact information	Contact
contactRegistrant	Registrant contact information	Contact
contactTech	Technical contact information	Contact
createdTime	Domain creation timestamp	string
domainNotRenewableReasons	Reasons why domain is not renewable	String array containing any of: 'ExpirationNotInRenewalTimeRange' 'RegistrationStatusNotSupportedForRenewal' 'SubscriptionNotActive'
expirationTime	Domain expiration timestamp	string
lastRenewedTime	Timestamp when the domain was renewed last time	string
managedHostNames	All hostnames derived from the domain and assigned to Azure resources	HostName[]
nameServers	Name servers	string[]
privacy	If true then domain privacy is enabled for this domain	bool
provisioningState	Domain provisioning state	'Canceled' 'Deleting' 'Failed' 'InProgress' 'Succeeded'
readyForDnsRecordManagement	If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to	bool
registrationStatus	Domain registration status	'Active' 'Awaiting' 'Cancelled' 'Confiscated' 'Disabled' 'Excluded' 'Expired' 'Failed' 'Held' 'JsonConverterFailed' 'Locked' 'Parked' 'Pending' 'Reserved' 'Reverted' 'Suspended' 'Transferred' 'Unknown' 'Unlocked' 'Unparked' 'Updated'

DomainPurchaseConsent

Name	Description	Value
agreedAt	Timestamp when the agreements were accepted	string
agreedBy	Client IP address	string
agreementKeys	List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource	string[]

HostName

Name	Description	Value
azureResourceName	Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name	string
azureResourceType	Type of the Azure resource the hostname is assigned to	'TrafficManager' 'Website'
customHostNameDnsRecordType	Type of the Dns record	'A' 'CName'
hostNameType	Type of the hostname	'Managed' 'Verified'
name	Name of the hostname	string
siteNames	List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager	string[]

ResourceTags

Name	Description	Value

ARM template resource definition

The domains resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DomainRegistration/domains resource, add the following JSON to your template.

{
  "type": "Microsoft.DomainRegistration/domains",
  "apiVersion": "2015-08-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "autoRenew": "bool",
    "consent": {
      "agreedAt": "string",
      "agreedBy": "string",
      "agreementKeys": [ "string" ]
    },
    "contactAdmin": {
      "addressMailing": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "postalCode": "string",
        "state": "string"
      },
      "email": "string",
      "fax": "string",
      "jobTitle": "string",
      "nameFirst": "string",
      "nameLast": "string",
      "nameMiddle": "string",
      "organization": "string",
      "phone": "string"
    },
    "contactBilling": {
      "addressMailing": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "postalCode": "string",
        "state": "string"
      },
      "email": "string",
      "fax": "string",
      "jobTitle": "string",
      "nameFirst": "string",
      "nameLast": "string",
      "nameMiddle": "string",
      "organization": "string",
      "phone": "string"
    },
    "contactRegistrant": {
      "addressMailing": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "postalCode": "string",
        "state": "string"
      },
      "email": "string",
      "fax": "string",
      "jobTitle": "string",
      "nameFirst": "string",
      "nameLast": "string",
      "nameMiddle": "string",
      "organization": "string",
      "phone": "string"
    },
    "contactTech": {
      "addressMailing": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "postalCode": "string",
        "state": "string"
      },
      "email": "string",
      "fax": "string",
      "jobTitle": "string",
      "nameFirst": "string",
      "nameLast": "string",
      "nameMiddle": "string",
      "organization": "string",
      "phone": "string"
    },
    "createdTime": "string",
    "domainNotRenewableReasons": [ "string" ],
    "expirationTime": "string",
    "lastRenewedTime": "string",
    "managedHostNames": [
      {
        "azureResourceName": "string",
        "azureResourceType": "string",
        "customHostNameDnsRecordType": "string",
        "hostNameType": "string",
        "name": "string",
        "siteNames": [ "string" ]
      }
    ],
    "nameServers": [ "string" ],
    "privacy": "bool",
    "provisioningState": "string",
    "readyForDnsRecordManagement": "bool",
    "registrationStatus": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DomainRegistration/domains

Name	Description	Value
apiVersion	The api version	'2015-08-01'
kind	Kind of resource	string
location	Resource Location	string (required)
name	The resource name	string (required)
properties		DomainProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DomainRegistration/domains'

Address

Name	Description	Value
address1	Address 1	string
address2	Address 2	string
city	City	string
country	Country	string
postalCode	Postal code	string
state	State	string

Contact

Name	Description	Value
addressMailing	Mailing address	Address
email	Email address	string
fax	Fax number	string
jobTitle	Job title	string
nameFirst	First name	string
nameLast	Last name	string
nameMiddle	Middle name	string
organization	Organization	string
phone	Phone number	string

DomainProperties

Name	Description	Value
autoRenew	If true then domain will renewed automatically	bool
consent	Legal agreement consent	DomainPurchaseConsent
contactAdmin	Admin contact information	Contact
contactBilling	Billing contact information	Contact
contactRegistrant	Registrant contact information	Contact
contactTech	Technical contact information	Contact
createdTime	Domain creation timestamp	string
domainNotRenewableReasons	Reasons why domain is not renewable	String array containing any of: 'ExpirationNotInRenewalTimeRange' 'RegistrationStatusNotSupportedForRenewal' 'SubscriptionNotActive'
expirationTime	Domain expiration timestamp	string
lastRenewedTime	Timestamp when the domain was renewed last time	string
managedHostNames	All hostnames derived from the domain and assigned to Azure resources	HostName[]
nameServers	Name servers	string[]
privacy	If true then domain privacy is enabled for this domain	bool
provisioningState	Domain provisioning state	'Canceled' 'Deleting' 'Failed' 'InProgress' 'Succeeded'
readyForDnsRecordManagement	If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to	bool
registrationStatus	Domain registration status	'Active' 'Awaiting' 'Cancelled' 'Confiscated' 'Disabled' 'Excluded' 'Expired' 'Failed' 'Held' 'JsonConverterFailed' 'Locked' 'Parked' 'Pending' 'Reserved' 'Reverted' 'Suspended' 'Transferred' 'Unknown' 'Unlocked' 'Unparked' 'Updated'

DomainPurchaseConsent

Name	Description	Value
agreedAt	Timestamp when the agreements were accepted	string
agreedBy	Client IP address	string
agreementKeys	List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource	string[]

HostName

Name	Description	Value
azureResourceName	Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name	string
azureResourceType	Type of the Azure resource the hostname is assigned to	'TrafficManager' 'Website'
customHostNameDnsRecordType	Type of the Dns record	'A' 'CName'
hostNameType	Type of the hostname	'Managed' 'Verified'
name	Name of the hostname	string
siteNames	List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager	string[]

ResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The domains resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DomainRegistration/domains resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DomainRegistration/domains@2015-08-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      autoRenew = bool
      consent = {
        agreedAt = "string"
        agreedBy = "string"
        agreementKeys = [
          "string"
        ]
      }
      contactAdmin = {
        addressMailing = {
          address1 = "string"
          address2 = "string"
          city = "string"
          country = "string"
          postalCode = "string"
          state = "string"
        }
        email = "string"
        fax = "string"
        jobTitle = "string"
        nameFirst = "string"
        nameLast = "string"
        nameMiddle = "string"
        organization = "string"
        phone = "string"
      }
      contactBilling = {
        addressMailing = {
          address1 = "string"
          address2 = "string"
          city = "string"
          country = "string"
          postalCode = "string"
          state = "string"
        }
        email = "string"
        fax = "string"
        jobTitle = "string"
        nameFirst = "string"
        nameLast = "string"
        nameMiddle = "string"
        organization = "string"
        phone = "string"
      }
      contactRegistrant = {
        addressMailing = {
          address1 = "string"
          address2 = "string"
          city = "string"
          country = "string"
          postalCode = "string"
          state = "string"
        }
        email = "string"
        fax = "string"
        jobTitle = "string"
        nameFirst = "string"
        nameLast = "string"
        nameMiddle = "string"
        organization = "string"
        phone = "string"
      }
      contactTech = {
        addressMailing = {
          address1 = "string"
          address2 = "string"
          city = "string"
          country = "string"
          postalCode = "string"
          state = "string"
        }
        email = "string"
        fax = "string"
        jobTitle = "string"
        nameFirst = "string"
        nameLast = "string"
        nameMiddle = "string"
        organization = "string"
        phone = "string"
      }
      createdTime = "string"
      domainNotRenewableReasons = [
        "string"
      ]
      expirationTime = "string"
      lastRenewedTime = "string"
      managedHostNames = [
        {
          azureResourceName = "string"
          azureResourceType = "string"
          customHostNameDnsRecordType = "string"
          hostNameType = "string"
          name = "string"
          siteNames = [
            "string"
          ]
        }
      ]
      nameServers = [
        "string"
      ]
      privacy = bool
      provisioningState = "string"
      readyForDnsRecordManagement = bool
      registrationStatus = "string"
    }
  }
}

Property Values

Microsoft.DomainRegistration/domains

Name	Description	Value
kind	Kind of resource	string
location	Resource Location	string (required)
name	The resource name	string (required)
properties		DomainProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DomainRegistration/domains@2015-08-01"

Address

Name	Description	Value
address1	Address 1	string
address2	Address 2	string
city	City	string
country	Country	string
postalCode	Postal code	string
state	State	string

Contact

Name	Description	Value
addressMailing	Mailing address	Address
email	Email address	string
fax	Fax number	string
jobTitle	Job title	string
nameFirst	First name	string
nameLast	Last name	string
nameMiddle	Middle name	string
organization	Organization	string
phone	Phone number	string

DomainProperties

Name	Description	Value
autoRenew	If true then domain will renewed automatically	bool
consent	Legal agreement consent	DomainPurchaseConsent
contactAdmin	Admin contact information	Contact
contactBilling	Billing contact information	Contact
contactRegistrant	Registrant contact information	Contact
contactTech	Technical contact information	Contact
createdTime	Domain creation timestamp	string
domainNotRenewableReasons	Reasons why domain is not renewable	String array containing any of: 'ExpirationNotInRenewalTimeRange' 'RegistrationStatusNotSupportedForRenewal' 'SubscriptionNotActive'
expirationTime	Domain expiration timestamp	string
lastRenewedTime	Timestamp when the domain was renewed last time	string
managedHostNames	All hostnames derived from the domain and assigned to Azure resources	HostName[]
nameServers	Name servers	string[]
privacy	If true then domain privacy is enabled for this domain	bool
provisioningState	Domain provisioning state	'Canceled' 'Deleting' 'Failed' 'InProgress' 'Succeeded'
readyForDnsRecordManagement	If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to	bool
registrationStatus	Domain registration status	'Active' 'Awaiting' 'Cancelled' 'Confiscated' 'Disabled' 'Excluded' 'Expired' 'Failed' 'Held' 'JsonConverterFailed' 'Locked' 'Parked' 'Pending' 'Reserved' 'Reverted' 'Suspended' 'Transferred' 'Unknown' 'Unlocked' 'Unparked' 'Updated'

DomainPurchaseConsent

Name	Description	Value
agreedAt	Timestamp when the agreements were accepted	string
agreedBy	Client IP address	string
agreementKeys	List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource	string[]

HostName

Name	Description	Value
azureResourceName	Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name	string
azureResourceType	Type of the Azure resource the hostname is assigned to	'TrafficManager' 'Website'
customHostNameDnsRecordType	Type of the Dns record	'A' 'CName'
hostNameType	Type of the hostname	'Managed' 'Verified'
name	Name of the hostname	string
siteNames	List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager	string[]

ResourceTags

Name	Description	Value