Module local-network-gateway

localNetworkGateway

Property	Value	Description
general (required)	general
bgpSettings	bgpSettings	Virtual network gateway BGP speaker settings
fqdn	string	The FQDN of the local network gateway
gatewayIpAddress (required)	string	The public IP of the remote network (onsite)
localNetworkAddressSpace (required)	string[]	The LAN range of the remote network (onsite)

bgpSettings

Property	Value	Description
asn (required)	int	The BGP speaker ASN
bgpPeeringAddress (required)	string	The BGP peering address and BGP identifier of this BGP speaker
bgpPeeringAddresses (required)	localNetworkGatewayBGPPeeringAddress[]	BGP peering address with IP configuration ID for virtual network gateway
peerWeight (required)	int	The weight added to routes learned from this BGP speaker

localNetworkGatewayBGPPeeringAddress

Property	Value	Description
customBgpIpAddresses (required)	string[]	The list of custom BGP peering addresses which belong to IP configuration
ipconfigurationId (required)	string	The ID of IP configuration which belongs to gateway

naming

Property	Value	Description
forceFunctionAsFullName	bool	Use the function value as the full name of the resource
abbreviation	string	Override the abbreviation of this resource with this parameter
environment	string	The resource environment (for example: dev, tst, acc, prd)
location	string	The resource location (for example: weu, we, westeurope)
customer	string	The name of the customer
delimiter	string	The delimiter between resources (default: -)
nameFormat	Array containing any of: 'abbreviation' 'customer' 'environment' 'function' 'location' 'param1' 'param2' 'param3' 'useCaseName'	The order of the array defines the order of elements in the naming scheme
param1	string	Extra parameter self defined
param2	string	Extra parameter self defined
param3	string	Extra parameter self defined
function (required)	string	Function of the resource [can be app, db, security,...]
useCaseName	string	Name of the use case [can be hub, spoke,...]
suffix	string	Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...]
forceDefaultNaming	bool	Force the CAF naming instead of default company naming

resourceLock

Property	Value	Description
name	string	Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Can't end in period.
level (required)	'CanNotDelete' 'ReadOnly'	The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Read-Only locks must be commented to be able to deploy again
notes	string	Notes about the lock. Maximum of 512 characters.
owners	resourceLockOwner[]	The owners of the lock

resourceLockOwner

Property	Value	Description
applicationId (required)	string	The application ID of the lock owner.

roleAssignment

Property	Value	Description
principalId (required)	string	The principal ID
roleDefinitionId (required)	string	The role definition ID, data file can be used for this
condition	string	Condition on the role assignment
conditionVersion	string	Version of the condition. Currently the only accepted value is "2.0"
delegatedManagedIdentityResourceId	string	Id of the delegated managed identity resource
description	string	Description of role assignment

general

Property	Value	Description
tags	object	Tags of the resource [hashtable]
location (required)	string	Location of the resource
naming (required)	naming	Naming module of the resource
resourceGroupName (required)	string	Name of the resource group where the resource should be located
sharedNaming (required)	naming	Reference to the default naming
roleAssignments	roleAssignment[]	Role assignments on the resource
resourceLocks	resourceLock[]	Resource Locks on the resource

Changelog

2.1.0 (2025-10-20)

Features

• update api version

2.0.1 (2025-09-24)

Bug Fixes

• remove deployment name + cleanup

2.0.0 (2025-09-24)

⚠ BREAKING CHANGES

• remove deprecated outputs

Bug Fixes

• remove deprecated outputs

1.3.0 (2025-03-26)

Features

• add resourceName output