你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Zones - Get

Service:

DNS

API Version:

2018-05-01

获取 DNS 区域。 检索区域属性，但检索区域中的记录集。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	指定唯一标识 Microsoft Azure 订阅的 Azure 订阅 ID。
zoneName	path	True	string	DNS 区域的名称 (没有终止点) 。
api-version	query	True	string	指定 API 版本。

响应

名称	类型	说明
200 OK	Zone	成功。
Other Status Codes	CloudError	默认响应。 它将根据错误定义进行反序列化。

示例

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

定义

名称	说明
CloudError	来自服务的错误响应。
CloudErrorBody	来自服务的错误响应。
SubResource	对另一资源的引用
Zone	描述 DNS 区域。
ZoneType	此 DNS 区域的类型 (公共或专用) 。

CloudError

来自服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

来自服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。 例如，属性的名称出错。

SubResource

对另一资源的引用

名称	类型	说明
id	string	资源 ID。

Zone

描述 DNS 区域。

名称	类型	默认值	说明
etag	string		区域的 etag。
id	string		资源 ID。
location	string		资源位置。
name	string		资源名称。
properties.maxNumberOfRecordSets	integer		可在此 DNS 区域中创建的最大记录集数。 这是一个只读属性，任何设置此值的尝试都将被忽略。
properties.maxNumberOfRecordsPerRecordSet	integer		可在此 DNS 区域中创建的每个记录集的最大记录数。 这是一个只读属性，任何设置此值的尝试都将被忽略。
properties.nameServers	string[]		此 DNS 区域的名称服务器。 这是一个只读属性，任何设置此值的尝试都将被忽略。
properties.numberOfRecordSets	integer		此 DNS 区域中的当前记录集数。 这是一个只读属性，任何设置此值的尝试都将被忽略。
properties.registrationVirtualNetworks	SubResource[]		对此 DNS 区域中注册主机名的虚拟网络的引用列表。 仅当 ZoneType 为 Private 时，这才为 。
properties.resolutionVirtualNetworks	SubResource[]		对解析此 DNS 区域中记录的虚拟网络的引用列表。 仅当 ZoneType 为 Private 时，这才为 。
properties.zoneType	ZoneType	Public	此 DNS 区域的类型 (公共或专用) 。
tags	object		资源标记。
type	string		资源类型。

ZoneType

此 DNS 区域的类型 (公共或专用) 。

名称	类型	说明
Private	string
Public	string