GatewayOperationsExtensions.Failover Method
Forces 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 GatewayGetOperationStatusResponse
returnValue = GatewayOperationsExtensions.Failover(operations, virtualNetworkName)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function Failover ( _
operations As IGatewayOperations, _
virtualNetworkName As String _
) As GatewayGetOperationStatusResponse
[ExtensionAttribute]
public static GatewayGetOperationStatusResponse Failover (
IGatewayOperations operations,
string virtualNetworkName
)
[ExtensionAttribute]
public:
static GatewayGetOperationStatusResponse^ Failover (
IGatewayOperations^ operations,
String^ virtualNetworkName
)
/** @attribute ExtensionAttribute() */
public static GatewayGetOperationStatusResponse Failover (
IGatewayOperations operations,
String virtualNetworkName
)
ExtensionAttribute
public static function Failover (
operations : IGatewayOperations,
virtualNetworkName : String
) : GatewayGetOperationStatusResponse
Parameters
- operations
The IGatewayOperations object that specifies the Virtual Network Gateway operations.
- virtualNetworkName
The name of the Virtual Network.
Return Value
The GatewayGetOperationStatusResponse object that contains the status of the operation.
Remarks
If the asynchronous operation succeeds, the response includes the HTTP status code for the successful request. If the asynchronous operation failed, the response includes the HTTP status code for the failed request, and also includes error information about the failure.
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 and Windows Server 2008
Target Platforms
See Also
Reference
GatewayOperationsExtensions Class
GatewayOperationsExtensions Members
Microsoft.WindowsAzure.Management.VirtualNetworks Namespace