NetworkExtensions.GetVpnSite Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the details of a VPN site. <item> Mocking. To mock this method, please mock GetVpnSite(String, CancellationToken) instead. </item>
public static Azure.Response<Azure.ResourceManager.Network.VpnSiteResource> GetVpnSite(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string vpnSiteName, System.Threading.CancellationToken cancellationToken = default);
static member GetVpnSite : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Network.VpnSiteResource>
<Extension()>
Public Function GetVpnSite (resourceGroupResource As ResourceGroupResource, vpnSiteName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of VpnSiteResource)
Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource the method will execute against.
- 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.
resourceGroupResource is null.