Get Device Configuration Script
The Get Device Configuration Script operation returns a script that you can use to configure local VPN devices to connect to the gateway.
Request
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 |
|---|---|
GET |
https://management.core.windows.net/<subscription-id>/services/networking/<virtual-network-name>/gateway/vpndeviceconfigscript |
URI Parameters
URI Parameter |
Description |
|---|---|
vendor |
Required. Specifies the vendor of the on-premise VPN device. |
platform |
Required. Specifies the platform of the on-premise VPN device. |
OSfamily |
Required. Specifies the operating system family of the on-premise VPN device. |
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
None.
Response
The response includes an HTTP status code, a response body, and a set of response headers.
Status Code
A successful operation returns status code 200 (OK).
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 response body contains the device configuration script as a text string that you can use to configure a VPN device.