Private Dns Zone Groups - List

Service:

Virtual Networks

API Version:

2023-09-01

プライベート エンドポイント内のすべてのプライベート DNS ゾーン グループを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups?api-version=2023-09-01

URI パラメーター

名前	/	必須	型	説明
privateEndpointName	path	True	string	プライベート エンドポイントの名前。
resourceGroupName	path	True	string	リソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプションの資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API バージョン。

応答

名前	型	説明
200 OK	PrivateDnsZoneGroupListResult	要求が成功しました。 この操作は、プライベート DNS ゾーン グループ リソースの一覧を返します。
Other Status Codes	Error	エラー。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

List private endpoints in resource group

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/privateDnsZoneGroups?api-version=2023-09-01

Java

/**
 * Samples for PrivateDnsZoneGroups List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * PrivateEndpointDnsZoneGroupList.json
     */
    /**
     * Sample code: List private endpoints in resource group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listPrivateEndpointsInResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPrivateDnsZoneGroups().list("testPe", "rg1",
            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.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python private_endpoint_dns_zone_group_list.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 = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subId",
    )

    response = client.private_dns_zone_groups.list(
        private_endpoint_name="testPe",
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateEndpointDnsZoneGroupList.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 armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateEndpointDnsZoneGroupList.json
func ExamplePrivateDNSZoneGroupsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateDNSZoneGroupsClient().NewListPager("testPe", "rg1", 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.PrivateDNSZoneGroupListResult = armnetwork.PrivateDNSZoneGroupListResult{
		// 	Value: []*armnetwork.PrivateDNSZoneGroup{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup1"),
		// 			Name: to.Ptr("testPdnsgroup1"),
		// 			Properties: &armnetwork.PrivateDNSZoneGroupPropertiesFormat{
		// 				PrivateDNSZoneConfigs: []*armnetwork.PrivateDNSZoneConfig{
		// 					{
		// 						Properties: &armnetwork.PrivateDNSZonePropertiesFormat{
		// 							PrivateDNSZoneID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com"),
		// 							RecordSets: []*armnetwork.RecordSet{
		// 								{
		// 									Fqdn: to.Ptr("abc.zone1.com"),
		// 									IPAddresses: []*string{
		// 										to.Ptr("10.0.0.4")},
		// 										RecordSetName: to.Ptr("abc"),
		// 										RecordType: to.Ptr("A"),
		// 									},
		// 									{
		// 										Fqdn: to.Ptr("abc2.zone1.com"),
		// 										IPAddresses: []*string{
		// 											to.Ptr("10.0.0.5")},
		// 											RecordSetName: to.Ptr("abc2"),
		// 											RecordType: to.Ptr("A"),
		// 									}},
		// 								},
		// 						}},
		// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 					},
		// 				},
		// 				{
		// 					ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup2"),
		// 					Name: to.Ptr("testPdnsgroup2"),
		// 					Properties: &armnetwork.PrivateDNSZoneGroupPropertiesFormat{
		// 						PrivateDNSZoneConfigs: []*armnetwork.PrivateDNSZoneConfig{
		// 							{
		// 								Properties: &armnetwork.PrivateDNSZonePropertiesFormat{
		// 									PrivateDNSZoneID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com"),
		// 									RecordSets: []*armnetwork.RecordSet{
		// 										{
		// 											Fqdn: to.Ptr("abc3.zone2.com"),
		// 											IPAddresses: []*string{
		// 												to.Ptr("10.0.0.6")},
		// 												RecordSetName: to.Ptr("abc3"),
		// 												RecordType: to.Ptr("A"),
		// 											},
		// 											{
		// 												Fqdn: to.Ptr("abc4.zone2.com"),
		// 												IPAddresses: []*string{
		// 													to.Ptr("10.0.0.7")},
		// 													RecordSetName: to.Ptr("abc4"),
		// 													RecordType: to.Ptr("A"),
		// 											}},
		// 										},
		// 								}},
		// 								ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 							},
		// 					}},
		// 				}
	}
}

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 { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all private dns zone groups in a private endpoint.
 *
 * @summary Gets all private dns zone groups in a private endpoint.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateEndpointDnsZoneGroupList.json
 */
async function listPrivateEndpointsInResourceGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const privateEndpointName = "testPe";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateDnsZoneGroups.list(privateEndpointName, resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateEndpointDnsZoneGroupList.json
// this example is just showing the usage of "PrivateDnsZoneGroups_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this PrivateEndpointResource created on azure
// for more information of creating PrivateEndpointResource, please refer to the document of PrivateEndpointResource
string subscriptionId = "subId";
string resourceGroupName = "rg1";
string privateEndpointName = "testPe";
ResourceIdentifier privateEndpointResourceId = PrivateEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, privateEndpointName);
PrivateEndpointResource privateEndpoint = client.GetPrivateEndpointResource(privateEndpointResourceId);

// get the collection of this PrivateDnsZoneGroupResource
PrivateDnsZoneGroupCollection collection = privateEndpoint.GetPrivateDnsZoneGroups();

// invoke the operation and iterate over the result
await foreach (PrivateDnsZoneGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    PrivateDnsZoneGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "name": "testPdnsgroup1",
      "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup1",
      "properties": {
        "provisioningState": "Succeeded",
        "privateDnsZoneConfigs": [
          {
            "properties": {
              "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com",
              "recordSets": [
                {
                  "recordType": "A",
                  "recordSetName": "abc",
                  "fqdn": "abc.zone1.com",
                  "ipAddresses": [
                    "10.0.0.4"
                  ]
                },
                {
                  "recordType": "A",
                  "recordSetName": "abc2",
                  "fqdn": "abc2.zone1.com",
                  "ipAddresses": [
                    "10.0.0.5"
                  ]
                }
              ]
            }
          }
        ]
      }
    },
    {
      "name": "testPdnsgroup2",
      "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup2",
      "properties": {
        "provisioningState": "Succeeded",
        "privateDnsZoneConfigs": [
          {
            "properties": {
              "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com",
              "recordSets": [
                {
                  "recordType": "A",
                  "recordSetName": "abc3",
                  "fqdn": "abc3.zone2.com",
                  "ipAddresses": [
                    "10.0.0.6"
                  ]
                },
                {
                  "recordType": "A",
                  "recordSetName": "abc4",
                  "fqdn": "abc4.zone2.com",
                  "ipAddresses": [
                    "10.0.0.7"
                  ]
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

定義

名前	説明
Error	一般的なエラー表現。
ErrorDetails	一般的なエラーの詳細表現。
PrivateDnsZoneConfig	PrivateDnsZoneConfig リソース。
PrivateDnsZoneGroup	プライベート DNS ゾーン グループ リソース。
PrivateDnsZoneGroupListResult	ListPrivateDnsZoneGroups API サービス呼び出しの応答。
ProvisioningState	現在のプロビジョニング状態。
RecordSet	レコード・セット情報に関する情報の集合グループ。

Error

一般的なエラー表現。

名前	型	説明
code	string	エラー コード。
details	ErrorDetails[]	エラーの詳細。
innerError	string	内部エラー メッセージ。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorDetails

一般的なエラーの詳細表現。

名前	型	説明
code	string	エラー コード。
message	string	エラー メッセージ。
target	string	エラーターゲット。

PrivateDnsZoneConfig

PrivateDnsZoneConfig リソース。

名前	型	説明
name	string	リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。
properties.privateDnsZoneId	string	プライベート DNS ゾーンのリソース ID。
properties.recordSets	RecordSet[]	プライベート リソースを識別するための情報を保持する recordSet に関する情報のコレクション。

PrivateDnsZoneGroup

プライベート DNS ゾーン グループ リソース。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソースの ID
name	string	リソース グループ内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。
properties.privateDnsZoneConfigs	PrivateDnsZoneConfig[]	プライベート DNS ゾーン グループのプライベート DNS ゾーン構成のコレクション。
properties.provisioningState	ProvisioningState	プライベート DNS ゾーン グループ リソースのプロビジョニング状態。

PrivateDnsZoneGroupListResult

ListPrivateDnsZoneGroups API サービス呼び出しの応答。

名前	型	説明
nextLink	string	次の結果セットを取得する URL。
value	PrivateDnsZoneGroup[]	プライベート エンドポイント内のプライベート DNS ゾーン グループ リソースの一覧。

ProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Deleting	string
Failed	string
Succeeded	string
Updating	string

RecordSet

レコード・セット情報に関する情報の集合グループ。

名前	型	説明
fqdn	string	プライベート エンドポイントの IP アドレスに解決される Fqdn。
ipAddresses	string[]	プライベート エンドポイントのプライベート IP アドレス。
provisioningState	ProvisioningState	レコードセットのプロビジョニング状態。
recordSetName	string	レコードセット名。
recordType	string	リソース レコードの種類。
ttl	integer	レコードセットの有効期間。