NetworkExtensions.GetNatGatewayAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.9.0

Source:

NetworkExtensions.cs

Gets the specified nat gateway in a specified resource group.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}
• Operation Id: NatGateways_Get
• Default Api Version: 2024-03-01
• Resource: NatGatewayResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.NatGatewayResource>> GetNatGatewayAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string natGatewayName, string expand = default, System.Threading.CancellationToken cancellationToken = default);

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

<Extension()>
Public Function GetNatGatewayAsync (resourceGroupResource As ResourceGroupResource, natGatewayName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of NatGatewayResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

natGatewayName

String

The name of the nat gateway.

expand

String

Expands referenced resources.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<NatGatewayResource>>

Exceptions

ArgumentNullException

resourceGroupResource or natGatewayName is null.

ArgumentException

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