NetworkExtensions.GetVpnGateway Method

Reference

Definition

Namespace:: Azure.ResourceManager.Network

Assembly:: Azure.ResourceManager.Network.dll

Package:: Azure.ResourceManager.Network v1.7.0

Package:: Azure.ResourceManager.Network v1.6.0-beta.1

Source:: NetworkExtensions.cs

Source:: NetworkExtensions.cs

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 virtual wan vpn gateway.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}
Operation Id: VpnGateways_Get
Default Api Version: 2023-09-01
Resource: VpnGatewayResource

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 instance the method will execute against.

gatewayName: String

The name of the gateway.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<VpnGatewayResource>

Exceptions

ArgumentNullException

resourceGroupResource or gatewayName is null.

ArgumentException

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

Applies to