Shutdown

Create Shutdown

Creates a new Shutdown Schedule.

POST/api/Provider/VM/AVDHost/Schedule/Shutdown

Body

The Schedule settings.

name*nullable string

Schedule name.

siteIdinteger (int32)

Site ID from which to retrieve the schedule.

enablednullable boolean

Whether to enable or disable the schedule.

descriptionnullable string

Schedule description.

typenullable integer (int32)

Schedule type

startDateTimestring (date-time)

Start time. Default: Now.

durationInSecsnullable number (double)

Duration in seconds.

repeatRepeatType (enum)

Repeat Type

0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysRepeatSpecificDays (enum)

Repeat Specific Days

0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

completeInnullable integer (int32)

The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.

poolMembersTypenullable integer (int32)

Whether to select the percentage or specific number of members to be started

percentageMembersnullable integer (int32)

Percentage of members to be started

membersToStartnullable integer (int32)

Specific number of members to be started

powerOnAssignedPoolMembersnullable integer (int32)

Power On Assigned Pool Members

enableDrainModenullable boolean

Whether to enable Drain Mode

forceServerRebootAfternullable integer (int32)

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostnullable boolean

Enforce schedule for currently inactive host

onDisablenullable boolean

What action to take on Disable

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

siteIDinteger (int32)

Site ID

objTypeScheduleObjType (enum)

Schedule Object Type

44 = RDS,92 = AVD,100 = VDI

actionScheduleActionType (enum)

Schedule Action Type

0 = Disable,1 = Reboot,3 = Startup,4 = Shutdown,7 = Recreate

targetTypeScheduleTargetType (enum)

Scheduler Target Type

0 = Host,1 = HostPool

enabledboolean

Enabled

namenullable string

Name

descriptionnullable string

Description

typenullable integer (int32)

Type

targetIDsnullable array of integer (int32)

Target IDs

itemsinteger (int32)

targetNativeHostsnullable array of TargetNativeHost (object)

Target Native Hosts

poolIdinteger (int32)

Pool Id

guidnullable string

GUID

guestNamenullable string

Guest Name

hostAzureIDnullable string

Host Azure ID

triggerTrigger (object)

Trigger

startDateTimestring (date-time)

Start Date

endDateTimenullable string (date-time)

End Date

repeatRepeatType (enum)

Repeat Type

0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysRepeatSpecificDays (enum)

Repeat Specific Days

0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

durationInSecsnullable number (double)

Duration

completeInnullable integer (int32)

Complete In

optionsOptions (object)

Options

poolMembersTypenullable integer (int32)

Pool Members Type

percentageMembersnullable integer (int32)

Percentage of members

membersToStartnullable integer (int32)

Specific number of members to be started

powerOnAssignedPoolMembersnullable integer (int32)

Power On Assigned Pool Members

messagesnullable array of ScheduleMessage (object)

Messages

idinteger (int32)

ID of the object.

enabledboolean

Enabled

messageTitlenullable string

Message title

messagenullable string

Message

sendMsgSecsinteger (int32)

Seconds before message is sent

sendMsgWhenSendMsgWhen (enum)

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.

0 = Before,1 = After

enableDrainModenullable boolean

Enable Drain Mode

forceServerRebootAfternullable integer (int32)

Force server reboot after

enforceScheduleInactiveHostnullable boolean

Enforce schedule for currently inactive host

onDisablenullable boolean

On Disable

Request

Response

Create Shutdown

Creates a new Shutdown Schedule.

POST/api/Provider/VM/AVDHost/Schedule/Shutdown

Body

The Schedule settings.

name*nullable string

Schedule name.

siteIdinteger (int32)

Site ID from which to retrieve the schedule.

enablednullable boolean

Whether to enable or disable the schedule.

descriptionnullable string

Schedule description.

typenullable integer (int32)

Schedule type

startDateTimestring (date-time)

Start time. Default: Now.

durationInSecsnullable number (double)

Duration in seconds.

repeatRepeatType (enum)

Repeat Type

0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysRepeatSpecificDays (enum)

Repeat Specific Days

0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

completeInnullable integer (int32)

The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.

poolMembersTypenullable integer (int32)

Whether to select the percentage or specific number of members to be started

percentageMembersnullable integer (int32)

Percentage of members to be started

membersToStartnullable integer (int32)

Specific number of members to be started

powerOnAssignedPoolMembersnullable integer (int32)

Power On Assigned Pool Members

enableDrainModenullable boolean

Whether to enable Drain Mode

forceServerRebootAfternullable integer (int32)

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostnullable boolean

Enforce schedule for currently inactive host

onDisablenullable boolean

What action to take on Disable

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

siteIDinteger (int32)

Site ID

objTypeScheduleObjType (enum)

Schedule Object Type

44 = RDS,92 = AVD,100 = VDI

actionScheduleActionType (enum)

Schedule Action Type

0 = Disable,1 = Reboot,3 = Startup,4 = Shutdown,7 = Recreate

targetTypeScheduleTargetType (enum)

Scheduler Target Type

0 = Host,1 = HostPool

enabledboolean

Enabled

namenullable string

Name

descriptionnullable string

Description

typenullable integer (int32)

Type

targetIDsnullable array of integer (int32)

Target IDs

itemsinteger (int32)

targetNativeHostsnullable array of TargetNativeHost (object)

Target Native Hosts

poolIdinteger (int32)

Pool Id

guidnullable string

GUID

guestNamenullable string

Guest Name

hostAzureIDnullable string

Host Azure ID

triggerTrigger (object)

Trigger

startDateTimestring (date-time)

Start Date

endDateTimenullable string (date-time)

End Date

repeatRepeatType (enum)

Repeat Type

0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysRepeatSpecificDays (enum)

Repeat Specific Days

0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

durationInSecsnullable number (double)

Duration

completeInnullable integer (int32)

Complete In

optionsOptions (object)

Options

poolMembersTypenullable integer (int32)

Pool Members Type

percentageMembersnullable integer (int32)

Percentage of members

membersToStartnullable integer (int32)

Specific number of members to be started

powerOnAssignedPoolMembersnullable integer (int32)

Power On Assigned Pool Members

messagesnullable array of ScheduleMessage (object)

Messages

idinteger (int32)

ID of the object.

enabledboolean

Enabled

messageTitlenullable string

Message title

messagenullable string

Message

sendMsgSecsinteger (int32)

Seconds before message is sent

sendMsgWhenSendMsgWhen (enum)

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.

0 = Before,1 = After

enableDrainModenullable boolean

Enable Drain Mode

forceServerRebootAfternullable integer (int32)

Force server reboot after

enforceScheduleInactiveHostnullable boolean

Enforce schedule for currently inactive host

onDisablenullable boolean

On Disable

Request

Response

const response = await fetch('/api/Provider/VM/AVDHost/Schedule/Shutdown', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T09:55:07.561Z",
  "timeLastMod": "2024-11-07T09:55:07.561Z",
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": false,
  "name": "text",
  "description": "text",
  "targetIDs": [],
  "targetNativeHosts": [
    {
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2024-11-07T09:55:07.561Z",
    "endDateTime": "2024-11-07T09:55:07.561Z",
    "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"
    ],
    "durationInSecs": 0
  },
  "options": {
    "messages": [
      {
        "enabled": false,
        "messageTitle": "text",
        "message": "text",
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": false,
    "enforceScheduleInactiveHost": false,
    "onDisable": false
  }
}