Inbound Endpoints - Update

Dienst:

DNS

API-Version:

2025-05-01

Aktualisiert einen eingehenden Endpunkt für einen DNS-Resolver.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}?api-version=2025-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dnsResolverName	path	True	string	Der Name des DNS-Resolvers.
inboundEndpointName	path	True	string	Der Name des eingehenden Endpunkts für den DNS-Resolver.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag der Ressource. Lassen Sie diesen Wert aus, um die aktuelle Ressource immer zu überschreiben. Geben Sie den zuletzt gesehenen ETag-Wert an, um zu verhindern, dass gleichzeitige Änderungen versehentlich überschrieben werden.

Anforderungstext

Name	Typ	Beschreibung
tags	object	Tags für eingehende Endpunkte.

Antworten

Name	Typ	Beschreibung
200 OK	InboundEndpoint	Der eingehende Endpunkt für den DNS-Resolver wurde aktualisiert.
202 Accepted		Der Vorgang zum Aktualisieren des eingehenden Endpunkts für den DNS-Resolver wurde akzeptiert und wird asynchron abgeschlossen.
Other Status Codes	CloudError	Standardantwort. Sie wird gemäß der Fehlerdefinition deserialisiert.

Beispiele

Update inbound endpoint for DNS resolver

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/inboundEndpoints/sampleInboundEndpoint?api-version=2025-05-01

{
  "tags": {
    "key1": "value1"
  }
}

Java

import com.azure.resourcemanager.dnsresolver.models.InboundEndpoint;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for InboundEndpoints Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/InboundEndpoint_Patch.
     * json
     */
    /**
     * Sample code: Update inbound endpoint for DNS resolver.
     * 
     * @param manager Entry point to DnsResolverManager.
     */
    public static void
        updateInboundEndpointForDNSResolver(com.azure.resourcemanager.dnsresolver.DnsResolverManager manager) {
        InboundEndpoint resource = manager.inboundEndpoints().getWithResponse("sampleResourceGroup",
            "sampleDnsResolver", "sampleInboundEndpoint", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("key1", "fakeTokenPlaceholder")).apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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.dnsresolver import DnsResolverManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dnsresolver
# USAGE
    python inbound_endpoint_patch.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 = DnsResolverManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="abdd4249-9f34-4cc6-8e42-c2e32110603e",
    )

    response = client.inbound_endpoints.begin_update(
        resource_group_name="sampleResourceGroup",
        dns_resolver_name="sampleDnsResolver",
        inbound_endpoint_name="sampleInboundEndpoint",
        parameters={"tags": {"key1": "value1"}},
    ).result()
    print(response)


