azure-native.network.getVirtualNetworkGatewayBgpPeerStatus

Explore with Pulumi AI

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

Using getVirtualNetworkGatewayBgpPeerStatus

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 getVirtualNetworkGatewayBgpPeerStatus(args: GetVirtualNetworkGatewayBgpPeerStatusArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkGatewayBgpPeerStatusResult>
function getVirtualNetworkGatewayBgpPeerStatusOutput(args: GetVirtualNetworkGatewayBgpPeerStatusOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkGatewayBgpPeerStatusResult>

def get_virtual_network_gateway_bgp_peer_status(peer: Optional[str] = None,
                                                resource_group_name: Optional[str] = None,
                                                virtual_network_gateway_name: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkGatewayBgpPeerStatusResult
def get_virtual_network_gateway_bgp_peer_status_output(peer: Optional[pulumi.Input[str]] = None,
                                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                                virtual_network_gateway_name: Optional[pulumi.Input[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkGatewayBgpPeerStatusResult]

func GetVirtualNetworkGatewayBgpPeerStatus(ctx *Context, args *GetVirtualNetworkGatewayBgpPeerStatusArgs, opts ...InvokeOption) (*GetVirtualNetworkGatewayBgpPeerStatusResult, error)
func GetVirtualNetworkGatewayBgpPeerStatusOutput(ctx *Context, args *GetVirtualNetworkGatewayBgpPeerStatusOutputArgs, opts ...InvokeOption) GetVirtualNetworkGatewayBgpPeerStatusResultOutput

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

public static class GetVirtualNetworkGatewayBgpPeerStatus 
{
    public static Task<GetVirtualNetworkGatewayBgpPeerStatusResult> InvokeAsync(GetVirtualNetworkGatewayBgpPeerStatusArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkGatewayBgpPeerStatusResult> Invoke(GetVirtualNetworkGatewayBgpPeerStatusInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualNetworkGatewayBgpPeerStatusResult> getVirtualNetworkGatewayBgpPeerStatus(GetVirtualNetworkGatewayBgpPeerStatusArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:network:getVirtualNetworkGatewayBgpPeerStatus
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group.
VirtualNetworkGatewayName string: The name of the virtual network gateway.
Peer string: The IP address of the peer to retrieve the status of.

ResourceGroupName string: The name of the resource group.
VirtualNetworkGatewayName string: The name of the virtual network gateway.
Peer string: The IP address of the peer to retrieve the status of.

resourceGroupName String: The name of the resource group.
virtualNetworkGatewayName String: The name of the virtual network gateway.
peer String: The IP address of the peer to retrieve the status of.

resourceGroupName string: The name of the resource group.
virtualNetworkGatewayName string: The name of the virtual network gateway.
peer string: The IP address of the peer to retrieve the status of.

resource_group_name str: The name of the resource group.
virtual_network_gateway_name str: The name of the virtual network gateway.
peer str: The IP address of the peer to retrieve the status of.

resourceGroupName String: The name of the resource group.
virtualNetworkGatewayName String: The name of the virtual network gateway.
peer String: The IP address of the peer to retrieve the status of.

getVirtualNetworkGatewayBgpPeerStatus Result

The following output properties are available:

Value List<Pulumi.AzureNative.Network.Outputs.BgpPeerStatusResponse>: List of BGP peers.

Value []BgpPeerStatusResponse: List of BGP peers.

value List<BgpPeerStatusResponse>: List of BGP peers.

value BgpPeerStatusResponse[]: List of BGP peers.

value Sequence[BgpPeerStatusResponse]: List of BGP peers.

value List<Property Map>: List of BGP peers.

Supporting Types

BgpPeerStatusResponse

Asn double: The autonomous system number of the remote BGP peer.
ConnectedDuration string: For how long the peering has been up.
LocalAddress string: The virtual network gateway's local address.
MessagesReceived double: The number of BGP messages received.
MessagesSent double: The number of BGP messages sent.
Neighbor string: The remote BGP peer.
RoutesReceived double: The number of routes learned from this peer.
State string: The BGP peer state.

Asn float64: The autonomous system number of the remote BGP peer.
ConnectedDuration string: For how long the peering has been up.
LocalAddress string: The virtual network gateway's local address.
MessagesReceived float64: The number of BGP messages received.
MessagesSent float64: The number of BGP messages sent.
Neighbor string: The remote BGP peer.
RoutesReceived float64: The number of routes learned from this peer.
State string: The BGP peer state.

asn Double: The autonomous system number of the remote BGP peer.
connectedDuration String: For how long the peering has been up.
localAddress String: The virtual network gateway's local address.
messagesReceived Double: The number of BGP messages received.
messagesSent Double: The number of BGP messages sent.
neighbor String: The remote BGP peer.
routesReceived Double: The number of routes learned from this peer.
state String: The BGP peer state.

asn number: The autonomous system number of the remote BGP peer.
connectedDuration string: For how long the peering has been up.
localAddress string: The virtual network gateway's local address.
messagesReceived number: The number of BGP messages received.
messagesSent number: The number of BGP messages sent.
neighbor string: The remote BGP peer.
routesReceived number: The number of routes learned from this peer.
state string: The BGP peer state.

asn float: The autonomous system number of the remote BGP peer.
connected_duration str: For how long the peering has been up.
local_address str: The virtual network gateway's local address.
messages_received float: The number of BGP messages received.
messages_sent float: The number of BGP messages sent.
neighbor str: The remote BGP peer.
routes_received float: The number of routes learned from this peer.
state str: The BGP peer state.

asn Number: The autonomous system number of the remote BGP peer.
connectedDuration String: For how long the peering has been up.
localAddress String: The virtual network gateway's local address.
messagesReceived Number: The number of BGP messages received.
messagesSent Number: The number of BGP messages sent.
neighbor String: The remote BGP peer.
routesReceived Number: The number of routes learned from this peer.
state String: The BGP peer state.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.network.getVirtualNetworkGatewayBgpPeerStatus

On this page

On this page

Using getVirtualNetworkGatewayBgpPeerStatus

getVirtualNetworkGatewayBgpPeerStatus Result

Supporting Types

BgpPeerStatusResponse

Package Details

On this page

On this page