List all runbooks
The List all runbooks operation lists all runbooks associated with the automation account.
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. 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>/runbooks?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
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
{
"value":[
{
"id":null,
"location":null,
"type":"Microsoft.Automation\/AutomationAccount\/Runbook",
"name":"Copy-ItemToAzureVM",
"properties":{
"runbookType":"Script",
"state":"Edit",
"logProgress":false,
"logVerbose":false,
"creationTime":"2015-04-16T21:13:26.173+00:00",
"lastModifiedTime":"2015-04-26T21:55:38.96+00:00",
"serviceManagementTags":null
}
},
{
"id":null,
"location":null,
"type":"Microsoft.Automation\/AutomationAccount\/Runbook",
"name":"LitwareHelloWorld",
"properties":{
"runbookType":"Script",
"state":"New",
"logProgress":false,
"logVerbose":false,
"creationTime":"2015-04-15T02:37:29.6+00:00",
"lastModifiedTime":"2015-04-15T02:37:29.6+00:00",
"serviceManagementTags":null
}
},
{
"id":null,
"location":null,
"type":"Microsoft.Automation\/AutomationAccount\/Runbook",
"name":"LitwareRB01",
"properties":{
"runbookType":"Script",
"state":"New",
"logProgress":false,
"logVerbose":false,
"creationTime":"2015-04-13T18:21:41.867+00:00",
"lastModifiedTime":"2015-04-13T18:21:41.867+00:00",
"serviceManagementTags":null
}
},
{
"id":null,
"location":null,
"type":"Microsoft.Automation\/AutomationAccount\/Runbook",
"name":"LitwareRB02",
"properties":{
"runbookType":"Script",
"state":"New",
"logProgress":false,
"logVerbose":false,
"creationTime":"2015-04-13T23:47:19.9+00:00",
"lastModifiedTime":"2015-04-13T23:47:27.997+00:00",
"serviceManagementTags":null
}
},
{
"id":null,
"location":null,
"type":"Microsoft.Automation\/AutomationAccount\/Runbook",
"name":"LitwareRB03",
"properties":{
"runbookType":"Script",
"state":"New",
"logProgress":false,
"logVerbose":false,
"creationTime":"2015-04-15T03:10:24.383+00:00",
"lastModifiedTime":"2015-04-15T03:10:30.93+00:00",
"serviceManagementTags":null
}
},
{
"id":null,
"location":null,
"type":"Microsoft.Automation\/AutomationAccount\/Runbook",
"name":"Write-HelloWorld",
"properties":{
"runbookType":"Script",
"state":"Published",
"logProgress":false,
"logVerbose":false,
"creationTime":"2015-04-26T05:45:42.457+00:00",
"lastModifiedTime":"2015-04-27T03:54:48.03+00:00",
"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 the runbook. |
type | The type of the resource (e.g., Microsoft.Automation/AutomationAccount/Runbook) |
name | The name of the runbook. |
properties/runbookType | "Script" is the only supported type. |
properties/state | The status of the runbook. The possible values are: new, edit, published. |
properties/logVerbose | Indicates whether logging is set to include verbose details. |
properties/logProgress | Indicates whether to log progress. |
properties/creationTime | The date and time the runbook was created. |
properties/lastModifiedTime | The date and time the runbook was last changed. |
properties/serviceManagementTags | Freeform values available to the runbook. |
nextLink | Returned only when the number of records exceeds the page size (100 records). This link, and any subsequent links, returns the next page of records. |