Get information about a schedule's association to a runbook

Article
09/16/2015

The Get information about a schedule's association to a runbook operation returns data for a specified job schedule. A job schedule is an association between a runbook and a schedule.

You will need the job-schedule-ID to make the request. To determine the ID you need to use, use the List all associations between schedules and runbooks 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 <job-schedule-id> with the GUID of the job 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>/jobschedules/<job-schedule-id>?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

{
   "properties":{
      "jobScheduleId":"ade81e06-1e93-4c37-84b7-4e40e9694641",
      "runbook":{
         "name":"Use-RunbookParameterSample"
      },
      "schedule":{
         "name":"Sched10"
      },
      "parameters":{
         "Name":"Scarlett",
         "date":"4\/29\/2015",
         "Number":"55",
         "SayGoodbye":"true"
      }
   }
}

Element	Description
jobScheduleID	The job schedule ID.
runbook/Name	The name of the runbook linked to the schedule.
schedule/Name	The name of the linked schedule.
parameters	As applicable, parameters names and their values to be passed to the runbook when the schedule creates a job for this runbook.

Share via