Microsoft.DomainRegistration domains
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@2022-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
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
domains
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | Resource Location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| kind | Kind of resource. | string |
| properties | Domain resource specific properties | DomainProperties |
DomainProperties
| Name | Description | Value |
|---|---|---|
| authCode | string | |
| autoRenew | true if the domain should be automatically renewed; otherwise, false. |
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 | true if domain privacy is enabled for this domain; otherwise, false. |
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 TopLevelDomain resource. |
string[] |
Contact
| Name | Description | Value |
|---|---|---|
| addressMailing | Mailing address. | Address |
| 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) |
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) |
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": "2022-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"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
domains
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DomainRegistration/domains' |
| apiVersion | The resource api version | '2022-09-01' |
| name | The resource name | string (required) |
| location | Resource Location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| kind | Kind of resource. | string |
| properties | Domain resource specific properties | DomainProperties |
DomainProperties
| Name | Description | Value |
|---|---|---|
| authCode | string | |
| autoRenew | true if the domain should be automatically renewed; otherwise, false. |
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 | true if domain privacy is enabled for this domain; otherwise, false. |
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 TopLevelDomain resource. |
string[] |
Contact
| Name | Description | Value |
|---|---|---|
| addressMailing | Mailing address. | Address |
| 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) |
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) |
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@2022-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
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"
}
kind = "string"
})
}
Property values
domains
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DomainRegistration/domains@2022-09-01" |
| name | The resource name | string (required) |
| location | Resource Location. | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| kind | Kind of resource. | string |
| properties | Domain resource specific properties | DomainProperties |
DomainProperties
| Name | Description | Value |
|---|---|---|
| authCode | string | |
| autoRenew | true if the domain should be automatically renewed; otherwise, false. |
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 | true if domain privacy is enabled for this domain; otherwise, false. |
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 TopLevelDomain resource. |
string[] |
Contact
| Name | Description | Value |
|---|---|---|
| addressMailing | Mailing address. | Address |
| 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) |
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) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for