Dns Forwarding Rulesets - List By Virtual Network

Dienst:

DNS

API-Version:

2025-05-01

Listet DNS-Weiterleitungsregelnet-Ressourcen-IDs auf, die an ein virtuelles Netzwerk angefügt sind.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsForwardingRulesets?api-version=2025-05-01

Mit optionalen Parametern:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsForwardingRulesets?api-version=2025-05-01&$top={$top}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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.
virtualNetworkName	path	True	string	Den Namen des virtuellen Netzwerks.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$top	query		integer (int32)	Die maximale Anzahl der zurückzugebenden Ergebnisse. Wenn nicht angegeben, werden bis zu 100 Ergebnisse zurückgegeben.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualNetworkDnsForwardingRulesetListResult	Liste der Ressourcen-IDs für DNS-Weiterleitungsregelsätze und der Ressourcen-IDs für VNET-Verknüpfungen, die an das virtuelle Netzwerk angefügt sind.
Other Status Codes	CloudError	Standardantwort. Sie wird gemäß der Fehlerdefinition deserialisiert.

Beispiele

List DNS forwarding rulesets by virtual network

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/listDnsForwardingRulesets?api-version=2025-05-01

Java

/**
 * Samples for DnsForwardingRulesets ListByVirtualNetwork.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/
     * DnsForwardingRuleset_ListByVirtualNetwork.json
     */
    /**
     * Sample code: List DNS forwarding rulesets by virtual network.
     * 
     * @param manager Entry point to DnsResolverManager.
     */
    public static void
        listDNSForwardingRulesetsByVirtualNetwork(com.azure.resourcemanager.dnsresolver.DnsResolverManager manager) {
        manager.dnsForwardingRulesets().listByVirtualNetwork("sampleResourceGroup", "sampleVirtualNetwork", null,
            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.dnsresolver import DnsResolverManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dnsresolver
# USAGE
    python dns_forwarding_ruleset_list_by_virtual_network.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.dns_forwarding_rulesets.list_by_virtual_network(
        resource_group_name="sampleResourceGroup",
        virtual_network_name="sampleVirtualNetwork",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/DnsForwardingRuleset_ListByVirtualNetwork.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/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/DnsForwardingRuleset_ListByVirtualNetwork.json
func ExampleDNSForwardingRulesetsClient_NewListByVirtualNetworkPager() {
	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)
	}
	pager := clientFactory.NewDNSForwardingRulesetsClient().NewListByVirtualNetworkPager("sampleResourceGroup", "sampleVirtualNetwork", &armdnsresolver.DNSForwardingRulesetsClientListByVirtualNetworkOptions{Top: 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.VirtualNetworkDNSForwardingRulesetListResult = armdnsresolver.VirtualNetworkDNSForwardingRulesetListResult{
		// 	Value: []*armdnsresolver.VirtualNetworkDNSForwardingRuleset{
		// 		{
		// 			ID: to.Ptr("/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset"),
		// 			Properties: &armdnsresolver.VirtualNetworkLinkSubResourceProperties{
		// 				VirtualNetworkLink: &armdnsresolver.SubResource{
		// 					ID: to.Ptr("/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 Lists DNS forwarding ruleset resource IDs attached to a virtual network.
 *
 * @summary Lists DNS forwarding ruleset resource IDs attached to a virtual network.
 * x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/DnsForwardingRuleset_ListByVirtualNetwork.json
 */
async function listDnsForwardingRulesetsByVirtualNetwork() {
  const subscriptionId =
    process.env["DNSRESOLVER_SUBSCRIPTION_ID"] || "abdd4249-9f34-4cc6-8e42-c2e32110603e";
  const resourceGroupName = process.env["DNSRESOLVER_RESOURCE_GROUP"] || "sampleResourceGroup";
  const virtualNetworkName = "sampleVirtualNetwork";
  const credential = new DefaultAzureCredential();
  const client = new DnsResolverManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.dnsForwardingRulesets.listByVirtualNetwork(
    resourceGroupName,
    virtualNetworkName,
  )) {
    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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset",
      "properties": {
        "virtualNetworkLink": {
          "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink"
        }
      }
    }
  ],
  "nextLink": null
}

Definitionen

Name	Beschreibung
CloudError	Fehlermeldung
CloudErrorBody	Der Textkörper einer Fehlermeldung
SubResource	Verweisen Sie auf eine andere ARM-Ressource.
VirtualNetworkDnsForwardingRuleset	Verweis auf DNS-Weiterleitungsregelnet und zugeordnete virtuelle Netzwerkverknüpfung.
VirtualNetworkDnsForwardingRulesetListResult	Die Antwort auf einen Enumerationsvorgang im Dns-Weiterleitungsregelnet des virtuellen Netzwerks.

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

SubResource

Objekt

Verweisen Sie auf eine andere ARM-Ressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.

VirtualNetworkDnsForwardingRuleset

Objekt

Verweis auf DNS-Weiterleitungsregelnet und zugeordnete virtuelle Netzwerkverknüpfung.

Name	Typ	Beschreibung
id	string	DNS Forwarding Ruleset-Ressourcen-ID.
properties.virtualNetworkLink	SubResource	Der Verweis auf die virtuelle Netzwerkverbindung.

VirtualNetworkDnsForwardingRulesetListResult

Objekt

Die Antwort auf einen Enumerationsvorgang im Dns-Weiterleitungsregelnet des virtuellen Netzwerks.

Name	Typ	Beschreibung
nextLink	string	Das Fortsetzungstoken für die nächste Seite der Ergebnisse.
value	VirtualNetworkDnsForwardingRuleset[]	Aufzählung des DNS-Weiterleitungsregelnet für virtuelle Netzwerke.