ExpressRouteGatewayResource.StopSiteFailoverTestAsync Method

Definition

Stops failover simulation on the ExpressRoute gateway for the specified peering location.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/stopSiteFailoverTest.
  • Operation Id. : ExpressRouteGateways_StopSiteFailoverTest.
  • Default Api Version. : 2025-07-01.
  • Resource. : ExpressRouteGatewayResource.
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>> StopSiteFailoverTestAsync(Azure.WaitUntil waitUntil, Azure.ResourceManager.Network.Models.StopSiteFailoverTestParameterBody body, System.Threading.CancellationToken cancellationToken = default);
abstract member StopSiteFailoverTestAsync : Azure.WaitUntil * Azure.ResourceManager.Network.Models.StopSiteFailoverTestParameterBody * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>>
override this.StopSiteFailoverTestAsync : Azure.WaitUntil * Azure.ResourceManager.Network.Models.StopSiteFailoverTestParameterBody * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<string>>
Public Overridable Function StopSiteFailoverTestAsync (waitUntil As WaitUntil, body As StopSiteFailoverTestParameterBody, 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.

body
StopSiteFailoverTestParameterBody

The content of the action request.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

body is null.

Applies to