Microsoft.Network localNetworkGateways 2021-05-01

Article
12/28/2022
5 minutes to read

Bicep resource definition

The localNetworkGateways resource type can be deployed to:

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

resource symbolicname 'Microsoft.Network/localNetworkGateways@2021-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    fqdn: 'string'
    gatewayIpAddress: 'string'
    localNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
  }
}

Property values

localNetworkGateways

Name	Description	Value
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Properties of the local network gateway.	LocalNetworkGatewayPropertiesFormat (required)

LocalNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings.	BgpSettings
fqdn	FQDN of local network gateway.	string
gatewayIpAddress	IP address of local network gateway.	string
localNetworkAddressSpace	Local network site address space.	AddressSpace

BgpSettings

Name	Description	Value
asn	The BGP speaker's ASN.	int
bgpPeeringAddress	The BGP peering address and BGP identifier of this BGP speaker.	string
bgpPeeringAddresses	BGP peering address with IP configuration ID for virtual network gateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	The weight added to routes learned from this BGP speaker.	int

IPConfigurationBgpPeeringAddress

Name	Description	Value
customBgpIpAddresses	The list of custom BGP peering addresses which belong to IP configuration.	string[]
ipconfigurationId	The ID of IP configuration which belongs to gateway.	string

AddressSpace

Name	Description	Value
addressPrefixes	A list of address blocks reserved for this virtual network in CIDR notation.	string[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create VNet with two Subnets, local network, and gateway	This template creates a VNet, 2 subnets, and a gateway
Create a Site-to-Site VPN Connection with VM	This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Create a Site-to-Site VPN Connection	This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Site-to-Site VPN with active-active VPN Gateways with BGP	This template allows you to deploy a site-to-site VPN between two VNets with VPN Gateways in configuration active-active with BGP. Each Azure VPN Gateway resolves the FQDN of the remote peers to determine the public IP of the remote VPN Gateway. Template runs as expected in Azure regions with availability zones.

ARM template resource definition

The localNetworkGateways resource type can be deployed to:

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

{
  "type": "Microsoft.Network/localNetworkGateways",
  "apiVersion": "2021-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "fqdn": "string",
    "gatewayIpAddress": "string",
    "localNetworkAddressSpace": {
      "addressPrefixes": [ "string" ]
    }
  }
}

Property values

localNetworkGateways

Name	Description	Value
type	The resource type	'Microsoft.Network/localNetworkGateways'
apiVersion	The resource api version	'2021-05-01'
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Properties of the local network gateway.	LocalNetworkGatewayPropertiesFormat (required)

LocalNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings.	BgpSettings
fqdn	FQDN of local network gateway.	string
gatewayIpAddress	IP address of local network gateway.	string
localNetworkAddressSpace	Local network site address space.	AddressSpace

BgpSettings

Name	Description	Value
asn	The BGP speaker's ASN.	int
bgpPeeringAddress	The BGP peering address and BGP identifier of this BGP speaker.	string
bgpPeeringAddresses	BGP peering address with IP configuration ID for virtual network gateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	The weight added to routes learned from this BGP speaker.	int

IPConfigurationBgpPeeringAddress

Name	Description	Value
customBgpIpAddresses	The list of custom BGP peering addresses which belong to IP configuration.	string[]
ipconfigurationId	The ID of IP configuration which belongs to gateway.	string

AddressSpace

Name	Description	Value
addressPrefixes	A list of address blocks reserved for this virtual network in CIDR notation.	string[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create VNet with two Subnets, local network, and gateway	This template creates a VNet, 2 subnets, and a gateway
Create a Site-to-Site VPN Connection with VM	This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Create a Site-to-Site VPN Connection	This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Site-to-Site VPN with active-active VPN Gateways with BGP	This template allows you to deploy a site-to-site VPN between two VNets with VPN Gateways in configuration active-active with BGP. Each Azure VPN Gateway resolves the FQDN of the remote peers to determine the public IP of the remote VPN Gateway. Template runs as expected in Azure regions with availability zones.

Terraform (AzAPI provider) resource definition

The localNetworkGateways resource type can be deployed to:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/localNetworkGateways resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/localNetworkGateways@2021-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        bgpPeeringAddresses = [
          {
            customBgpIpAddresses = [
              "string"
            ]
            ipconfigurationId = "string"
          }
        ]
        peerWeight = int
      }
      fqdn = "string"
      gatewayIpAddress = "string"
      localNetworkAddressSpace = {
        addressPrefixes = [
          "string"
        ]
      }
    }
  })
}

Property values

localNetworkGateways

Name	Description	Value
type	The resource type	"Microsoft.Network/localNetworkGateways@2021-05-01"
name	The resource name	string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore.
location	Resource location.	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
properties	Properties of the local network gateway.	LocalNetworkGatewayPropertiesFormat (required)

LocalNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings.	BgpSettings
fqdn	FQDN of local network gateway.	string
gatewayIpAddress	IP address of local network gateway.	string
localNetworkAddressSpace	Local network site address space.	AddressSpace

BgpSettings

Name	Description	Value
asn	The BGP speaker's ASN.	int
bgpPeeringAddress	The BGP peering address and BGP identifier of this BGP speaker.	string
bgpPeeringAddresses	BGP peering address with IP configuration ID for virtual network gateway.	IPConfigurationBgpPeeringAddress[]
peerWeight	The weight added to routes learned from this BGP speaker.	int

IPConfigurationBgpPeeringAddress

Name	Description	Value
customBgpIpAddresses	The list of custom BGP peering addresses which belong to IP configuration.	string[]
ipconfigurationId	The ID of IP configuration which belongs to gateway.	string

AddressSpace

Name	Description	Value
addressPrefixes	A list of address blocks reserved for this virtual network in CIDR notation.	string[]

Microsoft.Network localNetworkGateways 2021-05-01

Bicep resource definition

Resource format

Property values

localNetworkGateways

LocalNetworkGatewayPropertiesFormat

BgpSettings

IPConfigurationBgpPeeringAddress

AddressSpace

Quickstart templates

ARM template resource definition

Resource format

Property values

localNetworkGateways

LocalNetworkGatewayPropertiesFormat

BgpSettings

IPConfigurationBgpPeeringAddress

AddressSpace

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

localNetworkGateways

LocalNetworkGatewayPropertiesFormat

BgpSettings

IPConfigurationBgpPeeringAddress

AddressSpace

Additional resources

Additional resources