Settings

Get

get

Retrieve the Azure Virtual Desktop Feature Site Settings.

Query parameters

siteIdinteger · int32Optional

The Site ID for which to retrieve the Azure Virtual Desktop Feature settings.

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

/api/AVD/Settings

HTTPcURLJavaScriptPython

GET /api/AVD/Settings HTTP/1.1
Host: 
Accept: */*

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

Update

put

Update the Azure Virtual Desktop Feature Site Settings.

Query parameters

siteIdinteger · int32Optional

The Site ID for which to modify the Azure Virtual Desktop Feature settings.

Body

application/json; api-version=1.0

Update AVD feature settings in the RAS Site

enabledboolean | nullableOptional

Enable or disable the Azure Virtual Desktop management.

clientFeatureSetstring · enumOptional

Client feature set Type values.

Possible values:

replicateboolean | nullableOptional

Enable or disable replication of settings to other sites.

Responses

204

No Content

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

put

/api/AVD/Settings

HTTPcURLJavaScriptPython

PUT /api/AVD/Settings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 111

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

No content