NetworkExtensions.GetExpressRouteCircuitAsync Method

Definition

Gets information about the specified express route circuit.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}
  • Operation Id: ExpressRouteCircuits_Get
  • Default Api Version: 2024-03-01
  • Resource: ExpressRouteCircuitResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.ExpressRouteCircuitResource>> GetExpressRouteCircuitAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string circuitName, System.Threading.CancellationToken cancellationToken = default);
static member GetExpressRouteCircuitAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.ExpressRouteCircuitResource>>
<Extension()>
Public Function GetExpressRouteCircuitAsync (resourceGroupResource As ResourceGroupResource, circuitName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ExpressRouteCircuitResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

circuitName
String

The name of express route circuit.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or circuitName is null.

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

Applies to