Zones - List

リファレンス

Service:: DNS

API Version:: 2018-05-01

サブスクリプション内のすべてのリソースグループ内の DNS ゾーンをListsします。

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 パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別する Azure サブスクリプション ID を指定します。
api-version	query	True	string	API バージョンを指定します。
$top	query		integer int32	返される DNS ゾーンの最大数。指定しない場合は、最大 100 個のゾーンを返します。

応答

名前	型	説明
200 OK	ZoneListResult	正常終了しました。
Other Status Codes	CloudError	既定の応答。エラー定義に従って逆シリアル化されます。

例

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

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
SubResource	別のリソースへの参照
Zone	DNS ゾーンについて説明します。
ZoneListResult	ゾーンリストまたは ListAll 操作への応答。
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		リソースの種類。

ZoneListResult

ゾーンリストまたは ListAll 操作への応答。

名前	型	説明
nextLink	string	結果の次のページの継続トークン。
value	Zone[]	DNS ゾーンに関する情報。

ZoneType

この DNS ゾーンの種類 (パブリックまたはプライベート)。

名前	型	説明
Private	string
Public	string

Share via

Zones - List

URI パラメーター

応答

例

List zones by subscription

Sample Request

Sample Response

定義

CloudError

CloudErrorBody

SubResource

Zone

ZoneListResult

ZoneType

その他のリソース