VpnSiteCollection.GetAsync(String, CancellationToken) Method

Definition

Retrieves the details of a VPN site.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}
  • Operation Id: VpnSites_Get
  • Default Api Version: 2024-03-01
  • Resource: VpnSiteResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnSiteResource>> GetAsync (string vpnSiteName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnSiteResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnSiteResource>>
Public Overridable Function GetAsync (vpnSiteName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VpnSiteResource))

Parameters

vpnSiteName
String

The name of the VpnSite being retrieved.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

vpnSiteName is null.

Applies to