Microsoft.Network dnsZones 2018-05-01

Bicep resource definition

The dnsZones resource type can be deployed to:

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@2018-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  etag: 'string'
  properties: {
    registrationVirtualNetworks: [
      {
        id: 'string'
      }
    ]
    resolutionVirtualNetworks: [
      {
        id: 'string'
      }
    ]
    zoneType: 'string'
  }
}

Property values

dnsZones

Name Description Value
name The resource name string (required)

Character limit: 1-63 characters

2 to 34 labels

Each label is a set of characters separated by a period. For example, contoso.com has 2 labels.

Valid characters:
Each label can contain alphanumerics, underscores, and hyphens.

Each label is separated by a period.
location Resource location. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
etag The etag of the zone. string
properties The properties of the zone. ZoneProperties

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'

SubResource

Name Description Value
id Resource Id. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a DNS Zone with the correct records for Office 365

Deploy to Azure
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

Deploy to Azure
This template creates a Front Door Standard/Premium including a custom domain on Azure DNS and Microsoft-managed certificate.
Azure DNS domain hosting example

Deploy to Azure
This template shows how to create a DNS zone within Azure DNS and how to add some record sets to it.

ARM template resource definition

The dnsZones resource type can be deployed to:

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": "2018-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "etag": "string",
  "properties": {
    "registrationVirtualNetworks": [
      {
        "id": "string"
      }
    ],
    "resolutionVirtualNetworks": [
      {
        "id": "string"
      }
    ],
    "zoneType": "string"
  }
}

Property values

dnsZones

Name Description Value
type The resource type 'Microsoft.Network/dnsZones'
apiVersion The resource api version '2018-05-01'
name The resource name string (required)

Character limit: 1-63 characters

2 to 34 labels

Each label is a set of characters separated by a period. For example, contoso.com has 2 labels.

Valid characters:
Each label can contain alphanumerics, underscores, and hyphens.

Each label is separated by a period.
location Resource location. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
etag The etag of the zone. string
properties The properties of the zone. ZoneProperties

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'

SubResource

Name Description Value
id Resource Id. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a DNS Zone with the correct records for Office 365

Deploy to Azure
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

Deploy to Azure
This template creates a Front Door Standard/Premium including a custom domain on Azure DNS and Microsoft-managed certificate.
Azure DNS domain hosting example

Deploy to Azure
This template shows how to create a DNS zone within Azure DNS and how to add some record sets to it.

Terraform (AzAPI provider) resource definition

The dnsZones resource type can be deployed to:

  • 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@2018-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      registrationVirtualNetworks = [
        {
          id = "string"
        }
      ]
      resolutionVirtualNetworks = [
        {
          id = "string"
        }
      ]
      zoneType = "string"
    }
    etag = "string"
  })
}

Property values

dnsZones

Name Description Value
type The resource type "Microsoft.Network/dnsZones@2018-05-01"
name The resource name string (required)

Character limit: 1-63 characters

2 to 34 labels

Each label is a set of characters separated by a period. For example, contoso.com has 2 labels.

Valid characters:
Each label can contain alphanumerics, underscores, and hyphens.

Each label is separated by a period.
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.
etag The etag of the zone. string
properties The properties of the zone. ZoneProperties

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"

SubResource

Name Description Value
id Resource Id. string