Templated

PreviousStatus NextReset

Was this helpful?

Create Templated

Creates Azure Virtual Desktop Hosts from a Templated Azure Virtual Desktop Host Pool.

POST/api/Provider/VM/AVDHost/Templated

Query parameters

Body

Azure Virtual Desktop Host.

hostPoolId*integer (int32)

Host Pool Id of the AVD Host.

numberOfHosts*integer (int32)

Number of Hosts to create from template.

Response

No Content

Request

const response = await fetch('/api/Provider/VM/AVDHost/Templated', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "hostPoolId": 1,
      "numberOfHosts": 1
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Remove Templated

Removes Azure Virtual Desktop Hosts from a Templated Azure Virtual Desktop Host Pool.

DELETE/api/Provider/{providerId}/VM/{id}/AVDHost/Templated

Path parameters

providerId*integer (int32)

The Templated Azure Virtual Desktop Host Pool ID from which to remove the Azure Virtual Desktop Hosts.

id*string

The ID of the target host VM.

Query parameters

Response

No Content

Request

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

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}