VirtualNetworkGatewayResource.StartExpressRouteSiteFailoverSimulationAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.1

Source:

VirtualNetworkGatewayResource.cs

This operation starts failover simulation on the gateway for the specified peering location

• Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startSiteFailoverTest.
• Operation Id. : VirtualNetworkGateways_StartExpressRouteSiteFailoverSimulation.
• Default Api Version. : 2025-07-01.
• Resource. : VirtualNetworkGatewayResource.

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

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

Public Overridable Function StartExpressRouteSiteFailoverSimulationAsync (waitUntil As WaitUntil, peeringLocation 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.

peeringLocation

String

Peering location of the test.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<String>>

Exceptions

ArgumentNullException

peeringLocation is null.

ArgumentException

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