Share via

Microsoft.DomainRegistration domains

Bicep resource definition

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

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@2024-11-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    authCode: 'string'
    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'
    }
    dnsType: 'string'
    dnsZoneId: 'string'
    privacy: bool
    targetDnsType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DomainRegistration/domains

Name Description Value
kind Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. string
location Resource Location. string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9][a-zA-Z0-9\.-]+ (required)
properties Domain resource specific properties DomainProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

Address

Name Description Value
address1 First line of an Address. string (required)
address2 The second line of the Address. Optional. string
city The city for the address. string (required)
country The country for the address. string (required)
postalCode The postal code for the address. string (required)
state The state or province for the address. string (required)

Contact

Name Description Value
addressMailing Mailing address. Address
email Email address. string (required)
fax Fax number. string
jobTitle Job title. string
nameFirst First name. string (required)
nameLast Last name. string (required)
nameMiddle Middle name. string
organization Organization contact belongs to. string
phone Phone number. string (required)

DomainProperties

Name Description Value
authCode string
autoRenew <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. bool
consent Legal agreement consent. DomainPurchaseConsent (required)
contactAdmin Administrative contact. Contact (required)
contactBilling Billing contact. Contact (required)
contactRegistrant Registrant contact. Contact (required)
contactTech Technical contact. Contact (required)
dnsType Current DNS type 'AzureDns'
'DefaultDomainRegistrarDns'
dnsZoneId Azure DNS Zone to use string
privacy <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>. bool
targetDnsType Target DNS type (would be used for migration) 'AzureDns'
'DefaultDomainRegistrarDns'

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 <code>TopLevelDomain</code> resource. string[]

ResourceTags

Name Description Value

ARM template resource definition

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

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": "2024-11-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "authCode": "string",
    "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"
    },
    "dnsType": "string",
    "dnsZoneId": "string",
    "privacy": "bool",
    "targetDnsType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DomainRegistration/domains

Name Description Value
apiVersion The api version '2024-11-01'
kind Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. string
location Resource Location. string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9][a-zA-Z0-9\.-]+ (required)
properties Domain resource specific 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 First line of an Address. string (required)
address2 The second line of the Address. Optional. string
city The city for the address. string (required)
country The country for the address. string (required)
postalCode The postal code for the address. string (required)
state The state or province for the address. string (required)

Contact

Name Description Value
addressMailing Mailing address. Address
email Email address. string (required)
fax Fax number. string
jobTitle Job title. string
nameFirst First name. string (required)
nameLast Last name. string (required)
nameMiddle Middle name. string
organization Organization contact belongs to. string
phone Phone number. string (required)

DomainProperties

Name Description Value
authCode string
autoRenew <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. bool
consent Legal agreement consent. DomainPurchaseConsent (required)
contactAdmin Administrative contact. Contact (required)
contactBilling Billing contact. Contact (required)
contactRegistrant Registrant contact. Contact (required)
contactTech Technical contact. Contact (required)
dnsType Current DNS type 'AzureDns'
'DefaultDomainRegistrarDns'
dnsZoneId Azure DNS Zone to use string
privacy <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>. bool
targetDnsType Target DNS type (would be used for migration) 'AzureDns'
'DefaultDomainRegistrarDns'

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 <code>TopLevelDomain</code> resource. 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@2024-11-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      authCode = "string"
      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"
      }
      dnsType = "string"
      dnsZoneId = "string"
      privacy = bool
      targetDnsType = "string"
    }
  }
}

Property Values

Microsoft.DomainRegistration/domains

Name Description Value
kind Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. string
location Resource Location. string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9][a-zA-Z0-9\.-]+ (required)
properties Domain resource specific properties DomainProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DomainRegistration/domains@2024-11-01"

Address

Name Description Value
address1 First line of an Address. string (required)
address2 The second line of the Address. Optional. string
city The city for the address. string (required)
country The country for the address. string (required)
postalCode The postal code for the address. string (required)
state The state or province for the address. string (required)

Contact

Name Description Value
addressMailing Mailing address. Address
email Email address. string (required)
fax Fax number. string
jobTitle Job title. string
nameFirst First name. string (required)
nameLast Last name. string (required)
nameMiddle Middle name. string
organization Organization contact belongs to. string
phone Phone number. string (required)

DomainProperties

Name Description Value
authCode string
autoRenew <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. bool
consent Legal agreement consent. DomainPurchaseConsent (required)
contactAdmin Administrative contact. Contact (required)
contactBilling Billing contact. Contact (required)
contactRegistrant Registrant contact. Contact (required)
contactTech Technical contact. Contact (required)
dnsType Current DNS type 'AzureDns'
'DefaultDomainRegistrarDns'
dnsZoneId Azure DNS Zone to use string
privacy <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>. bool
targetDnsType Target DNS type (would be used for migration) 'AzureDns'
'DefaultDomainRegistrarDns'

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 <code>TopLevelDomain</code> resource. string[]

ResourceTags

Name Description Value