VirtualNetworkGatewayResource.GetBgpPeerStatusAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The GetBgpPeerStatus operation retrieves the status of all BGP peers.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus
- Operation Id: VirtualNetworkGateways_GetBgpPeerStatus
- Default Api Version: 2024-03-01
- Resource: VirtualNetworkGatewayResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.BgpPeerStatusListResult>> GetBgpPeerStatusAsync (Azure.WaitUntil waitUntil, string peer = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetBgpPeerStatusAsync : Azure.WaitUntil * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.BgpPeerStatusListResult>>
override this.GetBgpPeerStatusAsync : Azure.WaitUntil * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.Models.BgpPeerStatusListResult>>Public Overridable Function GetBgpPeerStatusAsync (waitUntil As WaitUntil, Optional peer As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of BgpPeerStatusListResult))Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- peer
- String
The IP address of the peer to retrieve the status of.
- cancellationToken
- CancellationToken
The cancellation token to use.
