Auto Upgrade

Get

get

Retrieve the Auto-upgrade settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the Auto-upgrade settings.

Responses

200

Success

application/json; api-version=1.0

Auto-upgrade Settings

enabledbooleanOptional

Enable auto-upgrade maintenance window

startDateTimestring · date-timeOptional

Start Date

drainModeDurationInSecsnumber · doubleOptional

Drain mode duration

forceLogoffSessionsbooleanOptional

Force logoff sessions at the end of the drain mode period

repeatstring · enumOptional

Repeat Type

Possible values:

specificDaysstring[Flag] · enumOptional

Repeat Specific Days

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/AVD/HostPool/{id}/AutoUpgrade

HTTPcURLJavaScriptPython

GET /api/AVD/HostPool/{id}/AutoUpgrade HTTP/1.1
Accept: */*

{
  "enabled": true,
  "startDateTime": "2026-03-11T11:21:37.457Z",
  "drainModeDurationInSecs": 1,
  "forceLogoffSessions": true,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "messages": [
    {
      "id": 1,
      "enabled": true,
      "messageTitle": "text",
      "message": "text",
      "sendMsgSecs": 1,
      "sendMsgWhen": [
        "0 = Before",
        "1 = After"
      ]
    }
  ]
}

Update

put

Update the Auto-upgrade settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the Auto-upgrade settings.

Body

application/json; api-version=1.0

Modify the Auto-upgrade settings

enabledboolean · nullableOptional

Enable auto-upgrade maintenance window

startDateTimestring · date-time · nullableOptional

Start Date

drainModeDurationInSecsnumber · double · nullableOptional

Drain mode duration

forceLogoffSessionsboolean · nullableOptional

Force logoff sessions at the end of the drain mode period

repeatstring · enumOptional

Repeat Type

Possible values:

specificDaysstring[Flag] · enumOptional

Repeat Specific Days

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/AVD/HostPool/{id}/AutoUpgrade

HTTPcURLJavaScriptPython

PUT /api/AVD/HostPool/{id}/AutoUpgrade HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 369

{
  "enabled": true,
  "startDateTime": "2026-03-11T11:21:37.457Z",
  "drainModeDurationInSecs": 1,
  "forceLogoffSessions": true,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ]
}

No content