All

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.

Response

Success

Body

hostnullable string

Host

hostPoolnullable string

Host Pool

hostOSnullable string

Host OS

hostStatePowerState (enum)

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/All', {
    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",
    "azureId": "text"
  }
]

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.

Response

Success

Body

hostnullable string

Host

hostPoolnullable string

Host Pool

hostOSnullable string

Host OS

hostStatePowerState (enum)

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/All', {
    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",
    "azureId": "text"
  }
]