AVD Host
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
400
Bad Request
application/json; api-version=1.0
401
Unauthorized
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"
}
]
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
400
Bad Request
application/json; api-version=1.0
401
Unauthorized
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"
}
]
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
200
Success
application/json; api-version=1.0
400
Bad Request
application/json; api-version=1.0
401
Unauthorized
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"
}
Last updated
Was this helpful?