Class 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",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

LocalNetworkGateway

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Network

Assembly: Pulumi.Azure.dll

Syntax

public class LocalNetworkGateway : CustomResource

Constructors

LocalNetworkGateway(String, LocalNetworkGatewayArgs, CustomResourceOptions)

Create a LocalNetworkGateway resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
LocalNetworkGatewayArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AddressSpaces

The list of string CIDRs representing the address spaces the gateway exposes.

Declaration

public Output<ImmutableArray<string>> AddressSpaces { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

BgpSettings

A bgp_settings block as defined below containing the Local Network Gateway's BGP speaker settings.

Declaration

public Output<LocalNetworkGatewayBgpSettings> BgpSettings { get; }

Property Value

Type	Description
Output<LocalNetworkGatewayBgpSettings>

GatewayAddress

The IP address of the gateway to which to connect.

Declaration

public Output<string> GatewayAddress { get; }

Property Value

Type	Description
Output<System.String>

Location

The location/region where the local network gateway is created. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the local network gateway. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which to create the local network gateway.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Methods

Get(String, Input<String>, LocalNetworkGatewayState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
LocalNetworkGatewayState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
LocalNetworkGateway