AVD Host

List

get

Retrieve the host VM list in real-time.

Query parameters
SiteIdinteger · int32Optional

Site ID from which to retrieve the host VM list (optional).

Responses
chevron-right
200

Success

application/json; api-version=1.0

AVD Host

siteIdinteger · int32Optional

Site ID

idstring · nullableOptional

ID of the VM

providerIdinteger · int32Optional

Provider ID

hoststring · nullableOptional

Host Name

avdAgentstring · nullableOptional

AVD Agent

hostPoolstring · nullableOptional

Host Pool

workspacestring · nullableOptional

Workspace

locationstring · nullableOptional

Location

resourceGroupstring · nullableOptional

Resource Group

get
/api/Provider/VM/AVDHost

List by Provider ID

get

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

Path parameters
providerIdinteger · int32Required

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

Responses
chevron-right
200

Success

application/json; api-version=1.0

AVD Host

siteIdinteger · int32Optional

Site ID

idstring · nullableOptional

ID of the VM

providerIdinteger · int32Optional

Provider ID

hoststring · nullableOptional

Host Name

avdAgentstring · nullableOptional

AVD Agent

hostPoolstring · nullableOptional

Host Pool

workspacestring · nullableOptional

Workspace

locationstring · nullableOptional

Location

resourceGroupstring · nullableOptional

Resource Group

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

Get

get

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

Path parameters
providerIdinteger · int32Required

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

idstringRequired

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

Responses
chevron-right
200

Success

application/json; api-version=1.0

AVD Host

siteIdinteger · int32Optional

Site ID

idstring · nullableOptional

ID of the VM

providerIdinteger · int32Optional

Provider ID

hoststring · nullableOptional

Host Name

avdAgentstring · nullableOptional

AVD Agent

hostPoolstring · nullableOptional

Host Pool

workspacestring · nullableOptional

Workspace

locationstring · nullableOptional

Location

resourceGroupstring · nullableOptional

Resource Group

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

Last updated

Was this helpful?