Disable

Create Disable

post

Creates a new disable Schedule.

Body

application/json; api-version=1.0

namestring | nullableRequired

Schedule name.

siteIdinteger · int32Optional

Site ID from which to retrieve the schedule.

enabledboolean | nullableOptional

Whether to enable or disable the schedule.

descriptionstring | nullableOptional

Schedule description.

typeinteger · int32 | nullableOptional

Schedule type

startDateTimestring · date-timeOptional

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

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/VDI/HostPool/Schedule/Disable

HTTPcURLJavaScriptPython

POST /api/VDI/HostPool/Schedule/Disable HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597

{
  "name": "text",
  "siteId": 1,
  "enabled": true,
  "description": "text",
  "type": 1,
  "startDateTime": "2025-10-31T05:16:35.535Z",
  "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
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-10-31T05:16:35.535Z",
  "timeLastMod": "2025-10-31T05:16:35.535Z",
  "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-10-31T05:16:35.535Z",
    "endDateTime": "2025-10-31T05:16:35.535Z",
    "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
  }
}