Parallels REST API

List of all Custom Hosts

Retrieve a list of all Azure Virtual Desktop Custom Hosts.

get

/api/AVD/CustomHost/All

Query parameters

providerIdinteger int32

The Provider ID for which to retrieve the list of Azure Virtual Desktop Custom Hosts.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/CustomHost/All'

200

400

401

[
  {
    "host": "text",
    "hostPool": "text",
    "hostOS": "text",
    "hostState": [
      "0 = Unknown",
      "1 = PoweringOn",
      "2 = PoweringOff",
      "3 = PoweredOn",
      "4 = PoweredOff"
    ],
    "resourceGroup": "text",
    "location": "text",
    "virtualNetwork": "text",
    "providerId": 1,
    "azureId": "text"
  }
]

Success