ExpressRouteCircuitResource.StartCircuitLinkFailoverTestAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.1

Source:

ExpressRouteCircuitResource.cs

Starts link failover simulation on the express route circuit for the specified link type and test category.

• Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/startCircuitLinkFailoverTest.
• Operation Id. : ExpressRouteCircuits_StartCircuitLinkFailoverTest.
• Default Api Version. : 2025-07-01.
• Resource. : ExpressRouteCircuitResource.

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>> StartCircuitLinkFailoverTestAsync(Azure.WaitUntil waitUntil, string linkType, string circuitTestCategory, System.Threading.CancellationToken cancellationToken = default);

abstract member StartCircuitLinkFailoverTestAsync : Azure.WaitUntil * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>>
override this.StartCircuitLinkFailoverTestAsync : Azure.WaitUntil * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>>

Public Overridable Function StartCircuitLinkFailoverTestAsync (waitUntil As WaitUntil, linkType As String, circuitTestCategory As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of String))

Parameters

waitUntil

WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

linkType

String

The link type.

circuitTestCategory

String

The circuit test category.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<String>>

Exceptions

ArgumentNullException

linkType or circuitTestCategory is null.

ArgumentException

linkType or circuitTestCategory is an empty string, and was expected to be non-empty.