Messages
Retrieve Schedule Message(s).
The ID of the Schedule setting for which to retrieve the messages.
GET /api/Provider/VM/AVDHost/Schedule/{id}/Messages HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
]
Create a Schedule Message.
The ID of the Schedule setting for which to create the message.
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.
POST /api/Provider/VM/AVDHost/Schedule/{id}/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"
]
}
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
Retrieve a Schedule Message.
The ID of the Schedule setting for which to retrieve the message.
The ID of the message to retrieve.
GET /api/Provider/VM/AVDHost/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
Update a Schedule Message.
The ID of the Schedule setting for which to modify the message.
The ID of the message to modify.
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.
PUT /api/Provider/VM/AVDHost/Schedule/{id}/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"
]
}
No content
Delete a Schedule Message by ID.
The ID of the Schedule setting for which to remove the message.
The ID of the message to remove.
DELETE /api/Provider/VM/AVDHost/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?