Dns Forwarding Rulesets - List

Service:

DNS

API Version:

2020-04-01-preview

Elenchi set di regole di inoltro DNS in tutti i gruppi di risorse di una sottoscrizione.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets?api-version=2020-04-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets?api-version=2020-04-01-preview&$top={$top}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$top	query		integer int32	Il numero massimo di risultati da restituire. Se non specificato, restituisce fino a 100 risultati.

Risposte

Nome	Tipo	Descrizione
200 OK	DnsForwardingRulesetListResult	Elenco di set di regole di inoltro DNS nella sottoscrizione.
Other Status Codes	CloudError	Risposta predefinita. Verrà deserializzato in base alla definizione errore.

Esempio

List DNS forwarding rulesets by subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsForwardingRulesets?api-version=2020-04-01-preview

Java

import com.azure.core.util.Context;

/** Samples for DnsForwardingRulesets List. */
public final class Main {
    /*
     * x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json
     */
    /**
     * Sample code: List DNS forwarding rulesets by subscription.
     *
     * @param manager Entry point to DnsResolverManager.
     */
    public static void listDNSForwardingRulesetsBySubscription(
        com.azure.resourcemanager.dnsresolver.DnsResolverManager manager) {
        manager.dnsForwardingRulesets().list(null, 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

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/tree/main/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json
func ExampleDNSForwardingRulesetsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdnsresolver.NewDNSForwardingRulesetsClient("abdd4249-9f34-4cc6-8e42-c2e32110603e", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(&armdnsresolver.DNSForwardingRulesetsClientListOptions{Top: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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");

/**
 * This sample demonstrates how to Lists DNS forwarding rulesets in all resource groups of a subscription.
 *
 * @summary Lists DNS forwarding rulesets in all resource groups of a subscription.
 * x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/preview/2020-04-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json
 */
async function listDnsForwardingRulesetsBySubscription() {
  const subscriptionId = "abdd4249-9f34-4cc6-8e42-c2e32110603e";
  const credential = new DefaultAzureCredential();
  const client = new DnsResolverManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.dnsForwardingRulesets.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

listDnsForwardingRulesetsBySubscription().catch(console.error);

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

{
  "value": [
    {
      "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset",
      "name": "sampleDnsForwardingRuleset",
      "type": "Microsoft.Network/dnsForwardingRulesets",
      "tags": {
        "key1": "value1"
      },
      "systemData": {
        "createdByType": "Application",
        "createdAt": "2021-04-03T01:01:01.1075056Z",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2021-04-04T02:03:01.1974346Z"
      },
      "location": "westus2",
      "etag": "00000000-0000-0000-0000-000000000000",
      "properties": {
        "dnsResolverOutboundEndpoints": [
          {
            "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0"
          },
          {
            "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1"
          }
        ],
        "provisioningState": "Succeeded",
        "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8"
      }
    },
    {
      "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset1",
      "name": "sampleDnsForwardingRuleset",
      "type": "Microsoft.Network/dnsForwardingRulesets",
      "tags": {
        "key1": "value1"
      },
      "systemData": {
        "createdByType": "Application",
        "createdAt": "2021-04-04T01:01:01.1075056Z",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2021-04-05T02:03:01.1974346Z"
      },
      "location": "westus2",
      "etag": "00000000-0000-0000-0000-000000000000",
      "properties": {
        "dnsResolverOutboundEndpoints": [
          {
            "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint2"
          },
          {
            "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint3"
          }
        ],
        "provisioningState": "Succeeded",
        "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8"
      }
    }
  ],
  "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsForwardingRulesets?$skipToken=skipToken&api-version=2020-04-01-preview"
}

Definizioni

Nome	Descrizione
CloudError	Messaggio di errore
CloudErrorBody	Corpo di un messaggio di errore
createdByType	Tipo di identità che ha creato la risorsa.
DnsForwardingRuleset	Descrive un set di regole di inoltro DNS.
DnsForwardingRulesetListResult	Risposta a un'operazione di enumerazione sui set di regole di inoltro DNS.
ProvisioningState	Stato di provisioning corrente della risorsa.
SubResource	Riferimento a un'altra risorsa arm.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CloudError

Messaggio di errore

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo del messaggio di errore

CloudErrorBody

Corpo di un messaggio di errore

Nome	Tipo	Descrizione
code	string	Il codice di errore
details	CloudErrorBody[]	Informazioni aggiuntive sugli errori
message	string	Descrizione di ciò che ha causato l'errore
target	string	Risorsa di destinazione del messaggio di errore

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

DnsForwardingRuleset

Descrive un set di regole di inoltro DNS.

Nome	Tipo	Descrizione
etag	string	ETag del set di regole di inoltro DNS.
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui risiede la risorsa
name	string	nome della risorsa.
properties.dnsResolverOutboundEndpoints	SubResource[]	Riferimento agli endpoint in uscita del resolver DNS usati per instradare le query DNS corrispondenti alle regole di inoltro nel set di regole ai server DNS di destinazione.
properties.provisioningState	ProvisioningState	Stato di provisioning corrente del set di regole di inoltro DNS. Si tratta di una proprietà di sola lettura e qualsiasi tentativo di impostare questo valore verrà ignorato.
properties.resourceGuid	string	ResourceGuid per il set di regole di inoltro DNS.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DnsForwardingRulesetListResult

Risposta a un'operazione di enumerazione sui set di regole di inoltro DNS.

Nome	Tipo	Descrizione
nextLink	string	Token di continuazione per la pagina successiva dei risultati.
value	DnsForwardingRuleset[]	Enumerazione dei set di regole di inoltro DNS.

ProvisioningState

Stato di provisioning corrente della risorsa.

Nome	Tipo	Descrizione
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Riferimento a un'altra risorsa arm.

Nome	Tipo	Descrizione
id	string	ID risorsa.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.