Dns Forwarding Rulesets - List

Serviço:

DNS

Versão da API:

2025-05-01

Lista os conjuntos de regras de encaminhamento de DNS em todos os grupos de recursos de uma assinatura.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$top	query		integer (int32)	O número máximo de resultados a serem retornados. Se não for especificado, retornará até 100 resultados.

Respostas

Nome	Tipo	Description
200 OK	DnsForwardingRulesetListResult	A operação do Azure foi concluída com êxito.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List DNS forwarding rulesets by subscription

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

{
  "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsForwardingRulesets?$skipToken=skipToken&api-version=2025-05-01",
  "value": [
    {
      "name": "sampleDnsForwardingRuleset",
      "type": "Microsoft.Network/dnsForwardingRulesets",
      "etag": "00000000-0000-0000-0000-000000000000",
      "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset",
      "location": "westus2",
      "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"
      },
      "systemData": {
        "createdAt": "2021-04-03T01:01:01.1075056Z",
        "createdByType": "Application",
        "lastModifiedAt": "2021-04-04T02:03:01.1974346Z",
        "lastModifiedByType": "Application"
      },
      "tags": {
        "key1": "value1"
      }
    },
    {
      "name": "sampleDnsForwardingRuleset",
      "type": "Microsoft.Network/dnsForwardingRulesets",
      "etag": "00000000-0000-0000-0000-000000000000",
      "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset1",
      "location": "westus2",
      "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"
      },
      "systemData": {
        "createdAt": "2021-04-04T01:01:01.1075056Z",
        "createdByType": "Application",
        "lastModifiedAt": "2021-04-05T02:03:01.1974346Z",
        "lastModifiedByType": "Application"
      },
      "tags": {
        "key1": "value1"
      }
    }
  ]
}

Definições

Nome	Description
CloudError	Uma mensagem de erro
CloudErrorBody	O corpo de uma mensagem de erro
createdByType	O tipo de identidade que criou o recurso.
DnsForwardingRuleset	Descreve um conjunto de regras de encaminhamento DNS.
DnsForwardingRulesetListResult	A resposta de uma operação de lista DnsForwardingRuleset.
ProvisioningState	O estado atual de provisionamento do recurso.
SubResource	Referência a outro recurso do ARM.
systemData	Metadados relativos à criação e última modificação do recurso.

CloudError

Objeto

Uma mensagem de erro

Nome	Tipo	Description
error	CloudErrorBody	O corpo da mensagem de erro

CloudErrorBody

Objeto

O corpo de uma mensagem de erro

Nome	Tipo	Description
code	string	O código de erro
details	CloudErrorBody[]	Informações adicionais de erro
message	string	Uma descrição do que causou o erro
target	string	O recurso de destino da mensagem de erro

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DnsForwardingRuleset

Objeto

Descreve um conjunto de regras de encaminhamento DNS.

Nome	Tipo	Description
etag	string	"Se a etag for fornecida no corpo da resposta, ela também poderá ser fornecida como um cabeçalho de acordo com a convenção normal de etag. As marcas de entidade são usadas para comparar duas ou mais entidades do mesmo recurso solicitado. O HTTP/1.1 usa tags de entidade nos campos de cabeçalho etag (seção 14.19), If-Match (seção 14.24), If-None-Match (seção 14.26) e If-Range (seção 14.27).")
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.dnsResolverOutboundEndpoints	SubResource[]	A referência aos pontos de extremidade de saída do resolvedor de DNS usados para rotear consultas DNS que correspondem às regras de encaminhamento no conjunto de regras para os servidores DNS de destino.
properties.provisioningState	ProvisioningState	O estado de provisionamento atual do conjunto de regras de encaminhamento DNS. Essa é uma propriedade somente leitura e qualquer tentativa de definir esse valor será ignorada.
properties.resourceGuid	string	O resourceGuid para o conjunto de regras de encaminhamento DNS.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DnsForwardingRulesetListResult

Objeto

A resposta de uma operação de lista DnsForwardingRuleset.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	DnsForwardingRuleset[]	Os itens DnsForwardingRuleset nesta página

ProvisioningState

Enumeração

O estado atual de provisionamento do recurso.

Valor	Description
Creating
Updating
Deleting
Succeeded
Failed
Canceled

SubResource

Objeto

Referência a outro recurso do ARM.

Nome	Tipo	Description
id	string	ID do recurso.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.