Microsoft.Network dnsZones/A 2017-09-01

• Latest
• 2023-07-01-preview
• 2018-05-01
• 2018-03-01-preview
• 2017-10-01
• 2017-09-01
• 2016-04-01
• 2015-05-04-preview

Bicep resource definition

The dnsZones/A 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/A resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/dnsZones/A@2017-09-01' = {
  etag: 'string'
  name: 'string'
  properties: {
    AAAARecords: [
      {
        ipv6Address: 'string'
      }
    ]
    ARecords: [
      {
        ipv4Address: 'string'
      }
    ]
    caaRecords: [
      {
        flags: int
        tag: 'string'
        value: 'string'
      }
    ]
    CNAMERecord: {
      cname: 'string'
    }
    metadata: {
      {customized property}: 'string'
    }
    MXRecords: [
      {
        exchange: 'string'
        preference: int
      }
    ]
    NSRecords: [
      {
        nsdname: 'string'
      }
    ]
    PTRRecords: [
      {
        ptrdname: 'string'
      }
    ]
    SOARecord: {
      email: 'string'
      expireTime: int
      host: 'string'
      minimumTTL: int
      refreshTime: int
      retryTime: int
      serialNumber: int
    }
    SRVRecords: [
      {
        port: int
        priority: int
        target: 'string'
        weight: int
      }
    ]
    TTL: int
    TXTRecords: [
      {
        value: [
          'string'
        ]
      }
    ]
  }
}

Property values

AaaaRecord

Name	Description	Value
ipv6Address	The IPv6 address of this AAAA record.	string

ARecord

Name	Description	Value
ipv4Address	The IPv4 address of this A record.	string

CaaRecord

Name	Description	Value
flags	The flags for this CAA record as an integer between 0 and 255.	int
tag	The tag for this CAA record.	string
value	The value for this CAA record.	string

CnameRecord

Name	Description	Value
cname	The canonical name for this CNAME record.	string

Microsoft.Network/dnsZones/A

Name	Description	Value
etag	The etag of the record set.	string
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: dnsZones
properties	The properties of the record set.	RecordSetProperties

MxRecord

Name	Description	Value
exchange	The domain name of the mail host for this MX record.	string
preference	The preference value for this MX record.	int

NsRecord

Name	Description	Value
nsdname	The name server name for this NS record.	string

PtrRecord

Name	Description	Value
ptrdname	The PTR target domain name for this PTR record.	string

RecordSetProperties

Name	Description	Value
AAAARecords	The list of AAAA records in the record set.	AaaaRecord[]
ARecords	The list of A records in the record set.	ARecord[]
caaRecords	The list of CAA records in the record set.	CaaRecord[]
CNAMERecord	The CNAME record in the record set.	CnameRecord
metadata	The metadata attached to the record set.	RecordSetPropertiesMetadata
MXRecords	The list of MX records in the record set.	MxRecord[]
NSRecords	The list of NS records in the record set.	NsRecord[]
PTRRecords	The list of PTR records in the record set.	PtrRecord[]
SOARecord	The SOA record in the record set.	SoaRecord
SRVRecords	The list of SRV records in the record set.	SrvRecord[]
TTL	The TTL (time-to-live) of the records in the record set.	int
TXTRecords	The list of TXT records in the record set.	TxtRecord[]

RecordSetPropertiesMetadata

Name	Description	Value

SoaRecord

Name	Description	Value
email	The email contact for this SOA record.	string
expireTime	The expire time for this SOA record.	int
host	The domain name of the authoritative name server for this SOA record.	string
minimumTTL	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.	int
refreshTime	The refresh value for this SOA record.	int
retryTime	The retry time for this SOA record.	int
serialNumber	The serial number for this SOA record.	int

SrvRecord

Name	Description	Value
port	The port value for this SRV record.	int
priority	The priority value for this SRV record.	int
target	The target domain name for this SRV record.	string
weight	The weight value for this SRV record.	int

TxtRecord

Name	Description	Value
value	The text value of this TXT record.	string[]

Quickstart samples

The following quickstart samples deploy 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.

ARM template resource definition

The dnsZones/A 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/A resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/dnsZones/A",
  "apiVersion": "2017-09-01",
  "name": "string",
  "etag": "string",
  "properties": {
    "AAAARecords": [
      {
        "ipv6Address": "string"
      }
    ],
    "ARecords": [
      {
        "ipv4Address": "string"
      }
    ],
    "caaRecords": [
      {
        "flags": "int",
        "tag": "string",
        "value": "string"
      }
    ],
    "CNAMERecord": {
      "cname": "string"
    },
    "metadata": {
      "{customized property}": "string"
    },
    "MXRecords": [
      {
        "exchange": "string",
        "preference": "int"
      }
    ],
    "NSRecords": [
      {
        "nsdname": "string"
      }
    ],
    "PTRRecords": [
      {
        "ptrdname": "string"
      }
    ],
    "SOARecord": {
      "email": "string",
      "expireTime": "int",
      "host": "string",
      "minimumTTL": "int",
      "refreshTime": "int",
      "retryTime": "int",
      "serialNumber": "int"
    },
    "SRVRecords": [
      {
        "port": "int",
        "priority": "int",
        "target": "string",
        "weight": "int"
      }
    ],
    "TTL": "int",
    "TXTRecords": [
      {
        "value": [ "string" ]
      }
    ]
  }
}

Property values

AaaaRecord

Name	Description	Value
ipv6Address	The IPv6 address of this AAAA record.	string

ARecord

Name	Description	Value
ipv4Address	The IPv4 address of this A record.	string

CaaRecord

Name	Description	Value
flags	The flags for this CAA record as an integer between 0 and 255.	int
tag	The tag for this CAA record.	string
value	The value for this CAA record.	string

CnameRecord

Name	Description	Value
cname	The canonical name for this CNAME record.	string

Microsoft.Network/dnsZones/A

Name	Description	Value
apiVersion	The api version	'2017-09-01'
etag	The etag of the record set.	string
name	The resource name	string (required)
properties	The properties of the record set.	RecordSetProperties
type	The resource type	'Microsoft.Network/dnsZones/A'

MxRecord

Name	Description	Value
exchange	The domain name of the mail host for this MX record.	string
preference	The preference value for this MX record.	int

NsRecord

Name	Description	Value
nsdname	The name server name for this NS record.	string

PtrRecord

Name	Description	Value
ptrdname	The PTR target domain name for this PTR record.	string

RecordSetProperties

Name	Description	Value
AAAARecords	The list of AAAA records in the record set.	AaaaRecord[]
ARecords	The list of A records in the record set.	ARecord[]
caaRecords	The list of CAA records in the record set.	CaaRecord[]
CNAMERecord	The CNAME record in the record set.	CnameRecord
metadata	The metadata attached to the record set.	RecordSetPropertiesMetadata
MXRecords	The list of MX records in the record set.	MxRecord[]
NSRecords	The list of NS records in the record set.	NsRecord[]
PTRRecords	The list of PTR records in the record set.	PtrRecord[]
SOARecord	The SOA record in the record set.	SoaRecord
SRVRecords	The list of SRV records in the record set.	SrvRecord[]
TTL	The TTL (time-to-live) of the records in the record set.	int
TXTRecords	The list of TXT records in the record set.	TxtRecord[]

RecordSetPropertiesMetadata

Name	Description	Value

SoaRecord

Name	Description	Value
email	The email contact for this SOA record.	string
expireTime	The expire time for this SOA record.	int
host	The domain name of the authoritative name server for this SOA record.	string
minimumTTL	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.	int
refreshTime	The refresh value for this SOA record.	int
retryTime	The retry time for this SOA record.	int
serialNumber	The serial number for this SOA record.	int

SrvRecord

Name	Description	Value
port	The port value for this SRV record.	int
priority	The priority value for this SRV record.	int
target	The target domain name for this SRV record.	string
weight	The weight value for this SRV record.	int

