Generate VPN Client Package
Updated: December 10, 2013
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 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|
The following table describes the request headers.
Required. Specifies the version of the operation to use for this request. The value for this header should be set to
The format of the request body is as follows:
<VpnClientParameters> <ProcessorArchitecture>architecture-of-processor</ProcessorArchitecture> </VpnClientParameters>
The following table describes the elements in the request body:
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.
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.
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.
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 elements in the response body:
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.
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.