Microsoft.Network virtualNetworks/virtualNetworkPeerings 2017-06-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-06-01' = {
  etag: 'string'
  name: 'string'
  properties: {
    allowForwardedTraffic: bool
    allowGatewayTransit: bool
    allowVirtualNetworkAccess: bool
    peeringState: 'string'
    provisioningState: 'string'
    remoteVirtualNetwork: {
      id: 'string'
    }
    useRemoteGateways: bool
  }
}

Property values

Microsoft.Network/virtualNetworks/virtualNetworkPeerings

SubResource

VirtualNetworkPeeringPropertiesFormat

Quickstart samples

The following quickstart samples deploy this resource type.

ARM template resource definition

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

{
  "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings",
  "apiVersion": "2017-06-01",
  "name": "string",
  "etag": "string",
  "properties": {
    "allowForwardedTraffic": "bool",
    "allowGatewayTransit": "bool",
    "allowVirtualNetworkAccess": "bool",
    "peeringState": "string",
    "provisioningState": "string",
    "remoteVirtualNetwork": {
      "id": "string"
    },
    "useRemoteGateways": "bool"
  }
}

Property values

Microsoft.Network/virtualNetworks/virtualNetworkPeerings

SubResource

VirtualNetworkPeeringPropertiesFormat

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure Game Developer Virtual Machine	Azure Game Developer Virtual Machine includes Licencsed Engines like Unreal.
Create a vNet to vNet connection using vNet Peering	This template allows you to connect two vNets using vNet Peering
Create an Azure Firewall sandbox with forced tunneling	This template creates an Azure Firewall sandbox (Linux) with one firewall force tunneled through another firewall in a peered VNET
Deploy a Bastion host in a hub Virtual Network	This template creates two vNets with peerings, a Bastion host in the Hub vNet and a Linux VM in the spoke vNet
Deploy a Hub and Spoke topology sandbox	This template creates a basic hub-and-spoke topology setup. It creates a Hub VNet with subnets DMZ, Management, Shared and Gateway (optionally), with two Spoke VNets (development and production) containing a workload subnet each. It also deploys a Windows Jump-Host on the Management subnet of the HUB, and establishes VNet peerings between the Hub and the two spokes.
Deploy HBase replication with two VNets in one region	This template allows you to configure aN HBase environment with two HBase clusters within two VNets in the same region for configuring HBase replication.
Peer two existing VNets within a single region	This template allows you to connect two VNETs from the same or different resource groups in the same region using VNet Peering
Public Load Balancer chained to a Gateway Load Balancer	This template allows you to deploy a Public Standard Load Balancer chained to a Gateway Load Balancer. The traffic incoming from internet is routed to the Gateway Load Balancer with linux VMs (NVAs) in the backend pool.
Use Azure Firewall as a DNS Proxy in a Hub & Spoke topology	This sample show how to deploy a hub-spoke topology in Azure using the Azure Firewall. The hub virtual network acts as a central point of connectivity to many spoke virtual networks that are connected to hub virtual network via virtual network peering.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-06-01"
  name = "string"
  etag = "string"
  body = jsonencode({
    properties = {
      allowForwardedTraffic = bool
      allowGatewayTransit = bool
      allowVirtualNetworkAccess = bool
      peeringState = "string"
      provisioningState = "string"
      remoteVirtualNetwork = {
        id = "string"
      }
      useRemoteGateways = bool
    }
  })
}

Property values

Microsoft.Network/virtualNetworks/virtualNetworkPeerings

SubResource

VirtualNetworkPeeringPropertiesFormat