Microsoft.Network localNetworkGateways template reference

Template format

To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Network/localNetworkGateways",
  "apiVersion": "2019-08-01",
  "location": "string",
  "tags": {},
  "properties": {
    "localNetworkAddressSpace": {
      "addressPrefixes": [
        "string"
      ]
    },
    "gatewayIpAddress": "string",
    "bgpSettings": {
      "asn": "integer",
      "bgpPeeringAddress": "string",
      "peerWeight": "integer"
    },
    "resourceGuid": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/localNetworkGateways object

Name Type Required Value
name string Yes The name of the local network gateway.
Min length: 1
type enum Yes Microsoft.Network/localNetworkGateways
apiVersion enum Yes 2019-08-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes Properties of the local network gateway. - LocalNetworkGatewayPropertiesFormat object

LocalNetworkGatewayPropertiesFormat object

Name Type Required Value
localNetworkAddressSpace object No Local network site address space. - AddressSpace object
gatewayIpAddress string No IP address of local network gateway.
bgpSettings object No Local network gateway's BGP speaker settings. - BgpSettings object
resourceGuid string No The resource GUID property of the local network gateway resource.

AddressSpace object

Name Type Required Value
addressPrefixes array No A list of address blocks reserved for this virtual network in CIDR notation. - string

BgpSettings object

Name Type Required Value
asn integer No The BGP speaker's ASN.
bgpPeeringAddress string No The BGP peering address and BGP identifier of this BGP speaker.
peerWeight integer No The weight added to routes learned from this BGP speaker.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Site-to-Site VPN Connection

Deploy to Azure
This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Create a Site-to-Site VPN Connection

Deploy to Azure
This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Zerto Cloud Appliance with Site-to-Site VPN Connection

Deploy to Azure
This template allows you to create a Zerto Cloud Appliance with a VPN
Create VNet with two Subnets, local network, and gateway

Deploy to Azure
This template creates a VNet, 2 subnets, and a gateway