Get information about a draft runbook
The Get information about a draft runbook operation returns information about a draft of a specified runbook. There can only be one draft of a runbook.
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 draft runbook 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>/runbooks/<runbook-name>/draft?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
{
"creationTime":"2015-04-26T21:55:38.96+00:00",
"lastModifiedTime":"2015-04-27T04:28:08.26+00:00",
"inEdit":true,
"parameters":{
"ServiceName":{
"type":"System.String",
"isMandatory":true,
"position":2,
"defaultValue":null
},
"VMName":{
"type":"System.String",
"isMandatory":true,
"position":3,
"defaultValue":null
},
"LocalPath":{
"type":"System.String",
"isMandatory":true,
"position":5,
"defaultValue":null
},
"RemotePath":{
"type":"System.String",
"isMandatory":true,
"position":6,
"defaultValue":null
},
"VMCredentialName":{
"type":"System.String",
"isMandatory":true,
"position":4,
"defaultValue":null
},
"AzureSubscriptionName":{
"type":"System.String",
"isMandatory":true,
"position":0,
"defaultValue":null
},
"AzureOrgIdCredential":{
"type":"System.Management.Automation.PSCredential",
"isMandatory":true,
"position":1,
"defaultValue":null
}
}
}
Element |
Description |
|---|---|
creationTime |
The date and time the runbook draft was created. |
lastModifiedTime |
The date and time the runbook draft was last changed. |
inEdit |
Indicates whether the runbook is in edit mode. If false, a draft of this runbook does not exist. |
parameters |
Parameters defined by the runbook, that includes the following values for the following fields:
|