Share via


NetworkExtensions.GetVpnSiteAsync 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 static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnSiteResource>> GetVpnSiteAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string vpnSiteName, System.Threading.CancellationToken cancellationToken = default);
static member GetVpnSiteAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.VpnSiteResource>>
<Extension()>
Public Function GetVpnSiteAsync (resourceGroupResource As ResourceGroupResource, vpnSiteName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VpnSiteResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

vpnSiteName
String

The name of the VpnSite being retrieved.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or vpnSiteName is null.

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

Applies to