NetworkExtensions.GetLocalNetworkGatewayAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.9.0

Source:

NetworkExtensions.cs

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: 2024-03-01
• Resource: LocalNetworkGatewayResource

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

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

<Extension()>
Public Function GetLocalNetworkGatewayAsync (resourceGroupResource As ResourceGroupResource, localNetworkGatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Task<Response<LocalNetworkGatewayResource>>

Exceptions

ArgumentNullException

resourceGroupResource or localNetworkGatewayName is null.

ArgumentException

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