Share via

Microsoft.Network localNetworkGateways 2021-03-01

  • Article
Choose a deployment language

Bicep resource definition

The localNetworkGateways resource type can be deployed with operations that target:

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.

Bicep 
resource symbolicname 'Microsoft.Network/localNetworkGateways@2021-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      bgpPeeringAddresses: [
        {
          customBgpIpAddresses: [
            'string'
          ]
          ipconfigurationId: 'string'
        }
      ]
      peerWeight: int
    }
    fqdn: 'string'
    gatewayIpAddress: 'string'
    localNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

AddressSpace

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

BgpSettings

Name Description Value
asn The BGP speaker's ASN. int

Constraints:
Min value = 0
Max value = 4294967295
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

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

Microsoft.Network/localNetworkGateways

Name Description Value
location Resource location. string
name The resource name string

Constraints:
Min length = 1 (required)
properties Properties of the local network gateway. LocalNetworkGatewayPropertiesFormat (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Local Network Gateway AVM Resource Module for Local Network Gateway

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
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 with operations that target:

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.

JSON 
{
  "type": "Microsoft.Network/localNetworkGateways",
  "apiVersion": "2021-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "bgpPeeringAddresses": [
        {
          "customBgpIpAddresses": [ "string" ],
          "ipconfigurationId": "string"
        }
      ],
      "peerWeight": "int"
    },
    "fqdn": "string",
    "gatewayIpAddress": "string",
    "localNetworkAddressSpace": {
      "addressPrefixes": [ "string" ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

AddressSpace

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

BgpSettings

Name Description Value
asn The BGP speaker's ASN. int

Constraints:
Min value = 0
Max value = 4294967295
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

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

Microsoft.Network/localNetworkGateways

Name Description Value
apiVersion The api version '2021-03-01'
location Resource location. string
name The resource name string

Constraints:
Min length = 1 (required)
properties Properties of the local network gateway. LocalNetworkGatewayPropertiesFormat (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/localNetworkGateways'

ResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure 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 with VM

Deploy to Azure		 This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Create VNet with two Subnets, local network, and gateway

Deploy to Azure		 This template creates a VNet, 2 subnets, and a gateway
Site-to-Site VPN with active-active VPN Gateways with BGP

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

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

Property Values

AddressSpace

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

BgpSettings

Name Description Value
asn The BGP speaker's ASN. int

Constraints:
Min value = 0
Max value = 4294967295
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

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

Microsoft.Network/localNetworkGateways

Name Description Value
location Resource location. string
name The resource name string

Constraints:
Min length = 1 (required)
properties Properties of the local network gateway. LocalNetworkGatewayPropertiesFormat (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/localNetworkGateways@2021-03-01"

ResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Local Network Gateway AVM Resource Module for Local Network Gateway