Microsoft.Network localNetworkGateways 2016-03-30

• Latest
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01
• 2017-09-01
• 2017-08-01
• 2017-06-01
• 2017-03-30
• 2017-03-01
• 2016-12-01
• 2016-09-01
• 2016-06-01
• 2016-03-30
• 2015-06-15
• 2015-05-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/localNetworkGateways@2016-03-30' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    bgpSettings: {
      asn: int
      bgpPeeringAddress: 'string'
      peerWeight: int
    }
    gatewayIpAddress: 'string'
    localNetworkAddressSpace: {
      addressPrefixes: [
        'string'
      ]
    }
    provisioningState: 'string'
    resourceGuid: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AddressSpace

Name	Description	Value
addressPrefixes	Gets or sets List of address blocks reserved for this virtual network in CIDR notation	string[]

BgpSettings

Name	Description	Value
asn	Gets or sets this BGP speaker's ASN	int
bgpPeeringAddress	Gets or sets the BGP peering address and BGP identifier of this BGP speaker	string
peerWeight	Gets or sets the weight added to routes learned from this BGP speaker	int

LocalNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings	BgpSettings
gatewayIpAddress	IP address of local network gateway.	string
localNetworkAddressSpace	Local network site Address space	AddressSpace
provisioningState	Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed	string
resourceGuid	Gets or sets resource GUID property of the LocalNetworkGateway resource	string

Microsoft.Network/localNetworkGateways

Name	Description	Value
etag	Gets a unique read-only string that changes whenever the resource is updated	string
location	Resource location	string
name	The resource name	string (required)
properties	LocalNetworkGateway properties	LocalNetworkGatewayPropertiesFormat
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceTags

Name	Description	Value

Quickstart samples

The following quickstart samples deploy 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:

• 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": "2016-03-30",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "bgpSettings": {
      "asn": "int",
      "bgpPeeringAddress": "string",
      "peerWeight": "int"
    },
    "gatewayIpAddress": "string",
    "localNetworkAddressSpace": {
      "addressPrefixes": [ "string" ]
    },
    "provisioningState": "string",
    "resourceGuid": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AddressSpace

Name	Description	Value
addressPrefixes	Gets or sets List of address blocks reserved for this virtual network in CIDR notation	string[]

BgpSettings

Name	Description	Value
asn	Gets or sets this BGP speaker's ASN	int
bgpPeeringAddress	Gets or sets the BGP peering address and BGP identifier of this BGP speaker	string
peerWeight	Gets or sets the weight added to routes learned from this BGP speaker	int

LocalNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings	BgpSettings
gatewayIpAddress	IP address of local network gateway.	string
localNetworkAddressSpace	Local network site Address space	AddressSpace
provisioningState	Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed	string
resourceGuid	Gets or sets resource GUID property of the LocalNetworkGateway resource	string

Microsoft.Network/localNetworkGateways

Name	Description	Value
apiVersion	The api version	'2016-03-30'
etag	Gets a unique read-only string that changes whenever the resource is updated	string
location	Resource location	string
name	The resource name	string (required)
properties	LocalNetworkGateway properties	LocalNetworkGatewayPropertiesFormat
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Network/localNetworkGateways'

ResourceTags

Name	Description	Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Site-to-Site VPN Connection	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	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	This template creates a VNet, 2 subnets, and a gateway
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 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.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/localNetworkGateways@2016-03-30"
  name = "string"
  etag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      bgpSettings = {
        asn = int
        bgpPeeringAddress = "string"
        peerWeight = int
      }
      gatewayIpAddress = "string"
      localNetworkAddressSpace = {
        addressPrefixes = [
          "string"
        ]
      }
      provisioningState = "string"
      resourceGuid = "string"
    }
  })
}

Property values

AddressSpace

Name	Description	Value
addressPrefixes	Gets or sets List of address blocks reserved for this virtual network in CIDR notation	string[]

BgpSettings

Name	Description	Value
asn	Gets or sets this BGP speaker's ASN	int
bgpPeeringAddress	Gets or sets the BGP peering address and BGP identifier of this BGP speaker	string
peerWeight	Gets or sets the weight added to routes learned from this BGP speaker	int

LocalNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Local network gateway's BGP speaker settings	BgpSettings
gatewayIpAddress	IP address of local network gateway.	string
localNetworkAddressSpace	Local network site Address space	AddressSpace
provisioningState	Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed	string
resourceGuid	Gets or sets resource GUID property of the LocalNetworkGateway resource	string

Microsoft.Network/localNetworkGateways

Name	Description	Value
etag	Gets a unique read-only string that changes whenever the resource is updated	string
location	Resource location	string
name	The resource name	string (required)
properties	LocalNetworkGateway properties	LocalNetworkGatewayPropertiesFormat
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/localNetworkGateways@2016-03-30"

ResourceTags

Name	Description	Value