Schedule

PreviousRecreate Hosts NextDisable

Was this helpful?

List

get

Retrieve information about one or multiple Schedule setting.

Query parameters

SiteIdinteger · int32

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

Namestring

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/HostPool/Schedule'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-03-18T14:07:11.897Z",
    "timeLastMod": "2025-03-18T14:07:11.897Z",
    "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-03-18T14:07:11.897Z",
      "endDateTime": "2025-03-18T14:07:11.897Z",
      "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
    }
  }
]

Success

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/HostPool/Schedule/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-18T14:07:11.897Z",
  "timeLastMod": "2025-03-18T14:07:11.897Z",
  "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-03-18T14:07:11.897Z",
    "endDateTime": "2025-03-18T14:07:11.897Z",
    "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
  }
}

Success

Update

put

Modify properties of a Schedule setting.

Path parameters

idinteger · int32required

The ID of the Schedule setting to modify.

Body

newNamestring | nullable

<para type="description">A new name for the scheduler job.</para>

enabledboolean | nullable

<para type="description">Whether to enable or disable the schedule.</para>

descriptionstring | nullable

<para type="description">Schedule description.</para>

startDateTimestring · date-time | nullable

<para type="description">Start time. Default: Now.</para>

durationInSecsnumber · double | nullable

<para type="description">Duration in seconds.</para>

repeatstring · enum

<para type="synopsis">Repeat Type</para> <para type="description"></para>

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

specificDaysstring[Flag] · enum

<para type="synopsis">Repeat Specific Days</para> <para type="description"></para>

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

completeIninteger · int32 | nullable

<para type="description">The duration of the scheduler task in minutes. </para> <para type="description">Default: 15 minutes for disable task, 10 minutes for reboot task.</para>

poolMembersTypeinteger · int32 | nullable

<para type="description">Whether to select the percentage or specific number of members to be started</para>

percentageMembersinteger · int32 | nullable

<para type="description">Percentage of members to be started</para>

membersToStartinteger · int32 | nullable

<para type="description">Specific number of members to be started</para>

powerOnAssignedPoolMembersinteger · int32 | nullable

<para type="description">Power On Assigned Pool Members</para>

enableDrainModeboolean | nullable

<para type="description">Whether to enable Drain Mode</para>

forceServerRebootAfterinteger · int32 | nullable

<para type="description">Force server reboot after the specified time in seconds</para>

enforceScheduleInactiveHostboolean | nullable

<para type="description">Enforce schedule for currently inactive host</para>

onDisableboolean | nullable

<para type="description">What action to take on Disable</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/AVD/HostPool/Schedule/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "newName": "text",
    "enabled": true,
    "description": "text",
    "startDateTime": "2025-03-18T14:07:11.897Z",
    "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
  }'

204

401

404

No body

No Content

Delete

delete

Remove a Schedule setting.

Path parameters

Idinteger · int32required

The ID of a Schedule setting to remove.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/HostPool/Schedule/{id}'

204

401

404

No body

No Content