Create Virtual Network Gateway
Updated: June 7, 2012
The Create Virtual Network Gateway operation creates a virtual network gateway for the specified virtual network.
The Create Virtual Network Gateway 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 |
|---|---|---|
|
POST |
|
HTTP/1.1 |
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. For more information, see Versioning for the Blob, Queue, and Table services in Windows Azure. |
Request Body
The format of the request body is as follows:
<CreateGatewayParameters> <GatewayType>gateway-type</GatewayType> </CreateGatewayParameters>
The following table describes the key elements in the request body:
| Element name | Description |
|---|---|
|
GatewayType |
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.
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). For information about status codes, see Service Management Status and Error Codes.
Response Headers
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 | Description |
|---|---|
|
x-ms-request-id |
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations. |
Response Body
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> </GatewayOperationAsyncResponse>
The following table describes the key elements in the response body:
| Response Element | Description |
|---|---|
|
ID |
Uniquely identifies the operation. This ID contains the 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. |
Any management certificate associated with the subscription specified by <subscription-id> can be used to authenticate this operation. For additional details, see Authenticating Service Management Requests.
The operation ID returned in the response body of this operation is the same value as the request ID that is returned by the x-ms-request-id header. Each value contains the same ID that uniquely identifies the operation.