NetworkExtensions.GetExpressRouteCircuitAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.1

Source:

NetworkExtensions.cs

Gets information about the specified express route circuit. <item> Mocking. To mock this method, please mock GetExpressRouteCircuitAsync(String, CancellationToken) instead. </item>

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 the method will execute against.

circuitName

String

The name of express route circuit.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ExpressRouteCircuitResource>>

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.