Dns Forwarding Rulesets - List

Ссылка

Service:: DNS

API Version:: 2020-04-01-preview

Списки наборы правил перенаправления DNS во всех группах ресурсов подписки.

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}

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.
$top	query		integer int32	Максимальное количество отображаемых результатов. Если значение не указано, возвращает до 100 результатов.

Ответы

Имя	Тип	Описание
200 OK	DnsForwardingRulesetListResult	Список наборов правил перенаправления DNS в подписке.
Other Status Codes	CloudError	Ответ по умолчанию. Он будет десериализован в определении Ошибки.

Примеры

List DNS forwarding rulesets by subscription

Sample Request

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

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

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

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

Определения

Имя	Описание
CloudError	Сообщение об ошибке
CloudErrorBody	Текст сообщения об ошибке
createdByType	Тип удостоверения, создавшего ресурс.
DnsForwardingRuleset	Описывает набор правил перенаправления DNS.
DnsForwardingRulesetListResult	Ответ на операцию перечисления для наборов правил перенаправления DNS.
ProvisioningState	Текущее состояние подготовки ресурса.
SubResource	Ссылка на другой ресурс ARM.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

CloudError

Сообщение об ошибке

Имя	Тип	Описание
error	CloudErrorBody	Текст сообщения об ошибке

CloudErrorBody

Текст сообщения об ошибке

Имя	Тип	Описание
code	string	Код ошибки
details	CloudErrorBody[]	Дополнительные сведения об ошибке
message	string	Описание причины ошибки
target	string	Целевой ресурс сообщения об ошибке

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string