Private Dns Zone Groups - List

Service:

Virtual Networks

API Version:

2023-09-01

Gets all private dns zone groups in a private endpoint.

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

URI Parameters

Name	In	Required	Type	Description
privateEndpointName	path	True	string	The name of the private endpoint.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	PrivateDnsZoneGroupListResult	Request successful. The operation returns a list of private dns zone group resources.
Other Status Codes	Error	Error.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

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

Definitions

Name	Description
Error	Common error representation.
ErrorDetails	Common error details representation.
PrivateDnsZoneConfig	PrivateDnsZoneConfig resource.
PrivateDnsZoneGroup	Private dns zone group resource.
PrivateDnsZoneGroupListResult	Response for the ListPrivateDnsZoneGroups API service call.
ProvisioningState	The current provisioning state.
RecordSet	A collective group of information about the record set information.

Error

Common error representation.

Name	Type	Description
code	string	Error code.
details	ErrorDetails[]	Error details.
innerError	string	Inner error message.
message	string	Error message.
target	string	Error target.

ErrorDetails

Common error details representation.

Name	Type	Description
code	string	Error code.
message	string	Error message.
target	string	Error target.

PrivateDnsZoneConfig

PrivateDnsZoneConfig resource.

Name	Type	Description
name	string	Name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.privateDnsZoneId	string	The resource id of the private dns zone.
properties.recordSets	RecordSet[]	A collection of information regarding a recordSet, holding information to identify private resources.

PrivateDnsZoneGroup

Private dns zone group resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.privateDnsZoneConfigs	PrivateDnsZoneConfig[]	A collection of private dns zone configurations of the private dns zone group.
properties.provisioningState	ProvisioningState	The provisioning state of the private dns zone group resource.

PrivateDnsZoneGroupListResult

Response for the ListPrivateDnsZoneGroups API service call.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	PrivateDnsZoneGroup[]	A list of private dns zone group resources in a private endpoint.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RecordSet

A collective group of information about the record set information.

Name	Type	Description
fqdn	string	Fqdn that resolves to private endpoint ip address.
ipAddresses	string[]	The private ip address of the private endpoint.
provisioningState	ProvisioningState	The provisioning state of the recordset.
recordSetName	string	Recordset name.
recordType	string	Resource record type.
ttl	integer	Recordset time to live.