Custom Host

PreviousAVD NextAll

Last updated 10 months ago

Was this helpful?

List of Custom Hosts Not in Host Pools

Retrieve a list of Azure Virtual Desktop Custom Hosts not in Host Pools.

GET/api/AVD/CustomHost

Query parameters

Response

Success

Body

hostnullable string

Host

hostPoolnullable string

Host Pool

hostOSnullable string

Host OS

hostStateenum

Power State

0 = Unknown,1 = PoweringOn,2 = PoweringOff,3 = PoweredOn,4 = PoweredOff

resourceGroupnullable string

Resource Group

locationnullable string

Location

virtualNetworknullable string

Virtual Network

providerIdinteger (int32)

Provider Id

azureIdnullable string

Azure Id

Request

const response = await fetch('/api/AVD/CustomHost', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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