LocalNetworkGateway

Manages a local network gateway connection over which specific connections can be configured.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Azure.Core.ResourceGroup("example", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var home = new Azure.Network.LocalNetworkGateway("home", new Azure.Network.LocalNetworkGatewayArgs
        {
            ResourceGroupName = example.Name,
            Location = example.Location,
            GatewayAddress = "12.13.14.15",
            AddressSpaces = 
            {
                "10.0.0.0/16",
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/network"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        _, err = network.NewLocalNetworkGateway(ctx, "home", &network.LocalNetworkGatewayArgs{
            ResourceGroupName: example.Name,
            Location:          example.Location,
            GatewayAddress:    pulumi.String("12.13.14.15"),
            AddressSpaces: pulumi.StringArray{
                pulumi.String("10.0.0.0/16"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West US")
home = azure.network.LocalNetworkGateway("home",
    resource_group_name=example.name,
    location=example.location,
    gateway_address="12.13.14.15",
    address_spaces=["10.0.0.0/16"])

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {location: "West US"});
const home = new azure.network.LocalNetworkGateway("home", {
    resourceGroupName: example.name,
    location: example.location,
    gatewayAddress: "12.13.14.15",
    addressSpaces: ["10.0.0.0/16"],
});

Create a LocalNetworkGateway Resource

new LocalNetworkGateway(name: string, args: LocalNetworkGatewayArgs, opts?: CustomResourceOptions);

def LocalNetworkGateway(resource_name, opts=None, address_spaces=None, bgp_settings=None, gateway_address=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None);

func NewLocalNetworkGateway(ctx *Context, name string, args LocalNetworkGatewayArgs, opts ...ResourceOption) (*LocalNetworkGateway, error)

public LocalNetworkGateway(string name, LocalNetworkGatewayArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args LocalNetworkGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args LocalNetworkGatewayArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LocalNetworkGatewayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

LocalNetworkGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The LocalNetworkGateway resource accepts the following input properties:

AddressSpaces List<string>: The list of string CIDRs representing the address spaces the gateway exposes.
GatewayAddress string: The IP address of the gateway to which to connect.
ResourceGroupName string: The name of the resource group in which to create the local network gateway.
BgpSettings LocalNetworkGatewayBgpSettingsArgs: A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
Location string: The location/region where the local network gateway is created. Changing this forces a new resource to be created.
Name string: The name of the local network gateway. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AddressSpaces []string: The list of string CIDRs representing the address spaces the gateway exposes.
GatewayAddress string: The IP address of the gateway to which to connect.
ResourceGroupName string: The name of the resource group in which to create the local network gateway.
BgpSettings LocalNetworkGatewayBgpSettings: A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
Location string: The location/region where the local network gateway is created. Changing this forces a new resource to be created.
Name string: The name of the local network gateway. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

addressSpaces string[]: The list of string CIDRs representing the address spaces the gateway exposes.
gatewayAddress string: The IP address of the gateway to which to connect.
resourceGroupName string: The name of the resource group in which to create the local network gateway.
bgpSettings LocalNetworkGatewayBgpSettings: A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
location string: The location/region where the local network gateway is created. Changing this forces a new resource to be created.
name string: The name of the local network gateway. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

address_spaces List[str]: The list of string CIDRs representing the address spaces the gateway exposes.
gateway_address str: The IP address of the gateway to which to connect.
resource_group_name str: The name of the resource group in which to create the local network gateway.
bgp_settings Dict[LocalNetworkGatewayBgpSettings]: A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
location str: The location/region where the local network gateway is created. Changing this forces a new resource to be created.
name str: The name of the local network gateway. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the LocalNetworkGateway resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing LocalNetworkGateway Resource

Get an existing LocalNetworkGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LocalNetworkGatewayState, opts?: CustomResourceOptions): LocalNetworkGateway

static get(resource_name, id, opts=None, address_spaces=None, bgp_settings=None, gateway_address=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None);

func GetLocalNetworkGateway(ctx *Context, name string, id IDInput, state *LocalNetworkGatewayState, opts ...ResourceOption) (*LocalNetworkGateway, error)

public static LocalNetworkGateway Get(string name, Input<string> id, LocalNetworkGatewayState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AddressSpaces List<string>: The list of string CIDRs representing the address spaces the gateway exposes.
BgpSettings LocalNetworkGatewayBgpSettingsArgs: A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
GatewayAddress string: The IP address of the gateway to which to connect.
Location string: The location/region where the local network gateway is created. Changing this forces a new resource to be created.
Name string: The name of the local network gateway. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the local network gateway.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AddressSpaces []string: The list of string CIDRs representing the address spaces the gateway exposes.
BgpSettings LocalNetworkGatewayBgpSettings: A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
GatewayAddress string: The IP address of the gateway to which to connect.
Location string: The location/region where the local network gateway is created. Changing this forces a new resource to be created.
Name string: The name of the local network gateway. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the local network gateway.
Tags map[string]string: A mapping of tags to assign to the resource.

addressSpaces string[]: The list of string CIDRs representing the address spaces the gateway exposes.
bgpSettings LocalNetworkGatewayBgpSettings: A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
gatewayAddress string: The IP address of the gateway to which to connect.
location string: The location/region where the local network gateway is created. Changing this forces a new resource to be created.
name string: The name of the local network gateway. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the local network gateway.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

address_spaces List[str]: The list of string CIDRs representing the address spaces the gateway exposes.
bgp_settings Dict[LocalNetworkGatewayBgpSettings]: A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
gateway_address str: The IP address of the gateway to which to connect.
location str: The location/region where the local network gateway is created. Changing this forces a new resource to be created.
name str: The name of the local network gateway. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the local network gateway.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

LocalNetworkGatewayBgpSettings

See the input and output API doc for this type.

Asn int: The BGP speaker’s ASN.
BgpPeeringAddress string: The BGP peering address and BGP identifier of this BGP speaker.
PeerWeight int: The weight added to routes learned from this BGP speaker.

Asn int: The BGP speaker’s ASN.
BgpPeeringAddress string: The BGP peering address and BGP identifier of this BGP speaker.
PeerWeight int: The weight added to routes learned from this BGP speaker.

asn number: The BGP speaker’s ASN.
bgpPeeringAddress string: The BGP peering address and BGP identifier of this BGP speaker.
peerWeight number: The weight added to routes learned from this BGP speaker.

asn float: The BGP speaker’s ASN.
bgpPeeringAddress str: The BGP peering address and BGP identifier of this BGP speaker.
peerWeight float: The weight added to routes learned from this BGP speaker.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud