NetworkExtensions.GetVpnGatewayAsync Method

Definition

Retrieves the details of a virtual wan vpn gateway.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}
  • Operation Id: VpnGateways_Get
  • Default Api Version: 2024-03-01
  • Resource: VpnGatewayResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnGatewayResource>> GetVpnGatewayAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string gatewayName, System.Threading.CancellationToken cancellationToken = default);
static member GetVpnGatewayAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnGatewayResource>>
<Extension()>
Public Function GetVpnGatewayAsync (resourceGroupResource As ResourceGroupResource, gatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VpnGatewayResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

gatewayName
String

The name of the gateway.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or gatewayName is null.

gatewayName is an empty string, and was expected to be non-empty.

Applies to