NetworkExtensions.GetLocalNetworkGateway 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 local network gateway in a resource group.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}
Operation Id: LocalNetworkGateways_Get
Default Api Version: 2023-09-01
Resource: LocalNetworkGatewayResource

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

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

<Extension()>
Public Function GetLocalNetworkGateway (resourceGroupResource As ResourceGroupResource, localNetworkGatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of LocalNetworkGatewayResource)

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

localNetworkGatewayName: String

The name of the local network gateway.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<LocalNetworkGatewayResource>

Exceptions

ArgumentNullException

resourceGroupResource or localNetworkGatewayName is null.

ArgumentException

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

Applies to