Dns Forwarding Rulesets - List

Service:

DNS

API Version:

2020-04-01-preview

Listas conjuntos de reglas de reenvío dns en todos los grupos de recursos de una suscripción.

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.
$top	query		integer int32	El número máximo de resultados que se devolverán. Si no se especifica, devuelve hasta 100 resultados.

Respuestas

Nombre	Tipo	Description
200 OK	DnsForwardingRulesetListResult	Lista de conjuntos de reglas de reenvío dns en la suscripción.
Other Status Codes	CloudError	Respuesta predeterminada. Se deserializará según la definición de error.

Ejemplos

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

Definiciones

Nombre	Description
CloudError	Mensaje de error
CloudErrorBody	Cuerpo de un mensaje de error
createdByType	Tipo de identidad que creó el recurso.
DnsForwardingRuleset	Describe un conjunto de reglas de reenvío DNS.
DnsForwardingRulesetListResult	Respuesta a una operación de enumeración en conjuntos de reglas de reenvío DNS.
ProvisioningState	Estado de aprovisionamiento actual del recurso.
SubResource	Referencia a otro recurso de ARM.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

CloudError

Mensaje de error

Nombre	Tipo	Description
error	CloudErrorBody	El cuerpo del mensaje de error

CloudErrorBody

Cuerpo de un mensaje de error

Nombre	Tipo	Description
code	string	Código de error.
details	CloudErrorBody[]	Información de error adicional
message	string	Descripción de lo que provocó el error
target	string	Recurso de destino del mensaje de error

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DnsForwardingRuleset

Describe un conjunto de reglas de reenvío DNS.

Nombre	Tipo	Description
etag	string	ETag del conjunto de reglas de reenvío dns.
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.dnsResolverOutboundEndpoints	SubResource[]	Referencia a los puntos de conexión de salida de la resolución DNS que se usan para enrutar consultas DNS que coinciden con las reglas de reenvío del conjunto de reglas a los servidores DNS de destino.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento actual del conjunto de reglas de reenvío dns. Se trata de una propiedad de solo lectura y se omitirá cualquier intento de establecer este valor.
properties.resourceGuid	string	ResourceGuid para el conjunto de reglas de reenvío dns.
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DnsForwardingRulesetListResult

Respuesta a una operación de enumeración en conjuntos de reglas de reenvío DNS.

Nombre	Tipo	Description
nextLink	string	Token de continuación de la página siguiente de resultados.
value	DnsForwardingRuleset[]	Enumeración de los conjuntos de reglas de reenvío dns.

ProvisioningState

Estado de aprovisionamiento actual del recurso.

Nombre	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referencia a otro recurso de ARM.

Nombre	Tipo	Description
id	string	Identificador del recurso.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.