Retrieve the Auto-upgrade settings of a Site Defaults object.
The SiteId of a Site Defaults object for which to retrieve the Auto-upgrade settings (optional).
Success
Unauthorized
Not Found
Update the Auto-upgrade settings of a Site Defaults object.
The SiteId of a Site Defaults object for which to modify the Auto-upgrade settings (optional).
Modify the Auto-upgrade settings
No Content
No content
Unauthorized
Not Found
No content
Create an Auto-upgrade Message.
Add a message to the Auto-upgrade message list
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Created
Unauthorized
Not Found
No content
Retrieve an Auto-upgrade Message.
The ID of the message to retrieve.
Success
Unauthorized
Not Found
Update an Auto-upgrade Message.
The ID of the message to modify.
Modify a message within the Auto-upgrade message list
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
No Content
No content
Unauthorized
Not Found
No content
Delete an Auto-upgrade Message by ID.
The ID of the message to remove.
No Content
No content
Unauthorized
Not Found
No content
GET /api/AVD/DefaultSettings/MultiSession/AutoUpgrade HTTP/1.1
Host:
Accept: */*
{
"enabled": true,
"startDateTime": "2025-12-13T15:56:54.034Z",
"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"
]
}
]
}PUT /api/AVD/DefaultSettings/MultiSession/AutoUpgrade HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 2
{}GET /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
]POST /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112
{
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}GET /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}PUT /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112
{
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}DELETE /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host:
Accept: */*