NetworkExtensions.GetExpressRouteGatewayAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.9.0

Source:

NetworkExtensions.cs

Fetches the details of a ExpressRoute gateway in a resource group.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}
• Operation Id: ExpressRouteGateways_Get
• Default Api Version: 2024-03-01
• Resource: ExpressRouteGatewayResource

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

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

<Extension()>
Public Function GetExpressRouteGatewayAsync (resourceGroupResource As ResourceGroupResource, expressRouteGatewayName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ExpressRouteGatewayResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

expressRouteGatewayName

String

The name of the ExpressRoute gateway.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ExpressRouteGatewayResource>>

Exceptions

ArgumentNullException

resourceGroupResource or expressRouteGatewayName is null.

ArgumentException

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