Dns Forwarding Rulesets - List

服务:

DNS

API 版本:

2025-05-01

列出订阅的所有资源组中的 DNS 转发规则集。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
$top	query		integer (int32)	要返回的最大结果数。 如果未指定，则最多返回 100 个结果。

响应

名称	类型	说明
200 OK	DnsForwardingRulesetListResult	Azure作已成功完成。
Other Status Codes	CloudError	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List DNS forwarding rulesets by subscription

示例请求

HTTP

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

示例响应

状态代码:

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

定义

名称	说明
CloudError	错误消息
CloudErrorBody	错误消息的正文
createdByType	创建资源的标识的类型。
DnsForwardingRuleset	描述 DNS 转发规则集。
DnsForwardingRulesetListResult	DnsForwardingRuleset 列表作的响应。
ProvisioningState	资源的当前预置状态。
SubResource	对另一个 ARM 资源的引用。
systemData	与创建和上次修改资源相关的元数据。

CloudError

Object

错误消息

名称	类型	说明
error	CloudErrorBody	错误消息正文

CloudErrorBody

Object

错误消息的正文

名称	类型	说明
code	string	错误代码
details	CloudErrorBody[]	额外的错误信息
message	string	导致错误的原因的说明
target	string	错误消息的目标资源

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DnsForwardingRuleset

Object

描述 DNS 转发规则集。

名称	类型	说明
etag	string	“如果在响应正文中提供了 etag，则也可以根据正常的 etag 约定将其作为标头提供。 实体标记用于比较同一请求资源的两个或多个实体。 HTTP/1.1 在 etag（第 14.19 节）、If-Match（第 14.24 节）、If-None-Match（第 14.26 节）和 If-Range（第 14.27 节）标头字段中使用实体标签。
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties.dnsResolverOutboundEndpoints	SubResource[]	对 DNS 解析程序出站终结点的引用，这些终结点用于将与规则集中的转发规则匹配的 DNS 查询路由到目标 DNS 服务器。
properties.provisioningState	ProvisioningState	DNS 转发规则集的当前预配状态。 这是一个只读属性，将忽略任何设置此值的尝试。
properties.resourceGuid	string	DNS 转发规则集的 resourceGuid。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DnsForwardingRulesetListResult

Object

DnsForwardingRuleset 列表作的响应。

名称	类型	说明
nextLink	string (uri)	指向下一页项目的链接
value	DnsForwardingRuleset[]	此页上的 DnsForwardingRuleset 项

ProvisioningState

枚举

资源的当前预置状态。

值	说明
Creating
Updating
Deleting
Succeeded
Failed
Canceled

SubResource

Object

对另一个 ARM 资源的引用。

名称	类型	说明
id	string	资源 ID。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。