Create Virtual Network Gateway
The Create Virtual Network Gateway operation creates a virtual network gateway for the specified virtual network.
Request
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.
Method |
Request URI |
|---|---|
POST |
https://management.core.windows.net/<subscription-id>/services/networking/<virtual-network-name>/gateway |
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
The format of the request body is as follows:
<CreateGatewayParameters>
<gatewayType>gateway-type</gatewayType>
</CreateGatewayParameters>
The following table describes the elements in the request body.
Element name |
Description |
|---|---|
gatewayType |
Optional. Specifies the type of gateway that is created. Possible values include StaticRouting or DynamicRouting. |
Response
The response includes an HTTP status code, a response body, and a set of response headers.
Status Code
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).
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"?>
<GatewayOperationAsyncResponse xmlns="https://schemas.microsoft.com/windowsazure">
<ID>operation-id</ID>
</GatewayOperationAsyncResponse>
The following table describes the elements in the response body.
Response Element |
Description |
|---|---|
ID |
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. |