Schedule

List

Retrieve information about one or multiple Schedule setting.

GET/api/VDI/HostPool/Schedule

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

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

targetNativeHostsnullable array of TargetNativeHost (object)

Target Native Hosts

triggerTrigger (object)

Trigger

optionsOptions (object)

Options

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/Schedule', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-12-21T14:23:58.291Z",
    "timeLastMod": "2024-12-21T14:23:58.291Z",
    "siteID": 0,
    "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",
    "type": 0,
    "targetIDs": [
      0
    ],
    "targetNativeHosts": [
      {
        "poolId": 0,
        "guid": "text",
        "guestName": "text",
        "hostAzureID": "text"
      }
    ],
    "trigger": {
      "startDateTime": "2024-12-21T14:23:58.291Z",
      "endDateTime": "2024-12-21T14:23:58.291Z",
      "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,
      "completeIn": 0
    },
    "options": {
      "poolMembersType": 0,
      "percentageMembers": 0,
      "membersToStart": 0,
      "powerOnAssignedPoolMembers": 0,
      "messages": [
        {
          "id": 0,
          "enabled": false,
          "messageTitle": "text",
          "message": "text",
          "sendMsgSecs": 0,
          "sendMsgWhen": [
            "0 = Before",
            "1 = After"
          ]
        }
      ],
      "enableDrainMode": false,
      "forceServerRebootAfter": 0,
      "enforceScheduleInactiveHost": false,
      "onDisable": false
    }
  }
]

Get

Retrieve information about a particular Schedule setting by ID.

GET/api/VDI/HostPool/Schedule/{id}

Path parameters

Id*integer (int32)

The ID of the Schedule setting for which to retrieve the information.

Response

200401404

Success

Body

application/json; api-version=1.0

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

targetNativeHostsnullable array of TargetNativeHost (object)

Target Native Hosts

triggerTrigger (object)

Trigger

optionsOptions (object)

Options

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/Schedule/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:23:58.291Z",
  "timeLastMod": "2024-12-21T14:23:58.291Z",
  "siteID": 0,
  "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",
  "type": 0,
  "targetIDs": [
    0
  ],
  "targetNativeHosts": [
    {
      "poolId": 0,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2024-12-21T14:23:58.291Z",
    "endDateTime": "2024-12-21T14:23:58.291Z",
    "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,
    "completeIn": 0
  },
  "options": {
    "poolMembersType": 0,
    "percentageMembers": 0,
    "membersToStart": 0,
    "powerOnAssignedPoolMembers": 0,
    "messages": [
      {
        "id": 0,
        "enabled": false,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 0,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": false,
    "forceServerRebootAfter": 0,
    "enforceScheduleInactiveHost": false,
    "onDisable": false
  }
}

Update

Modify properties of a Schedule setting.

PUT/api/VDI/HostPool/Schedule/{id}

Path parameters

id*integer (int32)

The ID of the Schedule setting to modify.

Body

application/json; api-version=1.0

Schedule settings

newNamenullable string

A new name for the scheduler job.

enablednullable boolean

Whether to enable or disable the schedule.

descriptionnullable string

Schedule description.

startDateTimenullable string (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

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/Schedule/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete

Remove a Schedule setting.

DELETE/api/VDI/HostPool/Schedule/{id}

Path parameters

Id*integer (int32)

The ID of a Schedule setting to remove.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/Schedule/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}