ProductsSupportPartnersDocumentation

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
200
Success
application/json; api-version=1.0
get
GET /api/Provider/VM/AVDHost HTTP/1.1
Host: 
Accept: */*

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

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
200
Success
application/json; api-version=1.0
get
GET /api/Provider/{providerId}/VM/AVDHost HTTP/1.1
Host: 
Accept: */*

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

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
Query parameters
idstringOptional

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

Responses
200
OK
application/json; api-version=1.0
get
GET /api/Provider/{providerId}/VM/{id}/AVDHost HTTP/1.1
Host: 
Accept: */*

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

Repair

post

Repairs an Azure Virtual Desktop Host.

Query parameters
azureIdstringOptional

The Azure Id of the Host to repair.

hostPoolIdinteger · int32Optional

The Id of the Host Pool which contains the Host to repair.

siteIdinteger · int32Optional

The Id of the site which contains the Azure Virtual Desktop Host. (optional)

Responses
204
No Content
post
POST /api/Provider/VM/AVDHost/Repair HTTP/1.1
Host: 
Accept: */*

No content
PreviousVMNextSchedule

Last updated

Was this helpful?