Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getLocalNetworkGateway

A common class for general resource information. API Version: 2020-11-01.

Using getLocalNetworkGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLocalNetworkGateway(args: GetLocalNetworkGatewayArgs, opts?: InvokeOptions): Promise<GetLocalNetworkGatewayResult>
function getLocalNetworkGatewayOutput(args: GetLocalNetworkGatewayOutputArgs, opts?: InvokeOptions): Output<GetLocalNetworkGatewayResult>
def get_local_network_gateway(local_network_gateway_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetLocalNetworkGatewayResult
def get_local_network_gateway_output(local_network_gateway_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetLocalNetworkGatewayResult]
func LookupLocalNetworkGateway(ctx *Context, args *LookupLocalNetworkGatewayArgs, opts ...InvokeOption) (*LookupLocalNetworkGatewayResult, error)
func LookupLocalNetworkGatewayOutput(ctx *Context, args *LookupLocalNetworkGatewayOutputArgs, opts ...InvokeOption) LookupLocalNetworkGatewayResultOutput

> Note: This function is named LookupLocalNetworkGateway in the Go SDK.

public static class GetLocalNetworkGateway 
{
    public static Task<GetLocalNetworkGatewayResult> InvokeAsync(GetLocalNetworkGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetLocalNetworkGatewayResult> Invoke(GetLocalNetworkGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLocalNetworkGatewayResult> getLocalNetworkGateway(GetLocalNetworkGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:network:getLocalNetworkGateway
  Arguments:
    # Arguments dictionary

The following arguments are supported:

LocalNetworkGatewayName string

The name of the local network gateway.

ResourceGroupName string

The name of the resource group.

LocalNetworkGatewayName string

The name of the local network gateway.

ResourceGroupName string

The name of the resource group.

localNetworkGatewayName String

The name of the local network gateway.

resourceGroupName String

The name of the resource group.

localNetworkGatewayName string

The name of the local network gateway.

resourceGroupName string

The name of the resource group.

local_network_gateway_name str

The name of the local network gateway.

resource_group_name str

The name of the resource group.

localNetworkGatewayName String

The name of the local network gateway.

resourceGroupName String

The name of the resource group.

getLocalNetworkGateway Result

The following output properties are available:

Etag string

A unique read-only string that changes whenever the resource is updated.

Name string

Resource name.

ProvisioningState string

The provisioning state of the local network gateway resource.

ResourceGuid string

The resource GUID property of the local network gateway resource.

Type string

Resource type.

BgpSettings Pulumi.AzureNative.Network.Outputs.BgpSettingsResponse

Local network gateway's BGP speaker settings.

Fqdn string

FQDN of local network gateway.

GatewayIpAddress string

IP address of local network gateway.

Id string

Resource ID.

LocalNetworkAddressSpace Pulumi.AzureNative.Network.Outputs.AddressSpaceResponse

Local network site address space.

Location string

Resource location.

Tags Dictionary<string, string>

Resource tags.

Etag string

A unique read-only string that changes whenever the resource is updated.

Name string

Resource name.

ProvisioningState string

The provisioning state of the local network gateway resource.

ResourceGuid string

The resource GUID property of the local network gateway resource.

Type string

Resource type.

BgpSettings BgpSettingsResponse

Local network gateway's BGP speaker settings.

Fqdn string

FQDN of local network gateway.

GatewayIpAddress string

IP address of local network gateway.

Id string

Resource ID.

LocalNetworkAddressSpace AddressSpaceResponse

Local network site address space.

Location string

Resource location.

Tags map[string]string

Resource tags.

etag String

A unique read-only string that changes whenever the resource is updated.

name String

Resource name.

provisioningState String

The provisioning state of the local network gateway resource.

resourceGuid String

The resource GUID property of the local network gateway resource.

type String

Resource type.

bgpSettings BgpSettingsResponse

Local network gateway's BGP speaker settings.

fqdn String

FQDN of local network gateway.

gatewayIpAddress String

IP address of local network gateway.

id String

Resource ID.

localNetworkAddressSpace AddressSpaceResponse

Local network site address space.

location String

Resource location.

tags Map

Resource tags.

etag string

A unique read-only string that changes whenever the resource is updated.

name string

Resource name.

provisioningState string

The provisioning state of the local network gateway resource.

resourceGuid string

The resource GUID property of the local network gateway resource.

type string

Resource type.

bgpSettings BgpSettingsResponse

Local network gateway's BGP speaker settings.

fqdn string

FQDN of local network gateway.

gatewayIpAddress string

IP address of local network gateway.

id string

Resource ID.

localNetworkAddressSpace AddressSpaceResponse

Local network site address space.

location string

Resource location.

tags {[key: string]: string}

Resource tags.

etag str

A unique read-only string that changes whenever the resource is updated.

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.

bgp_settings BgpSettingsResponse

Local network gateway's BGP speaker settings.

fqdn str

FQDN of local network gateway.

gateway_ip_address str

IP address of local network gateway.

id str

Resource ID.

local_network_address_space AddressSpaceResponse

Local network site address space.

location str

Resource location.

tags Mapping[str, str]

Resource tags.

etag String

A unique read-only string that changes whenever the resource is updated.

name String

Resource name.

provisioningState String

The provisioning state of the local network gateway resource.

resourceGuid String

The resource GUID property of the local network gateway resource.

type String

Resource type.

bgpSettings Property Map

Local network gateway's BGP speaker settings.

fqdn String

FQDN of local network gateway.

gatewayIpAddress String

IP address of local network gateway.

id String

Resource ID.

localNetworkAddressSpace Property Map

Local network site address space.

location String

Resource location.

tags Map

Resource tags.

Supporting Types

AddressSpaceResponse

AddressPrefixes List<string>

A list of address blocks reserved for this virtual network in CIDR notation.

AddressPrefixes []string

A list of address blocks reserved for this virtual network in CIDR notation.

addressPrefixes List

A list of address blocks reserved for this virtual network in CIDR notation.

addressPrefixes 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.

addressPrefixes List

A list of address blocks reserved for this virtual network in CIDR notation.

BgpSettingsResponse

Asn double

The BGP speaker's ASN.

BgpPeeringAddress string

The BGP peering address and BGP identifier of this BGP speaker.

BgpPeeringAddresses List<Pulumi.AzureNative.Network.Inputs.IPConfigurationBgpPeeringAddressResponse>

BGP peering address with IP configuration ID for virtual network gateway.

PeerWeight int

The weight added to routes learned from this BGP speaker.

Asn float64

The BGP speaker's ASN.

BgpPeeringAddress string

The BGP peering address and BGP identifier of this BGP speaker.

BgpPeeringAddresses []IPConfigurationBgpPeeringAddressResponse

BGP peering address with IP configuration ID for virtual network gateway.

PeerWeight int

The weight added to routes learned from this BGP speaker.

asn Double

The BGP speaker's ASN.

bgpPeeringAddress String

The BGP peering address and BGP identifier of this BGP speaker.

bgpPeeringAddresses ListBgpPeeringAddressResponse>

BGP peering address with IP configuration ID for virtual network gateway.

peerWeight Integer

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.

bgpPeeringAddresses IPConfigurationBgpPeeringAddressResponse[]

BGP peering address with IP configuration ID for virtual network gateway.

peerWeight number

The weight added to routes learned from this BGP speaker.

asn float

The BGP speaker's ASN.

bgp_peering_address str

The BGP peering address and BGP identifier of this BGP speaker.

bgp_peering_addresses Sequence[IPConfigurationBgpPeeringAddressResponse]

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.

bgpPeeringAddress String

The BGP peering address and BGP identifier of this BGP speaker.

bgpPeeringAddresses List

BGP peering address with IP configuration ID for virtual network gateway.

peerWeight Number

The weight added to routes learned from this BGP speaker.

IPConfigurationBgpPeeringAddressResponse

DefaultBgpIpAddresses List<string>

The list of default BGP peering addresses which belong to IP configuration.

TunnelIpAddresses List<string>

The list of tunnel public IP addresses which belong to IP configuration.

CustomBgpIpAddresses List<string>

The list of custom BGP peering addresses which belong to IP configuration.

IpconfigurationId string

The ID of IP configuration which belongs to gateway.

DefaultBgpIpAddresses []string

The list of default BGP peering addresses which belong to IP configuration.

TunnelIpAddresses []string

The list of tunnel public IP addresses which belong to IP configuration.

CustomBgpIpAddresses []string

The list of custom BGP peering addresses which belong to IP configuration.

IpconfigurationId string

The ID of IP configuration which belongs to gateway.

defaultBgpIpAddresses List

The list of default BGP peering addresses which belong to IP configuration.

tunnelIpAddresses List

The list of tunnel public IP addresses which belong to IP configuration.

customBgpIpAddresses List

The list of custom BGP peering addresses which belong to IP configuration.

ipconfigurationId String

The ID of IP configuration which belongs to gateway.

defaultBgpIpAddresses string[]

The list of default BGP peering addresses which belong to IP configuration.

tunnelIpAddresses string[]

The list of tunnel public IP addresses which belong to IP configuration.

customBgpIpAddresses string[]

The list of custom BGP peering addresses which belong to IP configuration.

ipconfigurationId string

The ID of IP configuration which belongs to gateway.

default_bgp_ip_addresses Sequence[str]

The list of default BGP peering addresses which belong to IP configuration.

tunnel_ip_addresses Sequence[str]

The list of tunnel public IP addresses which belong to IP configuration.

custom_bgp_ip_addresses Sequence[str]

The list of custom BGP peering addresses which belong to IP configuration.

ipconfiguration_id str

The ID of IP configuration which belongs to gateway.

defaultBgpIpAddresses List

The list of default BGP peering addresses which belong to IP configuration.

tunnelIpAddresses List

The list of tunnel public IP addresses which belong to IP configuration.

customBgpIpAddresses List

The list of custom BGP peering addresses which belong to IP configuration.

ipconfigurationId String

The ID of IP configuration which belongs to gateway.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0