Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Get Device Configuration Script

Get Device Configuration Script

Updated: July 10, 2015

The Get Device Configuration Script operation returns a script that you can use to configure local VPN devices to connect to the gateway.

The Get Device Configuration Script 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 gateway.


Method 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.


URI Parameter Description


Required. Specifies the vendor of the on-premise VPN device.


Required. Specifies the platform of the on-premise VPN device.


Required. Specifies the operating system family of the on-premise VPN device.

The following table describes the request headers.


Request Header Description


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 response includes an HTTP status code, a response body, and a set of response headers.

A successful operation returns status code 200 (OK). 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 Description


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

The response body contains the device configuration script as a text string that you can use to configure a VPN device.

© 2015 Microsoft