VirtualNetworkGatewayCollection.GetIfExistsAsync Method

Definition

Namespace:
Azure.ResourceManager.Network
Assembly:
Azure.ResourceManager.Network.dll
Package:
Azure.ResourceManager.Network v1.16.1
Package:
Azure.ResourceManager.Network v1.11.0-beta.2
Source:
VirtualNetworkGatewayCollection.cs
Source:
VirtualNetworkGatewayCollection.cs

Tries to get details for this resource from the service.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}.
  • Operation Id. : VirtualNetworkGateways_Get.
  • Default Api Version. : 2025-07-01. 
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.VirtualNetworkGatewayResource>> GetIfExistsAsync(string virtualNetworkGatewayName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.VirtualNetworkGatewayResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.VirtualNetworkGatewayResource>>
Public Overridable Function GetIfExistsAsync (virtualNetworkGatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of VirtualNetworkGatewayResource))

Parameters

virtualNetworkGatewayName
String

The name of the virtual network gateway.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<VirtualNetworkGatewayResource>>

Exceptions

ArgumentNullException

virtualNetworkGatewayName is null.

ArgumentException

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

Applies to