Microsoft.Network dnsForwardingRulesets

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

Bicep resource definition

The dnsForwardingRulesets resource type can be deployed with operations that target:

• 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@2023-07-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    dnsResolverOutboundEndpoints: [
      {
        id: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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)

Microsoft.Network/dnsForwardingRulesets

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

SubResource

Name	Description	Value
id	Resource ID.	string (required)

TrackedResourceTags

Name	Description	Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	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 with operations that target:

• 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": "2023-07-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "dnsResolverOutboundEndpoints": [
      {
        "id": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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)

Microsoft.Network/dnsForwardingRulesets

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

SubResource

Name	Description	Value
id	Resource ID.	string (required)

TrackedResourceTags

Name	Description	Value

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 with operations that target:

• 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@2023-07-01-preview"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      dnsResolverOutboundEndpoints = [
        {
          id = "string"
        }
      ]
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

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)

Microsoft.Network/dnsForwardingRulesets

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Properties of the DNS forwarding ruleset.	DnsForwardingRulesetProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/dnsForwardingRulesets@2023-07-01-preview"

SubResource

Name	Description	Value
id	Resource ID.	string (required)

TrackedResourceTags

Name	Description	Value