azLocalNetworkGateway

+++ title = "azLocalNetworkGateway" description = "Azure Local Network Gateway" weight = 10 alwaysopen = false +++

Use the resource azLocalNetworkGateway to deploy an Azure Local Network Gateway for a Site to Site IPSec VPN. Typically this would be created to represent a branch office.

Attributes

Attribute	Type	Mandatory	Values	Default	Notes
Name	String	Yes
ResourceGroupName	String	Yes
Location	String	Yes
GatewayIPAddress	String	Yes
AddressPrefix	String	Yes
Connection	Object	No
Tag	Object	No

Connection

Attribute	Type	Mandatory	Values	Default	Notes
Name	String	Yes
ResourceGroupName	String	Yes
Location	String	Yes
Type	String	Yes
SharedKey	String	Yes
VNetGateway	Object	Yes

VNetGateway

Attribute	Type	Mandatory	Values	Default	Notes
Name	String	Yes
ResourceGroupName	String	No			Defaults to RG of resource

Input by YAML

Object model for YAML deployment:

---
azLocalNetworkGateway:
    # Mandatory
  - Name: 'string'
    ConnectionName: 'string'
    ResourceGroupName: 'string'
    Location: 'string'
    GatewayIPAddress: 'string'
    AddressPrefix: 'string'
    # Optional
    Tag: 
      'keyvalue-pairs'
    Connection:
      Name: 'string'
      ResourceGroupName: 'string'
      Location: 'string'
      Type: 'string'
      SharedKey: 'string'
      VNetworkGateway:
        Name: 'string'
        ResourceGroupName: 'string'             # defaults to RG of resource

Input by JSON

Object model for JSON deployment:

{
  "azLocalNetworkGateway": [
    {
      "Name": "string",
      "ConnectionName": "string",
      "ResourceGroupName": "string",
      "Location": "string>",
      "GatewayIPAddress": "string",
      "AddressPrefix": "string",
      "Tag": {
        "key": "value"
      },
      "Connection": {
        "Name": "string",
        "ResourceGroupName": "string",
        "Location": "string",
        "Type": "string",
        "SharedKey": "string",
        "VNetworkGateway": {
          "Name": "string",
          "ResourceGroupName": "string"
        }
      }
    }
  ]
}