Generate VPN Client Package


The Generate VPN Client Package creates a VPN client package for the specified virtual network and gateway.


The Generate VPN Client Package 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


URI Parameters


Request Headers

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.

Request Body

The format of the request body is as follows:


The following table describes the elements in the request body.

Element name



Required. Specifies the architecture of the processor for which the VPN client package is requested. Possible values include Amd64 or X86.


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

Status Code

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



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="">

The following table describes the elements in the response body.

Response Element



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.


If Status in the response from Get Virtual Network Gateway Operation Status is Succeeded, then Data in the response contains the Shared Access Signature (SAS) URL to the VPN client package. You can directly access the SAS URL in a browser to download the package.