Get Virtual Network Gateway Operation Status

Article
08/03/2016

The Get Virtual Network Gateway Operation Status operation returns the current status of the specified gateway operation.

Request

The Get Virtual Network Gateway Operation Status request may be specified as follows. Replace <subscription-id> with the subscription ID and <operation-id> with the ID of the operation for which you want to retrieve the status.

Method	Request URI
GET	https://management.core.windows.net/<subscription-id>/services/networking/operation/<operation-id>

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header	Description
x-ms-version	Required. Specifies the version of the operation to use for this request. The value for this header should be set to 2012-03-01 or higher.

Request Body

None.

Response

The response includes an HTTP status code, a response body, and a set of response headers.

Status Code

A successful operation returns status code 200 (OK).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header	Description
x-ms-request-id	A value that uniquely identifies a request made against the management service.

Response Body

The format of the response body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<GatewayOperation xmlns="https://schemas.microsoft.com/windowsazure">
  <ID>operation-id</ID>
  <Status>status</Status>
  <HttpStatusCode>async-http-status-code</HttpStatusCode>
  <Data>async-result-data</Data>
  <Error>
    <Code>error-code</Code>
    <Message>error-message</Message>
  </Error>
</GatewayOperation>

The following table describes the elements in the response body.

Response Element	Description
ID	Uniquely identifies the operation.
Status	Specifies the status of the asynchronous request. Possible values are: InProgress Successful Failed
HttpStatusCode	Specifies the HTTP status code for the asynchronous request.
Data	Specifies the response data that may accompany a successful asynchronous request. This value may vary based on the operation.
Error	Specifies error information related to the operation.

Error

Specifies error information related to the operation.

Response Element	Description
Code	Specifies the gateway service error code returned if the asynchronous request failed.
Message	Specifies the gateway service error message returned if the asynchronous request failed.

Share via