# x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/InboundEndpoint_Patch.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 armdnsresolver_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/dnsresolver/armdnsresolver"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d0d3a9b4fe0fce880fded7a617e71f84406bacbd/specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/InboundEndpoint_Patch.json
func ExampleInboundEndpointsClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdnsresolver.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewInboundEndpointsClient().BeginUpdate(ctx, "sampleResourceGroup", "sampleDnsResolver", "sampleInboundEndpoint", armdnsresolver.InboundEndpointPatch{
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
	}, &armdnsresolver.InboundEndpointsClientBeginUpdateOptions{IfMatch: 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.InboundEndpoint = armdnsresolver.InboundEndpoint{
	// 	Name: to.Ptr("sampleInboundEndpoint"),
	// 	Type: to.Ptr("Microsoft.Network/dnsResolvers/inboundEndpoints"),
	// 	ID: to.Ptr("/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint"),
	// 	SystemData: &armdnsresolver.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T01:01:01.107Z"); return t}()),
	// 		CreatedByType: to.Ptr(armdnsresolver.CreatedByTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-02T02:03:01.197Z"); return t}()),
	// 		LastModifiedByType: to.Ptr(armdnsresolver.CreatedByTypeApplication),
	// 	},
	// 	Location: to.Ptr("westus2"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Etag: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 	Properties: &armdnsresolver.InboundEndpointProperties{
	// 		IPConfigurations: []*armdnsresolver.IPConfiguration{
	// 			{
	// 				PrivateIPAddress: to.Ptr("255.255.255.255"),
	// 				PrivateIPAllocationMethod: to.Ptr(armdnsresolver.IPAllocationMethodDynamic),
	// 				Subnet: &armdnsresolver.SubResource{
	// 					ID: to.Ptr("/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet"),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armdnsresolver.ProvisioningStateSucceeded),
	// 		ResourceGUID: to.Ptr("87b3e20a-5833-4c40-8ad7-c5160bb1c5bd"),
	// 	},
	// }
}

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 { DnsResolverManagementClient } = require("@azure/arm-dnsresolver");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Updates an inbound endpoint for a DNS resolver.
 *
 * @summary Updates an inbound endpoint for a DNS resolver.
 * x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/InboundEndpoint_Patch.json
 */
async function updateInboundEndpointForDnsResolver() {
  const subscriptionId =
    process.env["DNSRESOLVER_SUBSCRIPTION_ID"] || "abdd4249-9f34-4cc6-8e42-c2e32110603e";
  const resourceGroupName = process.env["DNSRESOLVER_RESOURCE_GROUP"] || "sampleResourceGroup";
  const dnsResolverName = "sampleDnsResolver";
  const inboundEndpointName = "sampleInboundEndpoint";
  const parameters = { tags: { key1: "value1" } };
  const credential = new DefaultAzureCredential();
  const client = new DnsResolverManagementClient(credential, subscriptionId);
  const result = await client.inboundEndpoints.beginUpdateAndWait(
    resourceGroupName,
    dnsResolverName,
    inboundEndpointName,
    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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint",
  "name": "sampleInboundEndpoint",
  "type": "Microsoft.Network/dnsResolvers/inboundEndpoints",
  "tags": {
    "key1": "value1"
  },
  "location": "westus2",
  "etag": "00000000-0000-0000-0000-000000000000",
  "systemData": {
    "createdByType": "Application",
    "createdAt": "2021-04-01T01:01:01.1075056Z",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-04-02T02:03:01.1974346Z"
  },
  "properties": {
    "ipConfigurations": [
      {
        "subnet": {
          "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet"
        },
        "privateIpAddress": "255.255.255.255",
        "privateIpAllocationMethod": "Dynamic"
      }
    ],
    "provisioningState": "Succeeded",
    "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd"
  }
}

Statuscode:

202

Location: https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2025-05-01
Azure-AsyncOperation: https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2025-05-01

Definitionen

Name	Beschreibung
CloudError	Fehlermeldung
CloudErrorBody	Der Textkörper einer Fehlermeldung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
InboundEndpoint	Beschreibt einen eingehenden Endpunkt für einen DNS-Resolver.
InboundEndpointPatch	Beschreibt einen eingehenden Endpunkt für einen DNS-Resolver für PATCH-Vorgänge.
IpAllocationMethod	Private IP-Adresszuweisungsmethode.
IpConfiguration	IP-Konfiguration.
ProvisioningState	Der aktuelle Bereitstellungsstatus der Ressource.
SubResource	Verweisen Sie auf eine andere ARM-Ressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudError

Objekt

Fehlermeldung

Name	Typ	Beschreibung
error	CloudErrorBody	Der Textkörper der Fehlermeldung

CloudErrorBody

Objekt

Der Textkörper einer Fehlermeldung

Name	Typ	Beschreibung
code	string	Der Fehlercode
details	CloudErrorBody[]	Zusätzliche Fehlerinformationen
message	string	Eine Beschreibung, was den Fehler verursacht hat
target	string	Die Zielressource der Fehlermeldung

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

InboundEndpoint

Objekt

Beschreibt einen eingehenden Endpunkt für einen DNS-Resolver.

Name	Typ	Beschreibung
etag	string	ETag des eingehenden Endpunkts.
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.ipConfigurations	IpConfiguration[]	IP-Konfigurationen für den eingehenden Endpunkt.
properties.provisioningState	ProvisioningState	Der aktuelle Bereitstellungsstatus des eingehenden Endpunkts. Dies ist eine schreibgeschützte Eigenschaft, und jeder Versuch, diesen Wert festzulegen, wird ignoriert.
properties.resourceGuid	string	Die resourceGuid-Eigenschaft der eingehenden Endpunktressource.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

InboundEndpointPatch

Objekt

Beschreibt einen eingehenden Endpunkt für einen DNS-Resolver für PATCH-Vorgänge.

Name	Typ	Beschreibung
tags	object	Tags für eingehende Endpunkte.

IpAllocationMethod

Enumeration

Private IP-Adresszuweisungsmethode.

Wert	Beschreibung
Dynamic
Static

IpConfiguration

Objekt

IP-Konfiguration.

Name	Typ	Standardwert	Beschreibung
privateIpAddress	string		Private IP-Adresse der IP-Konfiguration
privateIpAllocationMethod	IpAllocationMethod	Dynamic	Private IP-Adresszuweisungsmethode.
subnet	SubResource		Der Verweis auf das Subnetz, das an die IP-Konfiguration gebunden ist.

ProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

SubResource

Objekt

Verweisen Sie auf eine andere ARM-Ressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.