Share via


Get information about a schedule

 

The Get information about a schedule operation returns data for a specified schedule.

To get information about a schedule linked to a runbook, use the Get information about a schedule's association to a runbook operation.

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 get information about. Include required URI parameters.

Method

Request URI

GET

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 header in the following table is required.

Request Header

Description

x-ms-version

Specifies the version of the operation. Set to 2013-06-01 or a later version.

Request Body

None

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":"AuditSched",
   "properties":{
      "description":"Run every other hour",
      "startTime":"2015-05-11T09:00:00+00:00",
      "expiryTime":"2016-05-22T09:00:00+00:00",
      "isEnabled":true,
      "nextRun":"2015-05-11T09:00:00+00:00",
      "interval":2,
      "frequency":"Hour",
      "creationTime":"2015-05-03T21:28:21.02+00:00",
      "lastModifiedTime":"2015-05-03T21:28:21.02+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.

See Also

Automation Schedules
Operations on Automation