TxtRecord

Name	Description	Value
value	The text value of this TXT record.	string[]

Quickstart templates

The following 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.

Terraform (AzAPI provider) resource definition

The dnsZones/A 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/A resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/dnsZones/A@2017-09-01"
  name = "string"
  etag = "string"
  body = jsonencode({
    properties = {
      AAAARecords = [
        {
          ipv6Address = "string"
        }
      ]
      ARecords = [
        {
          ipv4Address = "string"
        }
      ]
      caaRecords = [
        {
          flags = int
          tag = "string"
          value = "string"
        }
      ]
      CNAMERecord = {
        cname = "string"
      }
      metadata = {
        {customized property} = "string"
      }
      MXRecords = [
        {
          exchange = "string"
          preference = int
        }
      ]
      NSRecords = [
        {
          nsdname = "string"
        }
      ]
      PTRRecords = [
        {
          ptrdname = "string"
        }
      ]
      SOARecord = {
        email = "string"
        expireTime = int
        host = "string"
        minimumTTL = int
        refreshTime = int
        retryTime = int
        serialNumber = int
      }
      SRVRecords = [
        {
          port = int
          priority = int
          target = "string"
          weight = int
        }
      ]
      TTL = int
      TXTRecords = [
        {
          value = [
            "string"
          ]
        }
      ]
    }
  })
}

Property values

AaaaRecord

Name	Description	Value
ipv6Address	The IPv6 address of this AAAA record.	string

ARecord

Name	Description	Value
ipv4Address	The IPv4 address of this A record.	string

CaaRecord

Name	Description	Value
flags	The flags for this CAA record as an integer between 0 and 255.	int
tag	The tag for this CAA record.	string
value	The value for this CAA record.	string

CnameRecord

Name	Description	Value
cname	The canonical name for this CNAME record.	string

Microsoft.Network/dnsZones/A

Name	Description	Value
etag	The etag of the record set.	string
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: dnsZones
properties	The properties of the record set.	RecordSetProperties
type	The resource type	"Microsoft.Network/dnsZones/A@2017-09-01"

MxRecord

Name	Description	Value
exchange	The domain name of the mail host for this MX record.	string
preference	The preference value for this MX record.	int

NsRecord

Name	Description	Value
nsdname	The name server name for this NS record.	string

PtrRecord

Name	Description	Value
ptrdname	The PTR target domain name for this PTR record.	string

RecordSetProperties

Name	Description	Value
AAAARecords	The list of AAAA records in the record set.	AaaaRecord[]
ARecords	The list of A records in the record set.	ARecord[]
caaRecords	The list of CAA records in the record set.	CaaRecord[]
CNAMERecord	The CNAME record in the record set.	CnameRecord
metadata	The metadata attached to the record set.	RecordSetPropertiesMetadata
MXRecords	The list of MX records in the record set.	MxRecord[]
NSRecords	The list of NS records in the record set.	NsRecord[]
PTRRecords	The list of PTR records in the record set.	PtrRecord[]
SOARecord	The SOA record in the record set.	SoaRecord
SRVRecords	The list of SRV records in the record set.	SrvRecord[]
TTL	The TTL (time-to-live) of the records in the record set.	int
TXTRecords	The list of TXT records in the record set.	TxtRecord[]

RecordSetPropertiesMetadata

Name	Description	Value

SoaRecord

Name	Description	Value
email	The email contact for this SOA record.	string
expireTime	The expire time for this SOA record.	int
host	The domain name of the authoritative name server for this SOA record.	string
minimumTTL	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.	int
refreshTime	The refresh value for this SOA record.	int
retryTime	The retry time for this SOA record.	int
serialNumber	The serial number for this SOA record.	int

SrvRecord

Name	Description	Value
port	The port value for this SRV record.	int
priority	The priority value for this SRV record.	int
target	The target domain name for this SRV record.	string
weight	The weight value for this SRV record.	int

TxtRecord

Name	Description	Value
value	The text value of this TXT record.	string[]