SALES: 1-800-867-1380

Create Virtual Network Gateway


Updated: July 10, 2015

The Create Virtual Network Gateway operation creates a virtual network gateway for the specified virtual network.

The Create Virtual Network Gateway request may be specified as follows. Replace <subscription-id> with the subscription ID and <virtual-network-name> with the name of the virtual network associated with the virtual network gateway.


Request URI


You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.

The following table describes the request headers.

Request Header



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. For more information about versioning headers, see Service Management Versioning.

The format of the request body is as follows:


The following table describes the elements in the request body.

Element name



Optional. Specifies the type of gateway that is created. Possible values include StaticRouting or DynamicRouting.

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

If the virtual network gateway provisioning state is anything other than Not Provisioned, indicating that the gateway is being provisioned or already exists, this operation returns a status code of 409 (Conflict). A successful operation returns status code 201 (Created). 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.

Response Header



A value that uniquely identifies a request made against the management service.

The format of the response body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<GatewayOperationAsyncResponse xmlns="">

The following table describes the elements in the response body.

Response Element



Uniquely identifies the operation. This ID contains the same value as the request ID that is returned by the x-ms-request-id header. 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft