Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Remove a Schedule setting.
The ID of a Schedule setting to remove.
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.
No Content
Get a list of the schedule setting's target ids.
The ID of the Schedule setting for which to retrieve the target settings.
The Schedule settings.
Success
Add a Schedule target setting.
The ID of the Schedule setting to modify.
The Schedule target settings.
The target RD Session Host server or server group Ids depending on the TargetType parameter.
Created
Remove a Schedule target setting.
The ID of the Schedule setting to modify.
The Schedule settings.
The target RD Session Host server or server group Ids depending on the TargetType parameter.
No Content
Retrieve a Schedule Message.
The ID of the Schedule setting for which to retrieve the message.
The ID of the message to retrieve.
Success
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Retrieve Schedule Message(s).
The ID of the Schedule setting for which to retrieve the messages.
Success
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Update a Schedule Message.
The ID of the Schedule setting for which to modify the message.
The ID of the message to modify.
Message settings.
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
Create a Schedule Message.
The ID of the Schedule setting for which to create the message.
Message settings.
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
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Modify properties of a Schedule setting.
The ID of the Schedule setting to modify.
Schedule settings
A new name for the scheduler job.
Whether to enable or disable the schedule.
Schedule description.
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
No Content
Retrieve information about a particular Schedule setting by ID.
The ID of the Schedule setting for which to retrieve the information.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new disable Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new Reboot Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new Shutdown Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new Startup Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Retrieve information about one or multiple Schedule setting.
Site ID from which to retrieve the Schedule setting (optional).
The name of the Schedule setting for which to retrieve the information. This must be the actual Schedule setting name used in the RAS connections.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is 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.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable