Zones - Get

Service:

DNS

API Version:

2018-05-01

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
zoneName	path	True	string	The name of the DNS zone (without a terminating dot).
api-version	query	True	string	Specifies the API version.

Responses

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

Examples

Get zone

Sample request

HTTP

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

Java

/**
 * Samples for Zones GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/GetZone.json
     */
    /**
     * Sample code: Get zone.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getZone(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.dnsZones().manager().serviceClient().getZones().getByResourceGroupWithResponse("rg1", "zone1",
            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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dns
# USAGE
    python get_zone.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.get(
        resource_group_name="rg1",
        zone_name="zone1",
    )
    print(response)


# x-ms-original-file: specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/GetZone.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

Go

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/GetZone.json
func ExampleZonesClient_Get() {
	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)
	}
	res, err := clientFactory.NewZonesClient().Get(ctx, "rg1", "zone1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Zone = 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),
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
 *
 * @summary Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
 * x-ms-original-file: specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/GetZone.json
 */
async function getZone() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const zoneName = "zone1";
  const credential = new DefaultAzureCredential();
  const client = new DnsManagementClient(credential, subscriptionId);
  const result = await client.zones.get(resourceGroupName, zoneName);
  console.log(result);
}

getZone().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

{
  "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"
  }
}

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

ZoneType

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

Name	Type	Description
Private	string
Public	string