Microsoft.Network dnsForwardingRulesets/virtualNetworkLinks 2022-07-01

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

Bicep resource definition

The dnsForwardingRulesets/virtualNetworkLinks 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/virtualNetworkLinks resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks@2022-07-01' = {
  name: 'string'
  properties: {
    metadata: {
      {customized property}: 'string'
    }
    virtualNetwork: {
      id: 'string'
    }
  }
}

Property values

Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: dnsForwardingRulesets
properties	Properties of the virtual network link.	VirtualNetworkLinkProperties (required)

SubResource

Name	Description	Value
id	Resource ID.	string (required)

VirtualNetworkLinkProperties

Name	Description	Value
metadata	Metadata attached to the virtual network link.	VirtualNetworkLinkPropertiesMetadata
virtualNetwork	The reference to the virtual network. This cannot be changed after creation.	SubResource (required)

VirtualNetworkLinkPropertiesMetadata

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/virtualNetworkLinks 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/virtualNetworkLinks resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks",
  "apiVersion": "2022-07-01",
  "name": "string",
  "properties": {
    "metadata": {
      "{customized property}": "string"
    },
    "virtualNetwork": {
      "id": "string"
    }
  }
}

Property values

Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks

Name	Description	Value
apiVersion	The api version	'2022-07-01'
name	The resource name	string (required)
properties	Properties of the virtual network link.	VirtualNetworkLinkProperties (required)
type	The resource type	'Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks'

SubResource

Name	Description	Value
id	Resource ID.	string (required)

VirtualNetworkLinkProperties

Name	Description	Value
metadata	Metadata attached to the virtual network link.	VirtualNetworkLinkPropertiesMetadata
virtualNetwork	The reference to the virtual network. This cannot be changed after creation.	SubResource (required)

VirtualNetworkLinkPropertiesMetadata

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/virtualNetworkLinks 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/virtualNetworkLinks resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks@2022-07-01"
  name = "string"
  body = jsonencode({
    properties = {
      metadata = {
        {customized property} = "string"
      }
      virtualNetwork = {
        id = "string"
      }
    }
  })
}

Property values

Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: dnsForwardingRulesets
properties	Properties of the virtual network link.	VirtualNetworkLinkProperties (required)
type	The resource type	"Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks@2022-07-01"

SubResource

Name	Description	Value
id	Resource ID.	string (required)

VirtualNetworkLinkProperties

Name	Description	Value
metadata	Metadata attached to the virtual network link.	VirtualNetworkLinkPropertiesMetadata
virtualNetwork	The reference to the virtual network. This cannot be changed after creation.	SubResource (required)

VirtualNetworkLinkPropertiesMetadata

Name	Description	Value