Microsoft.Network dnsZones/A 2016-04-01

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@2016-04-01' = {
  parent: resourceSymbolicName
  etag: 'string'
  name: 'string'
  properties: {
    AAAARecords: [
      {
        ipv6Address: 'string'
      }
    ]
    ARecords: [
      {
        ipv4Address: '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

Microsoft.Network/dnsZones/A

AaaaRecord

ARecord

CnameRecord

MxRecord

NsRecord

PtrRecord

RecordSetProperties

RecordSetPropertiesMetadata

SoaRecord

SrvRecord

TxtRecord

Usage Examples

Bicep Samples

A basic example of deploying DNS A Record.

param resourceName string = 'acctest0001'

resource dnsZone 'Microsoft.Network/dnsZones@2018-05-01' = {
  name: '${resourceName}.com'
  location: 'global'
}

resource a 'Microsoft.Network/dnsZones/A@2018-05-01' = {
  parent: dnsZone
  name: resourceName
  properties: {
    ARecords: [
      {
        ipv4Address: '1.2.4.5'
      }
      {
        ipv4Address: '1.2.3.4'
      }
    ]
    TTL: 300
    metadata: {}
    targetResource: {}
  }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

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": "2016-04-01",
  "name": "string",
  "etag": "string",
  "properties": {
    "AAAARecords": [
      {
        "ipv6Address": "string"
      }
    ],
    "ARecords": [
      {
        "ipv4Address": "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

Microsoft.Network/dnsZones/A

AaaaRecord

ARecord

CnameRecord

MxRecord

NsRecord

PtrRecord

RecordSetProperties

RecordSetPropertiesMetadata

SoaRecord

SrvRecord

TxtRecord

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.

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@2016-04-01"
  name = "string"
  parent_id = "string"
  body = {
    etag = "string"
    properties = {
      AAAARecords = [
        {
          ipv6Address = "string"
        }
      ]
      ARecords = [
        {
          ipv4Address = "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

Microsoft.Network/dnsZones/A

AaaaRecord

ARecord

CnameRecord

MxRecord

NsRecord

PtrRecord

RecordSetProperties

RecordSetPropertiesMetadata

SoaRecord

SrvRecord

TxtRecord

Usage Examples

Terraform Samples

A basic example of deploying DNS A Record.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "dnsZone" {
  type                      = "Microsoft.Network/dnsZones@2018-05-01"
  parent_id                 = azapi_resource.resourceGroup.id
  name                      = "${var.resource_name}.com"
  location                  = "global"
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "A" {
  type      = "Microsoft.Network/dnsZones/A@2018-05-01"
  parent_id = azapi_resource.dnsZone.id
  name      = var.resource_name
  body = {
    properties = {
      ARecords = [
        {
          ipv4Address = "1.2.4.5"
        },
        {
          ipv4Address = "1.2.3.4"
        },
      ]
      TTL = 300
      metadata = {
      }
      targetResource = {
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}