Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The dnsZones 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.Network/dnsZones resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/dnsZones@2023-07-01-preview' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
registrationVirtualNetworks: [
{
id: 'string'
}
]
resolutionVirtualNetworks: [
{
id: 'string'
}
]
zoneType: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Network/dnsZones
| Name | Description | Value |
|---|---|---|
| etag | The etag of the zone. | string |
| location | Resource location. | string (required) |
| name | The resource name | string (required) |
| properties | The properties of the zone. | ZoneProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource Id. | string |
ZoneProperties
| Name | Description | Value |
|---|---|---|
| registrationVirtualNetworks | A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. | SubResource[] |
| resolutionVirtualNetworks | A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. | SubResource[] |
| zoneType | The type of this DNS zone (Public or Private). | 'Private' 'Public' |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Public DNS Zone | AVM Resource Module for Public DNS Zone |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Azure DNS domain hosting example | This template shows how to create a DNS zone within Azure DNS and how to add some record sets to it. |
| Front Door Standard/Premium with Azure DNS and custom domain | This template creates a Front Door Standard/Premium including a custom domain on Azure DNS and Microsoft-managed certificate. |
ARM template resource definition
The dnsZones 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.Network/dnsZones resource, add the following JSON to your template.
{
"type": "Microsoft.Network/dnsZones",
"apiVersion": "2023-07-01-preview",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"registrationVirtualNetworks": [
{
"id": "string"
}
],
"resolutionVirtualNetworks": [
{
"id": "string"
}
],
"zoneType": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Network/dnsZones
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-07-01-preview' |
| etag | The etag of the zone. | string |
| location | Resource location. | string (required) |
| name | The resource name | string (required) |
| properties | The properties of the zone. | ZoneProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Network/dnsZones' |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource Id. | string |
ZoneProperties
| Name | Description | Value |
|---|---|---|
| registrationVirtualNetworks | A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. | SubResource[] |
| resolutionVirtualNetworks | A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. | SubResource[] |
| zoneType | The type of this DNS zone (Public or Private). | 'Private' 'Public' |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure DNS domain hosting example |
This template shows how to create a DNS zone within Azure DNS and how to add some record sets to it. |
| Create a DNS Zone with the correct records for Office 365 |
This template configures the records needed to integrate Azure DNS with Office 365 by adding the correct CNAME, SRV, MX, and TXT records. |
| Front Door Standard/Premium with Azure DNS and custom domain |
This template creates a Front Door Standard/Premium including a custom domain on Azure DNS and Microsoft-managed certificate. |
Terraform (AzAPI provider) resource definition
The dnsZones 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.Network/dnsZones resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/dnsZones@2023-07-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
registrationVirtualNetworks = [
{
id = "string"
}
]
resolutionVirtualNetworks = [
{
id = "string"
}
]
zoneType = "string"
}
}
}
Property Values
Microsoft.Network/dnsZones
| Name | Description | Value |
|---|---|---|
| etag | The etag of the zone. | string |
| location | Resource location. | string (required) |
| name | The resource name | string (required) |
| properties | The properties of the zone. | ZoneProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Network/dnsZones@2023-07-01-preview" |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource Id. | string |
ZoneProperties
| Name | Description | Value |
|---|---|---|
| registrationVirtualNetworks | A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. | SubResource[] |
| resolutionVirtualNetworks | A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. | SubResource[] |
| zoneType | The type of this DNS zone (Public or Private). | 'Private' 'Public' |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Public DNS Zone | AVM Resource Module for Public DNS Zone |