Settings

Get

Retrieve the Azure Virtual Desktop Feature Site Settings.

GET/api/AVD/Settings

Query parameters

Response

200400401

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

Site ID to which the FSLogix settings are applied

enabledboolean

Whether the Azure Virtual Desktop management is enabled or not

clientFeatureSetClientFeatureSetType (enum)

Client feature set Type values.

0 = Standard,1 = Advanced,2 = AdvancedWithFallback

replicateboolean

Whether the replication of the settings to other sites is enabled or not

Request

JavaScriptCurlPython

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

Response

200400401

{
  "siteId": 0,
  "enabled": false,
  "clientFeatureSet": [
    "0 = Standard",
    "1 = Advanced",
    "2 = AdvancedWithFallback"
  ],
  "replicate": false
}

Update

Update the Azure Virtual Desktop Feature Site Settings.

PUT/api/AVD/Settings

Query parameters

Body

application/json; api-version=1.0

Azure Virtual Desktop Features settings.

enablednullable boolean

Enable or disable the Azure Virtual Desktop management.

clientFeatureSetClientFeatureSetType (enum)

Client feature set Type values.

0 = Standard,1 = Advanced,2 = AdvancedWithFallback

replicatenullable boolean

Enable or disable replication of settings to other sites.

Response

204400401

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/AVD/Settings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}