Private Dns Zone Groups - Create Or Update

Referencia

Service:: Virtual Networks

API Version:: 2023-09-01

Privát DNS-zónacsoportot hoz létre vagy frissít a megadott privát végponton.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
privateDnsZoneGroupName	path	True	string	A privát DNS-zónacsoport neve.
privateEndpointName	path	True	string	A privát végpont neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Az erőforráscsoporton belül egyedi erőforrás neve. Ez a név használható az erőforrás eléréséhez.
properties.privateDnsZoneConfigs	PrivateDnsZoneConfig[]	A privát DNS-zónacsoport privát DNS-zónakonfigurációinak gyűjteménye.

Válaszok

Name	Típus	Description
200 OK	PrivateDnsZoneGroup	A frissítés sikeres volt. A művelet az eredményül kapott PrivateDnsZoneGroup erőforrást adja vissza.
201 Created	PrivateDnsZoneGroup	Sikeres létrehozás. A művelet az eredményül kapott PrivateDnsZoneGroup erőforrást adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

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=2023-09-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/2023-09-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/2023-09-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/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/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/2023-09-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 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/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 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";
PrivateDnsZoneGroupData data = new PrivateDnsZoneGroupData()
{
    PrivateDnsZoneConfigs =
    {
    new PrivateDnsZoneConfig()
    {
    PrivateDnsZoneId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com",
    }
    },
};
ArmOperation<PrivateDnsZoneGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, privateDnsZoneGroupName, 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"
              ]
            }
          ]
        }
      }
    ]
  }
}

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
PrivateDnsZoneConfig	PrivateDnsZoneConfig erőforrás.
PrivateDnsZoneGroup	Privát DNS-zónacsoport erőforrása.
ProvisioningState	Az aktuális kiépítési állapot.
RecordSet	A rekordhalmaz adatainak együttes csoportja.

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőbeli hibatörzs.

CloudErrorBody

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a hibás tulajdonság neve.

PrivateDnsZoneConfig

PrivateDnsZoneConfig erőforrás.

Name	Típus	Description
name	string	Az erőforráscsoporton belül egyedi erőforrás neve. Ez a név használható az erőforrás eléréséhez.
properties.privateDnsZoneId	string	A privát DNS-zóna erőforrás-azonosítója.
properties.recordSets	RecordSet[]	Egy rekordhalmazra vonatkozó információk gyűjteménye, amely a magánerőforrások azonosítására szolgál.

PrivateDnsZoneGroup

Privát DNS-zónacsoport erőforrása.

Name	Típus	Description
etag	string	Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string	Erőforrás-azonosító.
name	string	Az erőforráscsoporton belül egyedi erőforrás neve. Ez a név használható az erőforrás eléréséhez.
properties.privateDnsZoneConfigs	PrivateDnsZoneConfig[]	A privát DNS-zónacsoport privát DNS-zónakonfigurációinak gyűjteménye.
properties.provisioningState	ProvisioningState	A privát DNS-zónacsoport-erőforrás kiépítési állapota.

ProvisioningState

Az aktuális kiépítési állapot.

Name	Típus	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RecordSet

A rekordhalmaz adatainak együttes csoportja.

Name	Típus	Description
fqdn	string	A privát végpont IP-címére feloldott teljes tartománynév.
ipAddresses	string[]	A privát végpont magánhálózati IP-címe.
provisioningState	ProvisioningState	A rekordhalmaz kiépítési állapota.
recordSetName	string	Rekordhalmaz neve.
recordType	string	Erőforrásrekord típusa.
ttl	integer	Az élettartam rekordhalmaza.