All

List of all Custom Hosts

get

Retrieve a list of all Azure Virtual Desktop Custom Hosts.

Query parameters

providerIdinteger · int32Optional

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

Responses

200

Success

application/json; api-version=1.0

AVD Custom Host

hoststring · nullableOptional

Host

hostPoolstring · nullableOptional

Host Pool

hostOSstring · nullableOptional

Host OS

hostStatestring · enumOptional

Power State

Possible values:

resourceGroupstring · nullableOptional

Resource Group

locationstring · nullableOptional

Location

virtualNetworkstring · nullableOptional

Virtual Network

providerIdinteger · int32Optional

Provider Id

azureIdstring · nullableOptional

Azure Id

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

get

/api/AVD/CustomHost/All

HTTPcURLJavaScriptPython

GET /api/AVD/CustomHost/All HTTP/1.1
Accept: */*

[
  {
    "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"
  }
]