Microsoft.Network dnsForwardingRulesets

• Latest
• 2022-07-01
• 2020-04-01-preview

Bicep resource definition

The dnsForwardingRulesets resource type can be deployed to:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/dnsForwardingRulesets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/dnsForwardingRulesets@2022-07-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    dnsResolverOutboundEndpoints: [
      {
        id: 'string'
      }
    ]
  }
}

Property values

dnsForwardingRulesets

Name	Description	Value
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Properties of the DNS forwarding ruleset.	DnsForwardingRulesetProperties (required)

DnsForwardingRulesetProperties

Name	Description	Value
dnsResolverOutboundEndpoints	The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.	SubResource[] (required)

SubResource

Name	Description	Value
id	Resource ID.	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure DNS Private Resolver	This template provisions Azure DNS Private Resolver in a virtual network with required forwarding ruleset and rules. It creates a new virtual network with two subnets, and deploy Azure DNS Private Resolver in this VNET.

ARM template resource definition

The dnsForwardingRulesets resource type can be deployed to:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/dnsForwardingRulesets resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/dnsForwardingRulesets",
  "apiVersion": "2022-07-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "dnsResolverOutboundEndpoints": [
      {
        "id": "string"
      }
    ]
  }
}

Property values

dnsForwardingRulesets

Name	Description	Value
type	The resource type	'Microsoft.Network/dnsForwardingRulesets'
apiVersion	The resource api version	'2022-07-01'
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Properties of the DNS forwarding ruleset.	DnsForwardingRulesetProperties (required)

DnsForwardingRulesetProperties

Name	Description	Value
dnsResolverOutboundEndpoints	The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.	SubResource[] (required)

SubResource

Name	Description	Value
id	Resource ID.	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure DNS Private Resolver	This template provisions Azure DNS Private Resolver in a virtual network with required forwarding ruleset and rules. It creates a new virtual network with two subnets, and deploy Azure DNS Private Resolver in this VNET.

Terraform (AzAPI provider) resource definition

The dnsForwardingRulesets resource type can be deployed to:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/dnsForwardingRulesets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/dnsForwardingRulesets@2022-07-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      dnsResolverOutboundEndpoints = [
        {
          id = "string"
        }
      ]
    }
  })
}

Property values

dnsForwardingRulesets

Name	Description	Value
type	The resource type	"Microsoft.Network/dnsForwardingRulesets@2022-07-01"
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
properties	Properties of the DNS forwarding ruleset.	DnsForwardingRulesetProperties (required)

DnsForwardingRulesetProperties

Name	Description	Value
dnsResolverOutboundEndpoints	The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.	SubResource[] (required)

SubResource

Name	Description	Value
id	Resource ID.	string (required)