LocalNetworkGatewayCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.1

Source:

LocalNetworkGatewayCollection.cs

Tries to get details for this resource from the service.

• Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}.
• Operation Id. : LocalNetworkGateways_Get.
• Default Api Version. : 2025-07-01.

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.LocalNetworkGatewayResource>> GetIfExistsAsync(string localNetworkGatewayName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.LocalNetworkGatewayResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Network.LocalNetworkGatewayResource>>

Public Overridable Function GetIfExistsAsync (localNetworkGatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of LocalNetworkGatewayResource))

Parameters

localNetworkGatewayName

String

The name of the local network gateway.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<LocalNetworkGatewayResource>>

Exceptions

ArgumentNullException

localNetworkGatewayName is null.

ArgumentException

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