Private Dns Zone Groups - Create Or Update

Reference

Service:: Virtual Networks

API Version:: 2024-03-01

Creates or updates a private dns zone group in the specified private endpoint.

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

URI Parameters

Name	In	Required	Type	Description
privateDnsZoneGroupName	path	True	string	The name of the private dns zone group.
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.

Request Body

Name	Type	Description
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.

Responses

Name	Type	Description
200 OK	PrivateDnsZoneGroup	Update successful. The operation returns the resulting PrivateDnsZoneGroup resource.
201 Created	PrivateDnsZoneGroup	Create successful. The operation returns the resulting PrivateDnsZoneGroup resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

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

Create private dns zone group

Sample request

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

{
  "properties": {
    "privateDnsZoneConfigs": [
      {
        "properties": {
          "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com"
        }
      }
    ]
  }
}


import com.azure.resourcemanager.network.fluent.models.PrivateDnsZoneGroupInner;
import com.azure.resourcemanager.network.models.PrivateDnsZoneConfig;
import java.util.Arrays;

/**
 * Samples for PrivateDnsZoneGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/
     * PrivateEndpointDnsZoneGroupCreate.json
     */
    /**
     * Sample code: Create private dns zone group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createPrivateDnsZoneGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPrivateDnsZoneGroups()
            .createOrUpdate("rg1", "testPe", "testPdnsgroup", new PrivateDnsZoneGroupInner()
                .withPrivateDnsZoneConfigs(Arrays.asList(new PrivateDnsZoneConfig().withPrivateDnsZoneId(
                    "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com"))),
                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.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python private_endpoint_dns_zone_group_create.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.begin_create_or_update(
        resource_group_name="rg1",
        private_endpoint_name="testPe",
        private_dns_zone_group_name="testPdnsgroup",
        parameters={
            "properties": {
                "privateDnsZoneConfigs": [
                    {
                        "properties": {
                            "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com"
                        }
                    }
                ]
            }
        },
    ).result()
    print(response)


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

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/PrivateEndpointDnsZoneGroupCreate.json
func ExamplePrivateDNSZoneGroupsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewPrivateDNSZoneGroupsClient().BeginCreateOrUpdate(ctx, "rg1", "testPe", "testPdnsgroup", armnetwork.PrivateDNSZoneGroup{
		Properties: &armnetwork.PrivateDNSZoneGroupPropertiesFormat{
			PrivateDNSZoneConfigs: []*armnetwork.PrivateDNSZoneConfig{
				{
					Properties: &armnetwork.PrivateDNSZonePropertiesFormat{
						PrivateDNSZoneID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com"),
					},
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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"),
	// 							}},
	// 						},
	// 				}},
	// 				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

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a private dns zone group in the specified private endpoint.
 *
 * @summary Creates or updates a private dns zone group in the specified private endpoint.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/PrivateEndpointDnsZoneGroupCreate.json
 */
async function createPrivateDnsZoneGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const privateEndpointName = "testPe";
  const privateDnsZoneGroupName = "testPdnsgroup";
  const parameters = {
    privateDnsZoneConfigs: [
      {
        privateDnsZoneId:
          "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.privateDnsZoneGroups.beginCreateOrUpdateAndWait(
    resourceGroupName,
    privateEndpointName,
    privateDnsZoneGroupName,
    parameters,
  );
  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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/PrivateEndpointDnsZoneGroupCreate.json
// this example is just showing the usage of "PrivateDnsZoneGroups_CreateOrUpdate" 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 PrivateDnsZoneGroupResource created on azure
// for more information of creating PrivateDnsZoneGroupResource, please refer to the document of PrivateDnsZoneGroupResource
string subscriptionId = "subId";
string resourceGroupName = "rg1";
string privateEndpointName = "testPe";
string privateDnsZoneGroupName = "testPdnsgroup";
ResourceIdentifier privateDnsZoneGroupResourceId = PrivateDnsZoneGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, privateEndpointName, privateDnsZoneGroupName);
PrivateDnsZoneGroupResource privateDnsZoneGroup = client.GetPrivateDnsZoneGroupResource(privateDnsZoneGroupResourceId);

// invoke the operation
PrivateDnsZoneGroupData data = new PrivateDnsZoneGroupData()
{
    PrivateDnsZoneConfigs =
    {
    new PrivateDnsZoneConfig()
    {
    PrivateDnsZoneId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com",
    }
    },
};
ArmOperation<PrivateDnsZoneGroupResource> lro = await privateDnsZoneGroup.UpdateAsync(WaitUntil.Completed, data);
PrivateDnsZoneGroupResource result = lro.Value;

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

Status code:: 201

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

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
PrivateDnsZoneConfig	PrivateDnsZoneConfig resource.
PrivateDnsZoneGroup	Private dns zone group resource.
ProvisioningState	The current provisioning state.
RecordSet	A collective group of information about the record set information.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

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.

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.