azure-native.network.getLocalNetworkGateway
Explore with Pulumi AI
Gets the specified local network gateway in a resource group. Azure REST API version: 2023-02-01.
Other available API versions: 2016-06-01, 2016-09-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-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:
- Local
Network stringGateway Name The name of the local network gateway.
- Resource
Group stringName The name of the resource group.
- Local
Network stringGateway Name The name of the local network gateway.
- Resource
Group stringName The name of the resource group.
- local
Network StringGateway Name The name of the local network gateway.
- resource
Group StringName The name of the resource group.
- local
Network stringGateway Name The name of the local network gateway.
- resource
Group stringName The name of the resource group.
- local_
network_ strgateway_ name The name of the local network gateway.
- resource_
group_ strname The name of the resource group.
- local
Network StringGateway Name The name of the local network gateway.
- resource
Group StringName 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.
- 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.
- Bgp
Settings Pulumi.Azure Native. Network. Outputs. Bgp Settings Response 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. Outputs. Address Space Response Local network site address space.
- Location string
Resource location.
- Dictionary<string, string>
Resource tags.
- Etag string
A unique read-only string that changes whenever the resource is updated.
- 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.
- Bgp
Settings BgpSettings Response 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 Response Local network site address space.
- Location string
Resource location.
- map[string]string
Resource tags.
- etag String
A unique read-only string that changes whenever the resource is updated.
- 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.
- bgp
Settings BgpSettings Response 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 Response Local network site address space.
- location String
Resource location.
- Map<String,String>
Resource tags.
- etag string
A unique read-only string that changes whenever the resource is updated.
- 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.
- bgp
Settings BgpSettings Response 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 Response Local network site address space.
- location string
Resource location.
- {[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 BgpSettings Response 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 Response Local network site address space.
- location str
Resource location.
- Mapping[str, str]
Resource tags.
- etag String
A unique read-only string that changes whenever the resource is updated.
- 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.
- 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.
- location String
Resource location.
- Map<String>
Resource tags.
Supporting Types
AddressSpaceResponse
- 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.
BgpSettingsResponse
- 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.
IPConfigurationBgpPeeringAddressResponse
- 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0