NetworkExtensions.GetVpnGateway Method

Definition

Namespace:
Azure.ResourceManager.Network
Assembly:
Azure.ResourceManager.Network.dll
Package:
Azure.ResourceManager.Network v1.16.1
Package:
Azure.ResourceManager.Network v1.11.0-beta.2
Source:
NetworkExtensions.cs
Source:
NetworkExtensions.cs

Retrieves the details of a virtual wan vpn gateway. <item> Mocking. To mock this method, please mock GetVpnGateway(String, CancellationToken) instead. </item>

public static Azure.Response<Azure.ResourceManager.Network.VpnGatewayResource> GetVpnGateway(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string gatewayName, System.Threading.CancellationToken cancellationToken = default);
static member GetVpnGateway : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Network.VpnGatewayResource>
<Extension()>
Public Function GetVpnGateway (resourceGroupResource As ResourceGroupResource, gatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of VpnGatewayResource)

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource the method will execute against.

gatewayName
String

The name of the gateway.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<VpnGatewayResource>

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.

Applies to