virtualNetworkPeerings.json

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "2017.09.01.0",
  "parameters": {
    "Name": {
      "type": "string",
      "metadata": {
        "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
      }
    },
    "AllowVirtualNetworkAccess": {
      "type": "bool",
      "defaultValue": true,
      "metadata": {
        "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space."
      }
    },
    "AllowForwardedTraffic": {
      "type": "bool",
      "defaultValue": false,
      "metadata": {
        "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed."
      }
    },
    "AllowGatewayTransit": {
      "type": "bool",
      "defaultValue": false,
      "metadata": {
        "description": "If gateway links can be used in remote virtual networking to link to this virtual network."
      }
    },
    "UseRemoteGateways": {
      "type": "bool",
      "defaultValue": false,
      "metadata": {
        "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway."
      }
    },
    "RemoteVirtualNetworkId": {
      "type": "string",
      "metadata": {
        "description": "The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview)."
      }
    },
    "DependsOn": {
      "type": "array",
      "defaultValue": [],
      "metadata": {
        "description": "Pass dependencies"
      }
    }
  },
  "variables": {
    "comment": {
      "documentation": "https://docs.microsoft.com/en-us/rest/api/virtualnetwork/virtualnetworks/createorupdate#definitions_virtualnetworkpeering"
    },
    "virtualNetworkPeerings": {
      "apiVersion": "2017-09-01",
      "type": "virtualNetworkPeerings",
      "name": "[parameters('Name')]",
      "location": "[resourceGroup().location]",
      "dependsOn": "[if(empty(parameters('DependsOn')),json('null'),parameters('DependsOn'))]",
      "properties": {
        "allowVirtualNetworkAccess": "[parameters('AllowVirtualNetworkAccess')]",
        "allowForwardedTraffic": "[parameters('AllowForwardedTraffic')]",
        "allowGatewayTransit": "[parameters('AllowGatewayTransit')]",
        "useRemoteGateways": "[parameters('UseRemoteGateways')]",
        "remoteVirtualNetwork": {
          "id": "[parameters('RemoteVirtualNetworkId')]"
        }
      }
    }
  },
  "resources": [
    {
      "apiVersion": "2017-09-01",
      "type": "virtualNetworkPeerings",
      "name": "[parameters('Name')]",
      "location": "[resourceGroup().location]",
      "dependsOn": "[if(empty(parameters('DependsOn')),json('null'),parameters('DependsOn'))]",
      "properties": {
        "allowVirtualNetworkAccess": "[parameters('AllowVirtualNetworkAccess')]",
        "allowForwardedTraffic": "[parameters('AllowForwardedTraffic')]",
        "allowGatewayTransit": "[parameters('AllowGatewayTransit')]",
        "useRemoteGateways": "[parameters('UseRemoteGateways')]",
        "remoteVirtualNetwork": {
          "id": "[parameters('RemoteVirtualNetworkId')]"
        }
      }
    }
  ],
  "outputs": {
    "virtualNetworkPeerings": {
      "type": "object",
      "value": "[variables('virtualNetworkPeerings')]"
    }
  }
}