AVD Host

List

Retrieve the host VM list in real-time.

GET/api/Provider/VM/AVDHost

Query parameters

Response

200400401

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

hostnullable string

Host Name

avdAgentnullable string

AVD Agent

hostPoolnullable string

Host Pool

workspacenullable string

Workspace

locationnullable string

Location

resourceGroupnullable string

Resource Group

Request

JavaScriptCurlPython

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

Response

200400401

[
  {
    "id": "text",
    "host": "text",
    "avdAgent": "text",
    "hostPool": "text",
    "workspace": "text",
    "location": "text",
    "resourceGroup": "text"
  }
]

List by Provider ID

Retrieve the host VM list from a Provider in real-time.

GET/api/Provider/{providerId}/VM/AVDHost

Path parameters

providerId*integer (int32)

The ID of a Provider server from which to obtain the VM list.

Response

200400401

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

hostnullable string

Host Name

avdAgentnullable string

AVD Agent

hostPoolnullable string

Host Pool

workspacenullable string

Workspace

locationnullable string

Location

resourceGroupnullable string

Resource Group

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/AVDHost', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

[
  {
    "id": "text",
    "host": "text",
    "avdAgent": "text",
    "hostPool": "text",
    "workspace": "text",
    "location": "text",
    "resourceGroup": "text"
  }
]

Get

Retrieve the specified host VM from a Provider in real-time.

GET/api/Provider/{providerId}/VM/{id}/AVDHost

Path parameters

providerId*integer (int32)

The ID of a Provider server from which to retrieve the specified VM.

id*string

The ID of a host VM for which to retrieve the information.

Response

200400401

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID

idnullable string

ID of the VM

providerIdinteger (int32)

Provider ID

hostnullable string

Host Name

avdAgentnullable string

AVD Agent

hostPoolnullable string

Host Pool

workspacenullable string

Workspace

locationnullable string

Location

resourceGroupnullable string

Resource Group

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/{id}/AVDHost', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "id": "text",
  "host": "text",
  "avdAgent": "text",
  "hostPool": "text",
  "workspace": "text",
  "location": "text",
  "resourceGroup": "text"
}