NetworkExtensions.GetVirtualNetworkGatewayConnectionAsync Method

Definition

Gets the specified virtual network gateway connection by resource group.

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

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

virtualNetworkGatewayConnectionName
String

The name of the virtual network gateway connection.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or virtualNetworkGatewayConnectionName is null.

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

Applies to