Update a schedule's metadata

Article
09/16/2015

The Update a schedule's metadata operation update a schedule's description or to change its isEnabled value.

Request

To specify the request, replace <subscription-id> with your subscription ID, <cloud-service-name> with the name of the cloud service to use for making the request, <automation-account-name> with the name of the automation account to use for making the request, and <schedule-name> with the name of the schedule to update. Include required URI parameters.

Method	Request URI
PATCH	https://management.core.windows.net/<subscription-id>/cloudServices/<cloud-service-name>/resources/automation/~/automationAccounts/<automation-account-name>/schedules/<schedule-name>?api-version=2014-12-08

URI Parameters

Parameter	Description
api-version	Required. Must be set to 2014-12-08.

Request Headers

The request headers in the following table are required.

Request Header	Description
Content-Type	Set to application/json. Do not include a specification for charset.
x-ms-version	Specifies the version of the operation. Set to 2013-06-01 or a later version.

Request Body

{
   "properties":{
      "description":"Schedule is on hold",
      "isEnabled":"false"
   }
}

Element	Required	Type	Description
description	No	String	A description of the schedule.
isEnabled	No	Boolean	Specifies whether the schedule is enabled.

Response

Status Code

A successful operation returns 200 (OK). For information about common error codes, see HTTP/1.1 Status Code Definitions.

Response Headers

Request Header	Description
x-ms-request-id	A unique identifier for the current operation.

Response Body

{
   "name":"Sched10",
   "properties":{
      "description":"Schedule is on hold",
      "startTime":"2015-05-01T19:00:00+00:00",
      "expiryTime":"2015-05-02T19:00:00+00:00",
      "isEnabled":false,
      "nextRun":"2015-05-01T19:00:00+00:00",
      "interval":1,
      "frequency":"Hour",
      "creationTime":"2015-04-29T07:03:24.497+00:00",
      "lastModifiedTime":"2015-04-29T07:03:24.497+00:00"
   }
}

Element	Description
name	The name of the schedule
description	The description of the schedule.
startTime	The starting time of the schedule.
expiryTime	The ending time of the schedule (the time after which it no longer executes).
isEnabled	The flag indicating whether the schedule is enabled. Default is true.
nextRun	The next time the schedule will activate.
interval	The periodic interval that the schedule activates.
frequency	Indicate the frequency the schedule will run. Supported values are: onetime, hour, day
creationTime	The date and time the schedule was created.
lastModifiedTime	The date and time the schedule was last changed.

Share via