Zones - List

Reference

Service:: DNS

API Version:: 2018-05-01

Lists the DNS zones in all resource groups in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones?api-version=2018-05-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones?$top={$top}&api-version=2018-05-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
api-version	query	True	string	Specifies the API version.
$top	query		integer int32	The maximum number of DNS zones to return. If not specified, returns up to 100 zones.

Responses

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

Examples

List zones by subscription

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/dnszones?api-version=2018-05-01


/** Samples for Zones List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/ListZonesBySubscription.json
     */
    /**
     * Sample code: List zones by subscription.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listZonesBySubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.dnsZones().manager().serviceClient().getZones().list(null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.dns import DnsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dns
# USAGE
    python list_zones_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DnsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.zones.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/ListZonesBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdns_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dns/armdns"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/ListZonesBySubscription.json
func ExampleZonesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdns.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewZonesClient().NewListPager(&armdns.ZonesClientListOptions{Top: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ZoneListResult = armdns.ZoneListResult{
		// 	Value: []*armdns.Zone{
		// 		{
		// 			Name: to.Ptr("zone1"),
		// 			Type: to.Ptr("Microsoft.Network/dnsZones"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dnsZones/zone1"),
		// 			Location: to.Ptr("global"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 			},
		// 			Etag: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			Properties: &armdns.ZoneProperties{
		// 				MaxNumberOfRecordSets: to.Ptr[int64](5000),
		// 				NameServers: []*string{
		// 					to.Ptr("ns1-01.azure-dns.com"),
		// 					to.Ptr("ns2-01.azure-dns.net"),
		// 					to.Ptr("ns3-01.azure-dns.org"),
		// 					to.Ptr("ns4-01.azure-dns.info")},
		// 					NumberOfRecordSets: to.Ptr[int64](2),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("zone2"),
		// 				Type: to.Ptr("Microsoft.Network/dnsZones"),
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/dnsZones/zone2"),
		// 				Location: to.Ptr("global"),
		// 				Etag: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				Properties: &armdns.ZoneProperties{
		// 					MaxNumberOfRecordSets: to.Ptr[int64](5000),
		// 					NameServers: []*string{
		// 						to.Ptr("ns1-02.azure-dns.com"),
		// 						to.Ptr("ns2-02.azure-dns.net"),
		// 						to.Ptr("ns3-02.azure-dns.org"),
		// 						to.Ptr("ns4-02.azure-dns.info")},
		// 						NumberOfRecordSets: to.Ptr[int64](300),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DnsManagementClient } = require("@azure/arm-dns");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the DNS zones in all resource groups in a subscription.
 *
 * @summary Lists the DNS zones in all resource groups in a subscription.
 * x-ms-original-file: specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/ListZonesBySubscription.json
 */
async function listZonesBySubscription() {
  const subscriptionId = "subid";
  const credential = new DefaultAzureCredential();
  const client = new DnsManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.zones.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

listZonesBySubscription().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "nextLink": "https://servicehost/subscriptions/subid/providers/Microsoft.Network/dnsZones?api-version=2018-05-01&$skipToken=skipToken",
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dnsZones/zone1",
      "etag": "00000000-0000-0000-0000-000000000000",
      "location": "global",
      "name": "zone1",
      "type": "Microsoft.Network/dnsZones",
      "properties": {
        "maxNumberOfRecordSets": 5000,
        "numberOfRecordSets": 2,
        "nameServers": [
          "ns1-01.azure-dns.com",
          "ns2-01.azure-dns.net",
          "ns3-01.azure-dns.org",
          "ns4-01.azure-dns.info"
        ]
      },
      "tags": {
        "key1": "value1"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/dnsZones/zone2",
      "etag": "00000000-0000-0000-0000-000000000000",
      "location": "global",
      "name": "zone2",
      "type": "Microsoft.Network/dnsZones",
      "properties": {
        "maxNumberOfRecordSets": 5000,
        "numberOfRecordSets": 300,
        "nameServers": [
          "ns1-02.azure-dns.com",
          "ns2-02.azure-dns.net",
          "ns3-02.azure-dns.org",
          "ns4-02.azure-dns.info"
        ]
      }
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
SubResource	A reference to a another resource
Zone	Describes a DNS zone.
ZoneListResult	The response to a Zone List or ListAll operation.
ZoneType	The type of this DNS zone (Public or Private).

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.

SubResource

A reference to a another resource

Name	Type	Description
id	string	Resource Id.

Zone

Describes a DNS zone.

Name	Type	Default Value	Description
etag	string		The etag of the zone.
id	string		Resource ID.
location	string		Resource location.
name	string		Resource name.
properties.maxNumberOfRecordSets	integer		The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
properties.maxNumberOfRecordsPerRecordSet	integer		The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
properties.nameServers	string[]		The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
properties.numberOfRecordSets	integer		The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
properties.registrationVirtualNetworks	SubResource[]		A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
properties.resolutionVirtualNetworks	SubResource[]		A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
properties.zoneType	ZoneType	Public	The type of this DNS zone (Public or Private).
tags	object		Resource tags.
type	string		Resource type.

ZoneListResult

The response to a Zone List or ListAll operation.

Name	Type	Description
nextLink	string	The continuation token for the next page of results.
value	Zone[]	Information about the DNS zones.

ZoneType

The type of this DNS zone (Public or Private).

Name	Type	Description
Private	string
Public	string

Zones - List

URI Parameters

Responses

Examples

List zones by subscription

Sample Request

Sample Response

Definitions

CloudError

CloudErrorBody

SubResource

Zone

ZoneListResult

ZoneType

Additional resources