Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getVirtualNetworkGatewayBgpPeerStatus
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getVirtualNetworkGatewayBgpPeerStatus

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

The GetBgpPeerStatus operation retrieves the status of all BGP peers. Azure REST API version: 2023-02-01.

Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

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>
Copy
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]
Copy
func GetVirtualNetworkGatewayBgpPeerStatus(ctx *Context, args *GetVirtualNetworkGatewayBgpPeerStatusArgs, opts ...InvokeOption) (*GetVirtualNetworkGatewayBgpPeerStatusResult, error)
func GetVirtualNetworkGatewayBgpPeerStatusOutput(ctx *Context, args *GetVirtualNetworkGatewayBgpPeerStatusOutputArgs, opts ...InvokeOption) GetVirtualNetworkGatewayBgpPeerStatusResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetVirtualNetworkGatewayBgpPeerStatusResult> getVirtualNetworkGatewayBgpPeerStatus(GetVirtualNetworkGatewayBgpPeerStatusArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkGatewayBgpPeerStatusResult> getVirtualNetworkGatewayBgpPeerStatus(GetVirtualNetworkGatewayBgpPeerStatusArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVirtualNetworkGatewayBgpPeerStatus
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
Peer string
The IP address of the peer to retrieve the status of.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
Peer string
The IP address of the peer to retrieve the status of.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network gateway.
peer String
The IP address of the peer to retrieve the status of.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
peer string
The IP address of the peer to retrieve the status of.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
virtual_network_gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the virtual network gateway.
peer str
The IP address of the peer to retrieve the status of.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
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 []BgpPeerStatusResponse
List of BGP peers.
value BgpPeerStatusResponse[]
List of BGP peers.
value List<Property Map>
List of BGP peers.

Supporting Types

BgpPeerStatusResponse

Asn This property is required. double
The autonomous system number of the remote BGP peer.
ConnectedDuration This property is required. string
For how long the peering has been up.
LocalAddress This property is required. string
The virtual network gateway's local address.
MessagesReceived This property is required. double
The number of BGP messages received.
MessagesSent This property is required. double
The number of BGP messages sent.
Neighbor This property is required. string
The remote BGP peer.
RoutesReceived This property is required. double
The number of routes learned from this peer.
State This property is required. string
The BGP peer state.
Asn This property is required. float64
The autonomous system number of the remote BGP peer.
ConnectedDuration This property is required. string
For how long the peering has been up.
LocalAddress This property is required. string
The virtual network gateway's local address.
MessagesReceived This property is required. float64
The number of BGP messages received.
MessagesSent This property is required. float64
The number of BGP messages sent.
Neighbor This property is required. string
The remote BGP peer.
RoutesReceived This property is required. float64
The number of routes learned from this peer.
State This property is required. string
The BGP peer state.
asn This property is required. Double
The autonomous system number of the remote BGP peer.
connectedDuration This property is required. String
For how long the peering has been up.
localAddress This property is required. String
The virtual network gateway's local address.
messagesReceived This property is required. Double
The number of BGP messages received.
messagesSent This property is required. Double
The number of BGP messages sent.
neighbor This property is required. String
The remote BGP peer.
routesReceived This property is required. Double
The number of routes learned from this peer.
state This property is required. String
The BGP peer state.
asn This property is required. number
The autonomous system number of the remote BGP peer.
connectedDuration This property is required. string
For how long the peering has been up.
localAddress This property is required. string
The virtual network gateway's local address.
messagesReceived This property is required. number
The number of BGP messages received.
messagesSent This property is required. number
The number of BGP messages sent.
neighbor This property is required. string
The remote BGP peer.
routesReceived This property is required. number
The number of routes learned from this peer.
state This property is required. string
The BGP peer state.
asn This property is required. float
The autonomous system number of the remote BGP peer.
connected_duration This property is required. str
For how long the peering has been up.
local_address This property is required. str
The virtual network gateway's local address.
messages_received This property is required. float
The number of BGP messages received.
messages_sent This property is required. float
The number of BGP messages sent.
neighbor This property is required. str
The remote BGP peer.
routes_received This property is required. float
The number of routes learned from this peer.
state This property is required. str
The BGP peer state.
asn This property is required. Number
The autonomous system number of the remote BGP peer.
connectedDuration This property is required. String
For how long the peering has been up.
localAddress This property is required. String
The virtual network gateway's local address.
messagesReceived This property is required. Number
The number of BGP messages received.
messagesSent This property is required. Number
The number of BGP messages sent.
neighbor This property is required. String
The remote BGP peer.
routesReceived This property is required. Number
The number of routes learned from this peer.
state This property is required. String
The BGP peer state.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native