Schedule

List

get

Retrieve information about one or multiple Schedule setting.

Query parameters
SiteIdinteger · int32Optional

Site ID from which to retrieve the Schedule setting (optional).

NamestringOptional

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.

Responses
200
Success
application/json; api-version=1.0
get
GET /api/AVD/HostPool/Schedule HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-07-06T03:19:49.930Z",
    "timeLastMod": "2025-07-06T03:19:49.930Z",
    "siteID": 1,
    "objType": [
      "44 = RDS",
      "92 = AVD",
      "100 = VDI"
    ],
    "action": [
      "0 = Disable",
      "1 = Reboot",
      "3 = Startup",
      "4 = Shutdown",
      "7 = Recreate"
    ],
    "targetType": [
      "0 = Host",
      "1 = HostPool"
    ],
    "enabled": true,
    "name": "text",
    "description": "text",
    "type": 1,
    "targetIDs": [
      1
    ],
    "targetNativeHosts": [
      {
        "poolId": 1,
        "guid": "text",
        "guestName": "text",
        "hostAzureID": "text"
      }
    ],
    "trigger": {
      "startDateTime": "2025-07-06T03:19:49.930Z",
      "endDateTime": "2025-07-06T03:19:49.930Z",
      "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": 1,
      "completeIn": 1
    },
    "options": {
      "poolMembersType": 1,
      "percentageMembers": 1,
      "membersToStart": 1,
      "powerOnAssignedPoolMembers": 1,
      "messages": [
        {
          "id": 1,
          "enabled": true,
          "messageTitle": "text",
          "message": "text",
          "sendMsgSecs": 1,
          "sendMsgWhen": [
            "0 = Before",
            "1 = After"
          ]
        }
      ],
      "enableDrainMode": true,
      "forceServerRebootAfter": 1,
      "enforceScheduleInactiveHost": true,
      "onDisable": true
    }
  }
]

Get

get

Retrieve information about a particular Schedule setting by ID.

Path parameters
Idinteger · int32Required

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

Responses
200
Success
application/json; api-version=1.0
get
GET /api/AVD/HostPool/Schedule/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-07-06T03:19:49.930Z",
  "timeLastMod": "2025-07-06T03:19:49.930Z",
  "siteID": 1,
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": true,
  "name": "text",
  "description": "text",
  "type": 1,
  "targetIDs": [
    1
  ],
  "targetNativeHosts": [
    {
      "poolId": 1,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2025-07-06T03:19:49.930Z",
    "endDateTime": "2025-07-06T03:19:49.930Z",
    "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": 1,
    "completeIn": 1
  },
  "options": {
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }
}

Update

put

Modify properties of a Schedule setting.

Path parameters
idinteger · int32Required

The ID of the Schedule setting to modify.

Body
newNamestring | nullableOptional

A new name for the scheduler job.

enabledboolean | nullableOptional

Whether to enable or disable the schedule.

descriptionstring | nullableOptional

Schedule description.

startDateTimestring · date-time | nullableOptional

Start time. Default: Now.

durationInSecsnumber · double | nullableOptional

Duration in seconds.

repeatstring · enumOptional

Repeat Type

Possible values:
specificDaysstring[Flag] · enumOptional

Repeat Specific Days

Possible values:
completeIninteger · int32 | nullableOptional

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

poolMembersTypeinteger · int32 | nullableOptional

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

percentageMembersinteger · int32 | nullableOptional

Percentage of members to be started

membersToStartinteger · int32 | nullableOptional

Specific number of members to be started

powerOnAssignedPoolMembersinteger · int32 | nullableOptional

Power On Assigned Pool Members

enableDrainModeboolean | nullableOptional

Whether to enable Drain Mode

forceServerRebootAfterinteger · int32 | nullableOptional

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostboolean | nullableOptional

Enforce schedule for currently inactive host

onDisableboolean | nullableOptional

What action to take on Disable

Responses
204
No Content
put
PUT /api/AVD/HostPool/Schedule/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 580

{
  "newName": "text",
  "enabled": true,
  "description": "text",
  "startDateTime": "2025-07-06T03:19:49.930Z",
  "durationInSecs": 1,
  "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"
  ],
  "completeIn": 1,
  "poolMembersType": 1,
  "percentageMembers": 1,
  "membersToStart": 1,
  "powerOnAssignedPoolMembers": 1,
  "enableDrainMode": true,
  "forceServerRebootAfter": 1,
  "enforceScheduleInactiveHost": true,
  "onDisable": true
}

No content

Delete

delete

Remove a Schedule setting.

Path parameters
Idinteger · int32Required

The ID of a Schedule setting to remove.

Responses
204
No Content
delete
DELETE /api/AVD/HostPool/Schedule/{id} HTTP/1.1
Host: 
Accept: */*

No content

Was this helpful?