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	Lista de conjuntos de regras de encaminhamento de DNS na assinatura.
Other Status Codes	CloudError	Resposta padrão. Ele será desserializado de acordo com a definição de erro.

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

Java

/**
 * Samples for DnsForwardingRulesets List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/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, 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_subscription.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()
    for item in response:
        print(item)


# x-ms-original-file: specification/dnsresolver/resource-manager/Microsoft.Network/stable/2025-05-01/examples/DnsForwardingRuleset_ListBySubscription.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

Resposta de exemplo

Código de status:

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=2025-05-01"
}

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 a uma operação de enumeração em conjuntos de regras de encaminhamento DNS.
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
Application
Key
ManagedIdentity
User

DnsForwardingRuleset

Objeto

Descreve um conjunto de regras de encaminhamento DNS.

Nome	Tipo	Description
etag	string	ETag do conjunto de regras de encaminhamento DNS.
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 relativos à criação e última modificação do recurso.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DnsForwardingRulesetListResult

Objeto

A resposta a uma operação de enumeração em conjuntos de regras de encaminhamento DNS.

Nome	Tipo	Description
nextLink	string	O token de continuação para a próxima página de resultados.
value	DnsForwardingRuleset[]	Enumeração dos conjuntos de regras de encaminhamento DNS.

ProvisioningState

Enumeração

O estado atual de provisionamento do recurso.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

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.