IGatewayOperations.FailoverAsync Method
Asynchronously 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 instance As IGatewayOperations
Dim virtualNetworkName As String
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of GatewayGetOperationStatusResponse)
returnValue = instance.FailoverAsync(virtualNetworkName, cancellationToken)
Syntax
'Declaration
Function FailoverAsync ( _
virtualNetworkName As String, _
cancellationToken As CancellationToken _
) As Task(Of GatewayGetOperationStatusResponse)
Task<GatewayGetOperationStatusResponse> FailoverAsync (
string virtualNetworkName,
CancellationToken cancellationToken
)
Task<GatewayGetOperationStatusResponse^>^ FailoverAsync (
String^ virtualNetworkName,
CancellationToken cancellationToken
)
Task<GatewayGetOperationStatusResponse> FailoverAsync (
String virtualNetworkName,
CancellationToken cancellationToken
)
function FailoverAsync (
virtualNetworkName : String,
cancellationToken : CancellationToken
) : Task<GatewayGetOperationStatusResponse>
Parameters
- virtualNetworkName
The name of the Virtual Network.
- cancellationToken
The cancellation token.
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
IGatewayOperations Interface
IGatewayOperations Members
Microsoft.WindowsAzure.Management.VirtualNetworks Namespace