Private Dns Zone Groups - Get

Service:

Virtual Networks

API Version:

2023-09-01

Obtém o recurso de grupo de zona dns privado pelo nome do grupo de zona dns privado especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
privateDnsZoneGroupName	path	True	string	O nome do grupo de zona dns privado.
privateEndpointName	path	True	string	O nome do ponto de extremidade privado.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão de API do cliente.

Respostas

Nome	Tipo	Description
200 OK	PrivateDnsZoneGroup	Solicitação bem-sucedida. A operação retorna o recurso privateDnsZoneGroup resultante.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get private dns zone group

Sample Request

HTTP

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

Java

/**
 * Samples for PrivateDnsZoneGroups Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * PrivateEndpointDnsZoneGroupGet.json
     */
    /**
     * Sample code: Get private dns zone group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getPrivateDnsZoneGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPrivateDnsZoneGroups().getWithResponse("rg1", "testPe",
            "testPdnsgroup", 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_get.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.get(
        resource_group_name="rg1",
        private_endpoint_name="testPe",
        private_dns_zone_group_name="testPdnsgroup",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateEndpointDnsZoneGroupGet.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/PrivateEndpointDnsZoneGroupGet.json
func ExamplePrivateDNSZoneGroupsClient_Get() {
	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)
	}
	res, err := clientFactory.NewPrivateDNSZoneGroupsClient().Get(ctx, "rg1", "testPe", "testPdnsgroup", 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.PrivateDNSZoneGroup = armnetwork.PrivateDNSZoneGroup{
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup"),
	// 	Name: to.Ptr("testPdnsgroup"),
	// 	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"),
	// 							}},
	// 						},
	// 					},
	// 					{
	// 						Properties: &armnetwork.PrivateDNSZonePropertiesFormat{
	// 							PrivateDNSZoneID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com"),
	// 							RecordSets: []*armnetwork.RecordSet{
	// 								{
	// 									Fqdn: to.Ptr("abc.zone2.com"),
	// 									IPAddresses: []*string{
	// 										to.Ptr("10.0.0.6")},
	// 										RecordSetName: to.Ptr("abc"),
	// 										RecordType: to.Ptr("A"),
	// 									},
	// 									{
	// 										Fqdn: to.Ptr("abc2.zone2.com"),
	// 										IPAddresses: []*string{
	// 											to.Ptr("10.0.0.7")},
	// 											RecordSetName: to.Ptr("abc2"),
	// 											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 the private dns zone group resource by specified private dns zone group name.
 *
 * @summary Gets the private dns zone group resource by specified private dns zone group name.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateEndpointDnsZoneGroupGet.json
 */
async function getPrivateDnsZoneGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const privateEndpointName = "testPe";
  const privateDnsZoneGroupName = "testPdnsgroup";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.privateDnsZoneGroups.get(
    resourceGroupName,
    privateEndpointName,
    privateDnsZoneGroupName,
  );
  console.log(result);
}

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/PrivateEndpointDnsZoneGroupGet.json
// this example is just showing the usage of "PrivateDnsZoneGroups_Get" 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
string privateDnsZoneGroupName = "testPdnsgroup";
NullableResponse<PrivateDnsZoneGroupResource> response = await collection.GetIfExistsAsync(privateDnsZoneGroupName);
PrivateDnsZoneGroupResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

{
  "name": "testPdnsgroup",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup",
  "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"
              ]
            }
          ]
        }
      },
      {
        "properties": {
          "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com",
          "recordSets": [
            {
              "recordType": "A",
              "recordSetName": "abc",
              "fqdn": "abc.zone2.com",
              "ipAddresses": [
                "10.0.0.6"
              ]
            },
            {
              "recordType": "A",
              "recordSetName": "abc2",
              "fqdn": "abc2.zone2.com",
              "ipAddresses": [
                "10.0.0.7"
              ]
            }
          ]
        }
      }
    ]
  }
}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
PrivateDnsZoneConfig	Recurso PrivateDnsZoneConfig.
PrivateDnsZoneGroup	Recurso de grupo de zona dns privado.
ProvisioningState	O estado de provisionamento atual.
RecordSet	Um grupo coletivo de informações sobre as informações do conjunto de registros.

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

PrivateDnsZoneConfig

Recurso PrivateDnsZoneConfig.

Nome	Tipo	Description
name	string	Nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.privateDnsZoneId	string	A ID do recurso da zona dns privada.
properties.recordSets	RecordSet[]	Uma coleção de informações sobre um recordSet, que contém informações para identificar recursos privados.

PrivateDnsZoneGroup

Recurso de grupo de zona dns privado.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	Nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.privateDnsZoneConfigs	PrivateDnsZoneConfig[]	Uma coleção de configurações de zona dns privada do grupo de zona dns privado.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de grupo de zona dns privado.

ProvisioningState

O estado de provisionamento atual.

Nome	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RecordSet

Um grupo coletivo de informações sobre as informações do conjunto de registros.

Nome	Tipo	Description
fqdn	string	Fqdn que resolve para o endereço ip do ponto de extremidade privado.
ipAddresses	string[]	O endereço IP privado do ponto de extremidade privado.
provisioningState	ProvisioningState	O estado de provisionamento do conjunto de registros.
recordSetName	string	Nome do conjunto de registros.
recordType	string	Tipo de registro de recurso.
ttl	integer	Tempo de vida do conjunto de registros.