runbooks

Creates, updates, deletes, gets or lists a runbooks resource.

Overview

Name	runbooks
Type	Resource
Id	azure.automation.runbooks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
etag	string	Gets or sets the etag of the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets or sets the runbook properties.
tags	object	Resource tags.

list_by_automation_account

Name	Datatype	Description
etag	string	Gets or sets the etag of the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets or sets the runbook properties.
tags	object	Resource tags.

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 identified by runbook name.
list_by_automation_account	select	subscriptionId, resourceGroupName, automationAccountName		Retrieve a list of runbooks.
create_or_update	insert	subscriptionId, resourceGroupName, automationAccountName, runbookName, data__properties		Create the runbook identified by runbook name.
update	update	subscriptionId, resourceGroupName, automationAccountName, runbookName		Update the runbook identified by runbook name.
delete	delete	subscriptionId, resourceGroupName, automationAccountName, runbookName		Delete the runbook by name.
publish	exec	subscriptionId, resourceGroupName, automationAccountName, runbookName		Publish runbook draft.

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 parameters supplied to the publish runbook operation.
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 identified by runbook name.

SELECT
etag,
location,
properties,
tags
FROM azure.automation.runbooks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND runbookName = '{{ runbookName }}' -- required
;

list_by_automation_account

Retrieve a list of runbooks.

SELECT
etag,
location,
properties,
tags
FROM azure.automation.runbooks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
;

INSERT examples

create_or_update

Create the runbook identified by runbook name.

INSERT INTO azure.automation.runbooks (
data__properties,
data__name,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
automationAccountName,
runbookName
)
SELECT 
'{{ properties }}' /* required */,
'{{ name }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ runbookName }}'
RETURNING
etag,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: runbooks
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the runbooks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the runbooks resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the runbooks resource.
    - name: runbookName
      value: string
      description: Required parameter for the runbooks resource.
    - name: properties
      value: object
      description: |
        Gets or sets runbook create or update properties.
    - name: name
      value: string
      description: |
        Gets or sets the name of the resource.
    - name: location
      value: string
      description: |
        Gets or sets the location of the resource.
    - name: tags
      value: object
      description: |
        Gets or sets the tags attached to the resource.

UPDATE examples

update

Update the runbook identified by runbook name.

UPDATE azure.automation.runbooks
SET 
data__properties = '{{ properties }}',
data__name = '{{ name }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND runbookName = '{{ runbookName }}' --required
RETURNING
etag,
location,
properties,
tags;

DELETE examples

delete

Delete the runbook by name.

DELETE FROM azure.automation.runbooks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND runbookName = '{{ runbookName }}' --required
;

Lifecycle Methods

publish

Publish runbook draft.

EXEC azure.automation.runbooks.publish 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@automationAccountName='{{ automationAccountName }}' --required, 
@runbookName='{{ runbookName }}' --required
;