IGatewayOperations.BeginFailoverAsync Method

  • Article

Asynchronously initiates the forcing of a gateway failover, which deactivates the primary Virtual Network Gateway and switches over to a secondary gateway.

Namespace: Microsoft.WindowsAzure.Management.VirtualNetworks
Assembly: Microsoft.WindowsAzure.Management.VirtualNetworks (in Microsoft.WindowsAzure.Management.VirtualNetworks.dll)

Usage

'Usage
Dim instance As IGatewayOperations
Dim virtualNetworkName As String
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of GatewayOperationResponse)

returnValue = instance.BeginFailoverAsync(virtualNetworkName, cancellationToken)

Syntax

'Declaration
Function BeginFailoverAsync ( _
    virtualNetworkName As String, _
    cancellationToken As CancellationToken _
) As Task(Of GatewayOperationResponse)

Task<GatewayOperationResponse> BeginFailoverAsync (
    string virtualNetworkName,
    CancellationToken cancellationToken
)

Task<GatewayOperationResponse^>^ BeginFailoverAsync (
    String^ virtualNetworkName, 
    CancellationToken cancellationToken
)

Task<GatewayOperationResponse> BeginFailoverAsync (
    String virtualNetworkName, 
    CancellationToken cancellationToken
)

function BeginFailoverAsync (
    virtualNetworkName : String, 
    cancellationToken : CancellationToken
) : Task<GatewayOperationResponse>

Parameters

  • virtualNetworkName
    The name of the Virtual Network.
  • cancellationToken
    The cancellation token.

Return Value

An GatewayOperationResponse object that includes an HTTP status code and request ID.

Remarks

For more information about causing failovers, see Cause Virtual Network Gateway Failover.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms

See Also

Reference

IGatewayOperations Interface
IGatewayOperations Members
Microsoft.WindowsAzure.Management.VirtualNetworks Namespace