Microsoft.Network privateDnsZones/A 2024-06-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/privateDnsZones/A@2024-06-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
      }
    ]
    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

ARecord

CnameRecord

Microsoft.Network/privateDnsZones/A

MxRecord

PtrRecord

RecordSetProperties

RecordSetPropertiesMetadata

SoaRecord

SrvRecord

TxtRecord

Quickstart samples

The following quickstart samples deploy this resource type.

ARM template resource definition

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

{
  "type": "Microsoft.Network/privateDnsZones/A",
  "apiVersion": "2024-06-01",
  "name": "string",
  "etag": "string",
  "properties": {
    "aaaaRecords": [
      {
        "ipv6Address": "string"
      }
    ],
    "aRecords": [
      {
        "ipv4Address": "string"
      }
    ],
    "cnameRecord": {
      "cname": "string"
    },
    "metadata": {
      "{customized property}": "string"
    },
    "mxRecords": [
      {
        "exchange": "string",
        "preference": "int"
      }
    ],
    "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

ARecord

CnameRecord

Microsoft.Network/privateDnsZones/A

MxRecord

PtrRecord

RecordSetProperties

RecordSetPropertiesMetadata

SoaRecord

SrvRecord

TxtRecord

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Application Gateway with internal API Management and Web App	Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App.
Azure Cloud Shell - VNet	This template deploys Azure Cloud Shell resources into an Azure virtual network.
Create an AppServicePlan and App in an ASEv3	Create an AppServicePlan and App in an ASEv3
Create API Management in Internal VNet with App Gateway	This template demonstrates how to Create a instance of Azure API Management on a private network protected by Azure Application Gateway.
Create Application Gateway with Certificates	This template shows how to generate Key Vault self-signed certificates, then reference from Application Gateway.
SonarQube on Web App with PostgreSQL and VNet integration	This template provides easy to deploy SonarQube to Web App on Linux with PostgreSQL Flexible Server, VNet integration and private DNS.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/privateDnsZones/A@2024-06-01"
  name = "string"
  etag = "string"
  body = jsonencode({
    properties = {
      aaaaRecords = [
        {
          ipv6Address = "string"
        }
      ]
      aRecords = [
        {
          ipv4Address = "string"
        }
      ]
      cnameRecord = {
        cname = "string"
      }
      metadata = {
        {customized property} = "string"
      }
      mxRecords = [
        {
          exchange = "string"
          preference = int
        }
      ]
      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

ARecord

CnameRecord

Microsoft.Network/privateDnsZones/A

MxRecord

PtrRecord

RecordSetProperties

RecordSetPropertiesMetadata

SoaRecord

SrvRecord

TxtRecord