runbook_drafts
Creates, updates, deletes, gets or lists a runbook_drafts
resource.
Overview
Name | runbook_drafts |
Type | Resource |
Id | azure.automation.runbook_drafts |
Fields
The following fields are returned by SELECT
queries:
- get
Name | Datatype | Description |
---|---|---|
creationTime | string (date-time) | Gets or sets the creation time of the runbook draft. |
draftContentLink | object | Gets or sets the draft runbook content link. |
inEdit | boolean | Gets or sets whether runbook is in edit mode. |
lastModifiedTime | string (date-time) | Gets or sets the last modified time of the runbook draft. |
outputTypes | array | Gets or sets the runbook output types. |
parameters | object | Gets or sets the runbook draft parameters. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , automationAccountName , runbookName | Retrieve the runbook draft identified by runbook name. | |
undo_edit | exec | subscriptionId , resourceGroupName , automationAccountName , runbookName | Undo draft edit to last known published state identified by runbook name. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
automationAccountName | string | The name of the automation account. |
resourceGroupName | string | Name of an Azure Resource group. |
runbookName | string | The runbook name. |
subscriptionId | string | Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
SELECT
examples
- get
Retrieve the runbook draft identified by runbook name.
SELECT
creationTime,
draftContentLink,
inEdit,
lastModifiedTime,
outputTypes,
parameters
FROM azure.automation.runbook_drafts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND runbookName = '{{ runbookName }}' -- required
;
Lifecycle Methods
- undo_edit
Undo draft edit to last known published state identified by runbook name.
EXEC azure.automation.runbook_drafts.undo_edit
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@automationAccountName='{{ automationAccountName }}' --required,
@runbookName='{{ runbookName }}' --required
;