Share via


List Virtual Network Gateway Supported Devices

 

The List Virtual Network Gateway Supported Devices operation lists the supported, on-premise network devices that can connect to the gateway.

Request

The List Virtual Network Gateway Supported Devices request may be specified as follows. Replace <subscription-id> with the subscription ID.

Method

Request URI

GET

https://management.core.windows.net<subscription-id>/services/networking/supporteddevices

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. 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 format of the response body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<VpnDeviceList version="version-number-of-devices-list">
  <Vendor name="name-of-device-vendor">
    <Platform name="type-of-supported-device">
      <OSFamily name="name-of-device-operating-system">
    </Platform>
  </Vendor>
</VpnDeviceList>

The following table describes the elements of the response body.

Response Element

Description

VpnDeviceList

Specifies a collection of supported network gateway devices.

Vendor

Specifies the name of the vendor of the device.

Platform

Specifies the type of the device.

OSFamily

Specifies the operating system that runs on the device.