Record Sets - List

Reference

Service:: DNS

API Version:: 2018-09-01

Lists all record sets in a Private DNS zone.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL?api-version=2018-09-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL?$top={$top}&$recordsetnamesuffix={$recordsetnamesuffix}&api-version=2018-09-01

URI Parameters

Name	In	Required	Type	Description
privateZoneName	path	True	string	The name of the Private DNS zone (without a terminating dot).
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.
$recordsetnamesuffix	query		string	The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with ".".
$top	query		integer int32	The maximum number of record sets to return. If not specified, returns up to 100 record sets.

Responses

Name	Type	Description
200 OK	RecordSetListResult	Success.
Other Status Codes	CloudError	Default response. It will be deserialized as per the Error definition.

Examples

GET Private DNS Zone ALL Record Sets

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/ALL?api-version=2018-09-01

Sample Response

Status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/ALL?api-version=2018-09-01&$skipToken=skipToken",
  "value": [
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/A/recorda",
      "etag": "00000000-0000-0000-0000-000000000000",
      "name": "recorda",
      "type": "Microsoft.Network/privateDnsZones/A",
      "properties": {
        "metadata": {
          "key1": "value1"
        },
        "ttl": 3600,
        "fqdn": "recorda.privatezone1.com.",
        "isAutoRegistered": false,
        "aRecords": [
          {
            "ipv4Address": "1.2.3.4"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/CNAME/recordcname",
      "etag": "00000000-0000-0000-0000-000000000000",
      "name": "recordcname",
      "type": "Microsoft.Network/privateDnsZones/CNAME",
      "properties": {
        "metadata": {
          "key1": "value1"
        },
        "ttl": 3600,
        "fqdn": "recordcname.privatezone1.com.",
        "isAutoRegistered": false,
        "cnameRecord": {
          "cname": "contoso.com"
        }
      }
    },
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup1/providers/Microsoft.Network/privateDnsZones/privatezone1.com/MX/recordmx",
      "etag": "00000000-0000-0000-0000-000000000000",
      "name": "recordmx",
      "type": "Microsoft.Network/privateDnsZones/MX",
      "properties": {
        "metadata": {
          "key1": "value1"
        },
        "ttl": 3600,
        "fqdn": "recordmx.privatezone1.com.",
        "isAutoRegistered": false,
        "mxRecords": [
          {
            "preference": 0,
            "exchange": "mail.contoso1.com"
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
AaaaRecord	An AAAA record.
ARecord	An A record.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
CnameRecord	A CNAME record.
MxRecord	An MX record.
PtrRecord	A PTR record.
RecordSet	Describes a DNS record set (a collection of DNS records with the same name and type) in a Private DNS zone.
RecordSetListResult	The response to a record set list operation.
SoaRecord	An SOA record.
SrvRecord	An SRV record.
TxtRecord	A TXT record.

AaaaRecord

An AAAA record.

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

ARecord

An A record.

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

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

CnameRecord

A CNAME record.

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

MxRecord

An MX record.

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

PtrRecord

A PTR record.

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

RecordSet

Describes a DNS record set (a collection of DNS records with the same name and type) in a Private DNS zone.

Name	Type	Description
etag	string	The ETag of the record set.
id	string	The ID of the record set.
name	string	The name of the record set.
properties.aRecords	ARecord[]	The list of A records in the record set.
properties.aaaaRecords	AaaaRecord[]	The list of AAAA records in the record set.
properties.cnameRecord	CnameRecord	The CNAME record in the record set.
properties.fqdn	string	Fully qualified domain name of the record set.
properties.isAutoRegistered	boolean	Is the record set auto-registered in the Private DNS zone through a virtual network link?
properties.metadata	object	The metadata attached to the record set.
properties.mxRecords	MxRecord[]	The list of MX records in the record set.
properties.ptrRecords	PtrRecord[]	The list of PTR records in the record set.
properties.soaRecord	SoaRecord	The SOA record in the record set.
properties.srvRecords	SrvRecord[]	The list of SRV records in the record set.
properties.ttl	integer	The TTL (time-to-live) of the records in the record set.
properties.txtRecords	TxtRecord[]	The list of TXT records in the record set.
type	string	The type of the record set.

RecordSetListResult

The response to a record set list operation.

Name	Type	Description
nextLink	string	The continuation token for the next page of results.
value	RecordSet[]	Information about the record sets in the response.

SoaRecord

An SOA record.

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

SrvRecord

An SRV record.

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

TxtRecord

A TXT record.

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