Share via


NetworkExtensions.GetVirtualNetworkGatewayAsync Method

Definition

Gets the specified virtual network gateway by resource group.

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

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

virtualNetworkGatewayName
String

The name of the virtual network gateway.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or virtualNetworkGatewayName is null.

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

Applies to