Cause Virtual Network Gateway Failover
Updated: December 6, 2013
The Cause Virtual Network Gateway Failover operation forces a gateway failover, deactivating the primary virtual network gateway and switching over to a secondary gateway.
The Cause Virtual Network Gateway Failover request may be constructed as follows. Replace
<subscription-id> with the name of your subscription ID, and
<virtual-network-name> with the name of the virtual network associated with the virtual network gateway.
|Method||Request URI||HTTP Version|
The following table describes the request headers.
Required. Specifies the version of the operation to use for this request. The value for this header should be set to
The request body is as follows:
<?xml version="1.0" encoding="utf-8"?> <UpdateGateway xmlns="http://schemas.microsoft.com/windowsazure"> <UpdateGatewayOperation>gateway-operation</UpdateGatewayOperation> </UpdateGateway>
The following table describes the elements in the request body.
Specifies the operation to perform on the gateway. To cause the gateway failover, set this element to Failover.
The response includes an HTTP status code, a response body, and a set of response headers.
A successful operation returns status code 202 (Accept). If a Failover operation is already in progress on the associated virtual network, this operation returns status code 409 (Conflict). If the operation is executed by a subscription without authorization to perform the operation, it will return status code 403 (Forbidden). For information about status codes, see Service Management Status and Error Codes.
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.
The format of the response body is as follows:
<?xml version="1.0" encoding="utf-8"?> <GatewayOperationAsyncResponse xmlns="http://schemas.microsoft.com/windowsazure"> <ID>operation-id</ID> </OperationOperationAsyncResponse>
The following table describes the elements in the response body.
Uniquely identifies the operation. To get more information about the status of an operation, such as whether it is still executing or complete, you can call Get Virtual Network Gateway Operation Status with the operation ID.
Only explicitly authorized subscriptions can execute this operation.
A gateway failover deactivates the primary virtual network gateway and enables an alternate secondary gateway to replace it, if one has been created.