NetworkExtensions.GetLocalNetworkGateway Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.1

Source:

NetworkExtensions.cs

Gets the specified local network gateway in a resource group. <item> Mocking. To mock this method, please mock GetLocalNetworkGateway(String, CancellationToken) instead. </item>

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 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

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.