Get information about a published runbook

Article
09/16/2015

The Get information about a published runbook operation returns information about a runbook that is published.

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 <runbook-name> with the name of the runbook to get information about. Include required URI parameters.

Method	Request URI
GET	https://management.core.windows.net/<subscriptionId>/cloudServices/<cloud-service-name>/resources/automation/~/automationAccounts/<automation-account-name>/runbooks/<runbook-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

{
   "id":"\/subscriptions\/2310a662-9154-4254-a8e1-34286f3bf56a\/cloudservices\/CLSV2_Litware\/resources\/~\/automationAccounts\/LitwareDataCenter\/runbooks\/Write-HelloWorld",
   "location":"East US",
   "type":"Microsoft.Automation\/AutomationAccount\/Runbook",
   "name":"Write-HelloWorld",
   "tags":{
      "Testing":"show value",
      "Source":"TechNet Script Center"
   },
   "etag":"\"635657036880300000\"",
   "properties":{
      "runbookType":"Script",
      "description":"Hello world",
      "logProgress":false,
      "logVerbose":false,
      "creationTime":"2015-04-26T05:45:42.457+00:00",
      "lastModifiedTime":"2015-04-27T03:54:48.03+00:00",
      "state":"Published",
      "jobCount":0,
      "parameters":{
         "Name":{
            "type":"System.String",
            "isMandatory":false,
            "position":0,
            "defaultValue":"\"World\""
         }
      },
      "serviceManagementTags":null
   }
}

Element	Description
id	The URI for this entity, excluding hostname/schema and api version. Not URL encoded. This field is used by the platform as the identifier for references for other objects.
location	Geographical location of resource.
name	The name of the runbook.
type	The type of the resource (e.g., Microsoft.Automation/AutomationAccount/Runbook)
name	The name of the runbook.
tags	A list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 10 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
etag	Value used for concurrence control.
properties/runbookType	"Script" is the only supported type.
properties/description	The description provided for the runbook.
properties/logVerbose	Indicates whether to log progress of the runbook. The default is false.
properties/logProgress	Indicates whether to log verbose details of the runbook. The default is false.
properties/creationTime	The date and time the runbook was created.
properties/creationTime	The date and time the runbook was last edited.
properties/state	The status of the runbook. The possible values are: new, edit, published.
properties/jobCount	The number of jobs executed for this runbook.
properties/parameters	A list of parameter objects that represent the Runbook parameters. Parameters are extracted as part of the create Runbook process. Parameters objects have a name and the following properties. type The parameter's data type. isMandatory Indicates whether the parameter is required. position The zero-based numerical position of the parameter. defaultValue The parameter's default value.
properties/serviceManagementTags	Freeform values available to the runbook.