azure-native.network.LocalNetworkGateway
Explore with Pulumi AI
A common class for general resource information. API Version: 2020-11-01.
Example Usage
CreateLocalNetworkGateway
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var localNetworkGateway = new AzureNative.Network.LocalNetworkGateway("localNetworkGateway", new()
{
Fqdn = "site1.contoso.com",
GatewayIpAddress = "11.12.13.14",
LocalNetworkAddressSpace = new AzureNative.Network.Inputs.AddressSpaceArgs
{
AddressPrefixes = new[]
{
"10.1.0.0/16",
},
},
LocalNetworkGatewayName = "localgw",
Location = "Central US",
ResourceGroupName = "rg1",
});
});
package main
import (
network "github.com/pulumi/pulumi-azure-native-sdk/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := network.NewLocalNetworkGateway(ctx, "localNetworkGateway", &network.LocalNetworkGatewayArgs{
Fqdn: pulumi.String("site1.contoso.com"),
GatewayIpAddress: pulumi.String("11.12.13.14"),
LocalNetworkAddressSpace: &network.AddressSpaceArgs{
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.1.0.0/16"),
},
},
LocalNetworkGatewayName: pulumi.String("localgw"),
Location: pulumi.String("Central US"),
ResourceGroupName: pulumi.String("rg1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.LocalNetworkGateway;
import com.pulumi.azurenative.network.LocalNetworkGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var localNetworkGateway = new LocalNetworkGateway("localNetworkGateway", LocalNetworkGatewayArgs.builder()
.fqdn("site1.contoso.com")
.gatewayIpAddress("11.12.13.14")
.localNetworkAddressSpace(Map.of("addressPrefixes", "10.1.0.0/16"))
.localNetworkGatewayName("localgw")
.location("Central US")
.resourceGroupName("rg1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
local_network_gateway = azure_native.network.LocalNetworkGateway("localNetworkGateway",
fqdn="site1.contoso.com",
gateway_ip_address="11.12.13.14",
local_network_address_space=azure_native.network.AddressSpaceArgs(
address_prefixes=["10.1.0.0/16"],
),
local_network_gateway_name="localgw",
location="Central US",
resource_group_name="rg1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const localNetworkGateway = new azure_native.network.LocalNetworkGateway("localNetworkGateway", {
fqdn: "site1.contoso.com",
gatewayIpAddress: "11.12.13.14",
localNetworkAddressSpace: {
addressPrefixes: ["10.1.0.0/16"],
},
localNetworkGatewayName: "localgw",
location: "Central US",
resourceGroupName: "rg1",
});
resources:
localNetworkGateway:
type: azure-native:network:LocalNetworkGateway
properties:
fqdn: site1.contoso.com
gatewayIpAddress: 11.12.13.14
localNetworkAddressSpace:
addressPrefixes:
- 10.1.0.0/16
localNetworkGatewayName: localgw
location: Central US
resourceGroupName: rg1
Create LocalNetworkGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LocalNetworkGateway(name: string, args: LocalNetworkGatewayArgs, opts?: CustomResourceOptions);
@overload
def LocalNetworkGateway(resource_name: str,
args: LocalNetworkGatewayInitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LocalNetworkGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
bgp_settings: Optional[BgpSettingsArgs] = None,
fqdn: Optional[str] = None,
gateway_ip_address: Optional[str] = None,
id: Optional[str] = None,
local_network_address_space: Optional[AddressSpaceArgs] = None,
local_network_gateway_name: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewLocalNetworkGateway(ctx *Context, name string, args LocalNetworkGatewayArgs, opts ...ResourceOption) (*LocalNetworkGateway, error)
public LocalNetworkGateway(string name, LocalNetworkGatewayArgs args, CustomResourceOptions? opts = null)
public LocalNetworkGateway(String name, LocalNetworkGatewayArgs args)
public LocalNetworkGateway(String name, LocalNetworkGatewayArgs args, CustomResourceOptions options)
type: azure-native:network:LocalNetworkGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
- args LocalNetworkGatewayInitArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args LocalNetworkGatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var localNetworkGatewayResource = new AzureNative.Network.LocalNetworkGateway("localNetworkGatewayResource", new()
{
ResourceGroupName = "string",
BgpSettings =
{
{ "asn", 0 },
{ "bgpPeeringAddress", "string" },
{ "bgpPeeringAddresses", new[]
{
{
{ "customBgpIpAddresses", new[]
{
"string",
} },
{ "ipconfigurationId", "string" },
},
} },
{ "peerWeight", 0 },
},
Fqdn = "string",
GatewayIpAddress = "string",
Id = "string",
LocalNetworkAddressSpace =
{
{ "addressPrefixes", new[]
{
"string",
} },
},
LocalNetworkGatewayName = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := network.NewLocalNetworkGateway(ctx, "localNetworkGatewayResource", &network.LocalNetworkGatewayArgs{
ResourceGroupName: "string",
BgpSettings: map[string]interface{}{
"asn": 0,
"bgpPeeringAddress": "string",
"bgpPeeringAddresses": []map[string]interface{}{
map[string]interface{}{
"customBgpIpAddresses": []string{
"string",
},
"ipconfigurationId": "string",
},
},
"peerWeight": 0,
},
Fqdn: "string",
GatewayIpAddress: "string",
Id: "string",
LocalNetworkAddressSpace: map[string]interface{}{
"addressPrefixes": []string{
"string",
},
},
LocalNetworkGatewayName: "string",
Location: "string",
Tags: map[string]interface{}{
"string": "string",
},
})
var localNetworkGatewayResource = new LocalNetworkGateway("localNetworkGatewayResource", LocalNetworkGatewayArgs.builder()
.resourceGroupName("string")
.bgpSettings(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.fqdn("string")
.gatewayIpAddress("string")
.id("string")
.localNetworkAddressSpace(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.localNetworkGatewayName("string")
.location("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
local_network_gateway_resource = azure_native.network.LocalNetworkGateway("localNetworkGatewayResource",
resource_group_name=string,
bgp_settings={
asn: 0,
bgpPeeringAddress: string,
bgpPeeringAddresses: [{
customBgpIpAddresses: [string],
ipconfigurationId: string,
}],
peerWeight: 0,
},
fqdn=string,
gateway_ip_address=string,
id=string,
local_network_address_space={
addressPrefixes: [string],
},
local_network_gateway_name=string,
location=string,
tags={
string: string,
})
const localNetworkGatewayResource = new azure_native.network.LocalNetworkGateway("localNetworkGatewayResource", {
resourceGroupName: "string",
bgpSettings: {
asn: 0,
bgpPeeringAddress: "string",
bgpPeeringAddresses: [{
customBgpIpAddresses: ["string"],
ipconfigurationId: "string",
}],
peerWeight: 0,
},
fqdn: "string",
gatewayIpAddress: "string",
id: "string",
localNetworkAddressSpace: {
addressPrefixes: ["string"],
},
localNetworkGatewayName: "string",
location: "string",
tags: {
string: "string",
},
});
type: azure-native:network:LocalNetworkGateway
properties:
bgpSettings:
asn: 0
bgpPeeringAddress: string
bgpPeeringAddresses:
- customBgpIpAddresses:
- string
ipconfigurationId: string
peerWeight: 0
fqdn: string
gatewayIpAddress: string
id: string
localNetworkAddressSpace:
addressPrefixes:
- string
localNetworkGatewayName: string
location: string
resourceGroupName: string
tags:
string: string
LocalNetworkGateway Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The LocalNetworkGateway resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group.
- Bgp
Settings Pulumi.Azure Native. Network. Inputs. Bgp Settings - Local network gateway's BGP speaker settings.
- Fqdn string
- FQDN of local network gateway.
- Gateway
Ip stringAddress - IP address of local network gateway.
- Id string
- Resource ID.
- Local
Network Pulumi.Address Space Azure Native. Network. Inputs. Address Space - Local network site address space.
- Local
Network stringGateway Name - The name of the local network gateway.
- Location string
- Resource location.
- Dictionary<string, string>
- Resource tags.
- Resource
Group stringName - The name of the resource group.
- Bgp
Settings BgpSettings Args - Local network gateway's BGP speaker settings.
- Fqdn string
- FQDN of local network gateway.
- Gateway
Ip stringAddress - IP address of local network gateway.
- Id string
- Resource ID.
- Local
Network AddressAddress Space Space Args - Local network site address space.
- Local
Network stringGateway Name - The name of the local network gateway.
- Location string
- Resource location.
- map[string]string
- Resource tags.
- resource
Group StringName - The name of the resource group.
- bgp
Settings BgpSettings - Local network gateway's BGP speaker settings.
- fqdn String
- FQDN of local network gateway.
- gateway
Ip StringAddress - IP address of local network gateway.
- id String
- Resource ID.
- local
Network AddressAddress Space Space - Local network site address space.
- local
Network StringGateway Name - The name of the local network gateway.
- location String
- Resource location.
- Map<String,String>
- Resource tags.
- resource
Group stringName - The name of the resource group.
- bgp
Settings BgpSettings - Local network gateway's BGP speaker settings.
- fqdn string
- FQDN of local network gateway.
- gateway
Ip stringAddress - IP address of local network gateway.
- id string
- Resource ID.
- local
Network AddressAddress Space Space - Local network site address space.
- local
Network stringGateway Name - The name of the local network gateway.
- location string
- Resource location.
- {[key: string]: string}
- Resource tags.
- resource_
group_ strname - The name of the resource group.
- bgp_
settings BgpSettings Args - Local network gateway's BGP speaker settings.
- fqdn str
- FQDN of local network gateway.
- gateway_
ip_ straddress - IP address of local network gateway.
- id str
- Resource ID.
- local_
network_ Addressaddress_ space Space Args - Local network site address space.
- local_
network_ strgateway_ name - The name of the local network gateway.
- location str
- Resource location.
- Mapping[str, str]
- Resource tags.
- resource
Group StringName - The name of the resource group.
- bgp
Settings Property Map - Local network gateway's BGP speaker settings.
- fqdn String
- FQDN of local network gateway.
- gateway
Ip StringAddress - IP address of local network gateway.
- id String
- Resource ID.
- local
Network Property MapAddress Space - Local network site address space.
- local
Network StringGateway Name - The name of the local network gateway.
- location String
- Resource location.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the LocalNetworkGateway resource produces the following output properties:
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Provisioning
State string - The provisioning state of the local network gateway resource.
- Resource
Guid string - The resource GUID property of the local network gateway resource.
- Type string
- Resource type.
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Provisioning
State string - The provisioning state of the local network gateway resource.
- Resource
Guid string - The resource GUID property of the local network gateway resource.
- Type string
- Resource type.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- provisioning
State String - The provisioning state of the local network gateway resource.
- resource
Guid String - The resource GUID property of the local network gateway resource.
- type String
- Resource type.
- etag string
- A unique read-only string that changes whenever the resource is updated.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name.
- provisioning
State string - The provisioning state of the local network gateway resource.
- resource
Guid string - The resource GUID property of the local network gateway resource.
- type string
- Resource type.
- etag str
- A unique read-only string that changes whenever the resource is updated.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name.
- provisioning_
state str - The provisioning state of the local network gateway resource.
- resource_
guid str - The resource GUID property of the local network gateway resource.
- type str
- Resource type.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- provisioning
State String - The provisioning state of the local network gateway resource.
- resource
Guid String - The resource GUID property of the local network gateway resource.
- type String
- Resource type.
Supporting Types
AddressSpace, AddressSpaceArgs
- Address
Prefixes List<string> - A list of address blocks reserved for this virtual network in CIDR notation.
- Address
Prefixes []string - A list of address blocks reserved for this virtual network in CIDR notation.
- address
Prefixes List<String> - A list of address blocks reserved for this virtual network in CIDR notation.
- address
Prefixes string[] - A list of address blocks reserved for this virtual network in CIDR notation.
- address_
prefixes Sequence[str] - A list of address blocks reserved for this virtual network in CIDR notation.
- address
Prefixes List<String> - A list of address blocks reserved for this virtual network in CIDR notation.
AddressSpaceResponse, AddressSpaceResponseArgs
- Address
Prefixes List<string> - A list of address blocks reserved for this virtual network in CIDR notation.
- Address
Prefixes []string - A list of address blocks reserved for this virtual network in CIDR notation.
- address
Prefixes List<String> - A list of address blocks reserved for this virtual network in CIDR notation.
- address
Prefixes string[] - A list of address blocks reserved for this virtual network in CIDR notation.
- address_
prefixes Sequence[str] - A list of address blocks reserved for this virtual network in CIDR notation.
- address
Prefixes List<String> - A list of address blocks reserved for this virtual network in CIDR notation.
BgpSettings, BgpSettingsArgs
- Asn double
- The BGP speaker's ASN.
- Bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- Bgp
Peering List<Pulumi.Addresses Azure Native. Network. Inputs. IPConfiguration Bgp Peering Address> - BGP peering address with IP configuration ID for virtual network gateway.
- Peer
Weight int - The weight added to routes learned from this BGP speaker.
- Asn float64
- The BGP speaker's ASN.
- Bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- Bgp
Peering []IPConfigurationAddresses Bgp Peering Address - BGP peering address with IP configuration ID for virtual network gateway.
- Peer
Weight int - The weight added to routes learned from this BGP speaker.
- asn Double
- The BGP speaker's ASN.
- bgp
Peering StringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering List<IPConfigurationAddresses Bgp Peering Address> - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight Integer - The weight added to routes learned from this BGP speaker.
- asn number
- The BGP speaker's ASN.
- bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering IPConfigurationAddresses Bgp Peering Address[] - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight number - The weight added to routes learned from this BGP speaker.
- asn float
- The BGP speaker's ASN.
- bgp_
peering_ straddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp_
peering_ Sequence[IPConfigurationaddresses Bgp Peering Address] - BGP peering address with IP configuration ID for virtual network gateway.
- peer_
weight int - The weight added to routes learned from this BGP speaker.
- asn Number
- The BGP speaker's ASN.
- bgp
Peering StringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering List<Property Map>Addresses - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight Number - The weight added to routes learned from this BGP speaker.
BgpSettingsResponse, BgpSettingsResponseArgs
- Asn double
- The BGP speaker's ASN.
- Bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- Bgp
Peering List<Pulumi.Addresses Azure Native. Network. Inputs. IPConfiguration Bgp Peering Address Response> - BGP peering address with IP configuration ID for virtual network gateway.
- Peer
Weight int - The weight added to routes learned from this BGP speaker.
- Asn float64
- The BGP speaker's ASN.
- Bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- Bgp
Peering []IPConfigurationAddresses Bgp Peering Address Response - BGP peering address with IP configuration ID for virtual network gateway.
- Peer
Weight int - The weight added to routes learned from this BGP speaker.
- asn Double
- The BGP speaker's ASN.
- bgp
Peering StringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering List<IPConfigurationAddresses Bgp Peering Address Response> - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight Integer - The weight added to routes learned from this BGP speaker.
- asn number
- The BGP speaker's ASN.
- bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering IPConfigurationAddresses Bgp Peering Address Response[] - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight number - The weight added to routes learned from this BGP speaker.
- asn float
- The BGP speaker's ASN.
- bgp_
peering_ straddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp_
peering_ Sequence[IPConfigurationaddresses Bgp Peering Address Response] - BGP peering address with IP configuration ID for virtual network gateway.
- peer_
weight int - The weight added to routes learned from this BGP speaker.
- asn Number
- The BGP speaker's ASN.
- bgp
Peering StringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering List<Property Map>Addresses - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight Number - The weight added to routes learned from this BGP speaker.
IPConfigurationBgpPeeringAddress, IPConfigurationBgpPeeringAddressArgs
- Custom
Bgp List<string>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- Ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- Custom
Bgp []stringIp Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- Ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- custom
Bgp List<String>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id String - The ID of IP configuration which belongs to gateway.
- custom
Bgp string[]Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- custom_
bgp_ Sequence[str]ip_ addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration_
id str - The ID of IP configuration which belongs to gateway.
- custom
Bgp List<String>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id String - The ID of IP configuration which belongs to gateway.
IPConfigurationBgpPeeringAddressResponse, IPConfigurationBgpPeeringAddressResponseArgs
- Default
Bgp List<string>Ip Addresses - The list of default BGP peering addresses which belong to IP configuration.
- Tunnel
Ip List<string>Addresses - The list of tunnel public IP addresses which belong to IP configuration.
- Custom
Bgp List<string>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- Ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- Default
Bgp []stringIp Addresses - The list of default BGP peering addresses which belong to IP configuration.
- Tunnel
Ip []stringAddresses - The list of tunnel public IP addresses which belong to IP configuration.
- Custom
Bgp []stringIp Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- Ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- default
Bgp List<String>Ip Addresses - The list of default BGP peering addresses which belong to IP configuration.
- tunnel
Ip List<String>Addresses - The list of tunnel public IP addresses which belong to IP configuration.
- custom
Bgp List<String>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id String - The ID of IP configuration which belongs to gateway.
- default
Bgp string[]Ip Addresses - The list of default BGP peering addresses which belong to IP configuration.
- tunnel
Ip string[]Addresses - The list of tunnel public IP addresses which belong to IP configuration.
- custom
Bgp string[]Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- default_
bgp_ Sequence[str]ip_ addresses - The list of default BGP peering addresses which belong to IP configuration.
- tunnel_
ip_ Sequence[str]addresses - The list of tunnel public IP addresses which belong to IP configuration.
- custom_
bgp_ Sequence[str]ip_ addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration_
id str - The ID of IP configuration which belongs to gateway.
- default
Bgp List<String>Ip Addresses - The list of default BGP peering addresses which belong to IP configuration.
- tunnel
Ip List<String>Addresses - The list of tunnel public IP addresses which belong to IP configuration.
- custom
Bgp List<String>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id String - The ID of IP configuration which belongs to gateway.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:network:LocalNetworkGateway localgw /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0