Update a schedule's metadata

 

Updated: May 26, 2016

The Update a schedule task updates a schedule's metadata.

The related Windows PowerShell cmdlet for this task is Set-AzureRmAutomationSchedule.

To specify the request, replace {subscription-id} with your subscription ID, {resource-group-name} with the name of your resource group, {automation-account-name} with the name of the automation account, and {schedule-name} with the name of the schedule.

Method

Request URI

PATCH

https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Automation/automationAccounts/{automation-account-name}/schedules/{schedule-name}?api-version=2015-10-31

URI parameter

Description

api-version

Required. Valid values include 2015-10-31

The following code shows an example of the request body.

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

Element name

Required

Type

Description

Description

No

String

Specifies a description for the schedule.

IsEnabled

Yes

Boolean

Specifies whether this task enables the schedule.

Name

Yes

String

Specifies the name for the schedule that this task modifies.

The following code shows an example of the 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"
   }
}


201

For information about common error codes, see Service Management Status and Error Codes

Show: