NetworkExtensions.GetVirtualNetworkGateway 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.

Gets the specified virtual network gateway by resource group.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}
Operation Id: VirtualNetworkGateways_Get
Default Api Version: 2023-09-01
Resource: VirtualNetworkGatewayResource

public static Azure.Response<Azure.ResourceManager.Network.VirtualNetworkGatewayResource> GetVirtualNetworkGateway (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string virtualNetworkGatewayName, System.Threading.CancellationToken cancellationToken = default);

static member GetVirtualNetworkGateway : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Network.VirtualNetworkGatewayResource>

<Extension()>
Public Function GetVirtualNetworkGateway (resourceGroupResource As ResourceGroupResource, virtualNetworkGatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of VirtualNetworkGatewayResource)

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

virtualNetworkGatewayName: String

The name of the virtual network gateway.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<VirtualNetworkGatewayResource>

Exceptions

ArgumentNullException

resourceGroupResource or virtualNetworkGatewayName is null.

ArgumentException

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

Applies to