Microsoft.Automation automationAccounts/runbooks 2018-06-30

The automationAccounts/runbooks resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Automation/automationAccounts/runbooks resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2018-06-30' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    description: 'string'
    draft: {
      creationTime: 'string'
      draftContentLink: {
        contentHash: {
          algorithm: 'string'
          value: 'string'
        }
        uri: 'string'
        version: 'string'
      }
      inEdit: bool
      lastModifiedTime: 'string'
      outputTypes: [ 'string' ]
      parameters: {}
    }
    logActivityTrace: int
    logProgress: bool
    logVerbose: bool
    publishContentLink: {
      contentHash: {
        algorithm: 'string'
        value: 'string'
      }
      uri: 'string'
      version: 'string'
    }
    runbookType: 'string'
  }
}

Property values

automationAccounts/runbooks

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Automation/automationAccounts/runbooks'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-06-30'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
location The Azure Region where the resource lives string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Definition of the runbook property type. RunbookCreateOrUpdateProperties (required)

RunbookCreateOrUpdateProperties

Name Description Value
description Gets or sets the description. string
draft RunbookDraft
logActivityTrace Gets or sets the option to log activity trace of the runbook. int
logProgress Gets or sets progress log option. bool
logVerbose Gets or sets verbose log option. bool
publishContentLink Definition of the content link. ContentLink
runbookType Gets or sets the type of the runbook. 'Graph'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShellWorkflow'
'Script'

RunbookDraft

Name Description Value
creationTime Gets or sets the creation time of the runbook draft. string
draftContentLink Definition of the content link. ContentLink
inEdit Gets or sets whether runbook is in edit mode. bool
lastModifiedTime Gets or sets the last modified time of the runbook draft. string
outputTypes Gets or sets the runbook output types. string[]
parameters Gets or sets the runbook draft parameters. object
Name Description Value
contentHash Definition of the runbook property type. ContentHash
uri Gets or sets the uri of the runbook content. string
version Gets or sets the version of the content. string

ContentHash

Name Description Value
algorithm Gets or sets the content hash algorithm used to hash the content. string (required)
value Gets or sets expected hash value of the content. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
ASR Runbooks

Deploy to Azure
Deploys Automation Runbooks for ASR Recovery Plans
OMS ASR Solution

Deploy to Azure
Enables the ASR (v2) Solution in OMS
Azure Resource Optimization (ARO) Toolkit

Deploy to Azure
The Azure Resource Optimization Toolkit is a decentralized, native Azure solution using serverless technologies to optimize Azure resources on your subscription. Optimization happens automatically on your subscription once you enable or create your own schedule, including on new resources. This is an Azure Automation account with preconfigured runbooks and schedules you can utilize on your subscription to start saving money.
OMS - Azure Resource Usage Solution

Deploy to Azure
Solution brings billing infortmation about Azure Resources into OMS. Cost of resources can be displayed in different currency and locale.
OMS - Azure VM Inventory Solution

Deploy to Azure
Enables Azure VM Inventory Solution in OMS. Solution collects Azure VM inventory along with disks, networking components, NSG rules and extensions into OMS workspace.
OMS Solution - Hyper-V Replica

Deploy to Azure
A template for creating an OMS solution to monitor Hyper-V replica.
OMS Service Bus Solution

Deploy to Azure
Monitors Azure Service Bus instances
OMS VMM Analytics

Deploy to Azure
Provides a single view of the jobs' status across multiple VMM instances that helps you gain insight about the health & performance of these jobs.
Create Azure Automation account

Deploy to Azure
This template provides an example of how create an Azure Automation account and links it to a new or existing Azure Monitor Log Analytics workspace.