Microsoft.Automation automationAccounts/runbooks

Template format

To create a Microsoft.Automation/automationAccounts/runbooks resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Automation/automationAccounts/runbooks",
  "apiVersion": "2019-06-01",
  "properties": {
    "logVerbose": "boolean",
    "logProgress": "boolean",
    "runbookType": "string",
    "draft": {
      "inEdit": "boolean",
      "draftContentLink": {
        "uri": "string",
        "contentHash": {
          "algorithm": "string",
          "value": "string"
        },
        "version": "string"
      },
      "creationTime": "string",
      "lastModifiedTime": "string",
      "parameters": {},
      "outputTypes": [
        "string"
      ]
    },
    "publishContentLink": {
      "uri": "string",
      "contentHash": {
        "algorithm": "string",
        "value": "string"
      },
      "version": "string"
    },
    "description": "string",
    "logActivityTrace": "integer"
  },
  "location": "string",
  "tags": {}
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Automation/automationAccounts/runbooks object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The runbook name.
type enum Yes For JSON -runbooks
-or-
Microsoft.Automation/automationAccounts/runbooks

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2019-06-01
properties object Yes Gets or sets runbook create or update properties. - RunbookCreateOrUpdateProperties object
location string No Gets or sets the location of the resource.
tags object No Gets or sets the tags attached to the resource.

RunbookCreateOrUpdateProperties object

Name Type Required Value
logVerbose boolean No Gets or sets verbose log option.
logProgress boolean No Gets or sets progress log option.
runbookType enum Yes Gets or sets the type of the runbook. - Script, Graph, PowerShellWorkflow, PowerShell, GraphPowerShellWorkflow, GraphPowerShell
draft object No Gets or sets the draft runbook properties. - RunbookDraft object
publishContentLink object No Gets or sets the published runbook content link. - ContentLink object
description string No Gets or sets the description of the runbook.
logActivityTrace integer No Gets or sets the activity-level tracing options of the runbook.

RunbookDraft object

Name Type Required Value
inEdit boolean No Gets or sets whether runbook is in edit mode.
draftContentLink object No Gets or sets the draft runbook content link. - ContentLink object
creationTime string No Gets or sets the creation time of the runbook draft.
lastModifiedTime string No Gets or sets the last modified time of the runbook draft.
parameters object No Gets or sets the runbook draft parameters.
outputTypes array No Gets or sets the runbook output types. - string

Name Type Required Value
uri string No Gets or sets the uri of the runbook content.
contentHash object No Gets or sets the hash. - ContentHash object
version string No Gets or sets the version of the content.

ContentHash object

Name Type Required Value
algorithm string Yes Gets or sets the content hash algorithm used to hash the content.
value string Yes Gets or sets expected hash value of the content.

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.