VpnSiteCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.1

Source:

VpnSiteCollection.cs

Tries to get details for this resource from the service.

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

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

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

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

Parameters

vpnSiteName

String

The name of the VpnSite being retrieved.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<VpnSiteResource>>

Exceptions

ArgumentNullException

vpnSiteName is null.

ArgumentException

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