GatewayOperationsExtensions.BeginFailover Method

  • Article

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 operations As IGatewayOperations
Dim virtualNetworkName As String
Dim returnValue As GatewayOperationResponse

returnValue = GatewayOperationsExtensions.BeginFailover(operations, virtualNetworkName)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function BeginFailover ( _
    operations As IGatewayOperations, _
    virtualNetworkName As String _
) As GatewayOperationResponse

[ExtensionAttribute] 
public static GatewayOperationResponse BeginFailover (
    IGatewayOperations operations,
    string virtualNetworkName
)

[ExtensionAttribute] 
public:
static GatewayOperationResponse^ BeginFailover (
    IGatewayOperations^ operations, 
    String^ virtualNetworkName
)

/** @attribute ExtensionAttribute() */ 
public static GatewayOperationResponse BeginFailover (
    IGatewayOperations operations, 
    String virtualNetworkName
)

ExtensionAttribute 
public static function BeginFailover (
    operations : IGatewayOperations, 
    virtualNetworkName : String
) : GatewayOperationResponse

Parameters

  • operations
    The IGatewayOperations object that specifies the Virtual Network Gateway operations.
  • virtualNetworkName
    The name of the Virtual Network.

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

GatewayOperationsExtensions Class
GatewayOperationsExtensions Members
Microsoft.WindowsAzure.Management.VirtualNetworks Namespace