IVirtualNetworkGatewaysOperations.BeginGetBgpPeerStatusWithHttpMessagesAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.Network.Fluent
Assembly:
Microsoft.Azure.Management.Network.Fluent.dll
Package:
Microsoft.Azure.Management.Network.Fluent v1.38.1

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.Network.Fluent.Models.BgpPeerStatusListResultInner>> BeginGetBgpPeerStatusWithHttpMessagesAsync (string resourceGroupName, string virtualNetworkGatewayName, string peer = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member BeginGetBgpPeerStatusWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.Network.Fluent.Models.BgpPeerStatusListResultInner>>
Public Function BeginGetBgpPeerStatusWithHttpMessagesAsync (resourceGroupName As String, virtualNetworkGatewayName As String, Optional peer As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of BgpPeerStatusListResultInner))

Parameters

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.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<BgpPeerStatusListResultInner>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Applies to