Microsoft.Automation automationAccounts/runbooks

Article
02/14/2024

Bicep resource definition

The automationAccounts/runbooks resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2023-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    draft: {
      creationTime: 'string'
      draftContentLink: {
        contentHash: {
          algorithm: 'string'
          value: 'string'
        }
        uri: 'string'
        version: 'string'
      }
      inEdit: bool
      lastModifiedTime: 'string'
      outputTypes: [
        'string'
      ]
      parameters: {
        {customized property}: {
          defaultValue: 'string'
          isMandatory: bool
          position: int
          type: 'string'
        }
      }
    }
    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
name	The resource name See how to set names and types for child resources in Bicep.	string (required) Character limit: 1-63 Valid characters: Alphanumerics, underscores, and hyphens. Start with letter.
location	Gets or sets the location of the resource.	string
tags	Gets or sets the tags attached to the resource.	Dictionary of tag names and values. See Tags in templates
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: automationAccounts
properties	Gets or sets runbook create or update properties.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (required)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	Description	Value
description	Gets or sets the description of the runbook.	string
draft	Gets or sets the draft runbook properties.	RunbookDraft
logActivityTrace	Gets or sets the activity-level tracing options of the runbook.	int
logProgress	Gets or sets progress log option.	bool
logVerbose	Gets or sets verbose log option.	bool
publishContentLink	Gets or sets the published runbook content link.	ContentLink
runbookType	Gets or sets the type of the runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python2' 'Python3' 'Script' (required)

RunbookDraft

Name	Description	Value
creationTime	Gets or sets the creation time of the runbook draft.	string
draftContentLink	Gets or sets the draft runbook 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.	RunbookDraftParameters

ContentLink

Name	Description	Value
contentHash	Sets the hash.	ContentHash
uri	Sets the uri of the content.	string
version	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)

RunbookDraftParameters

Name	Description	Value
{customized property}		RunbookParameter

RunbookParameter

Name	Description	Value
defaultValue	Gets or sets the default value of parameter.	string
isMandatory	Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.	bool
position	Get or sets the position of the parameter.	int
type	Gets or sets the type of the parameter.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
ASR Runbooks	Deploys Automation Runbooks for ASR Recovery Plans
OMS ASR Solution	Enables the ASR (v2) Solution in OMS
Azure Resource Optimization (ARO) Toolkit	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	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	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	A template for creating an OMS solution to monitor Hyper-V replica.
OMS Service Bus Solution	Monitors Azure Service Bus instances
OMS VMM Analytics	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	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.

ARM template resource definition

The automationAccounts/runbooks resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Automation/automationAccounts/runbooks",
  "apiVersion": "2023-11-01",
  "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": {
        "{customized property}": {
          "defaultValue": "string",
          "isMandatory": "bool",
          "position": "int",
          "type": "string"
        }
      }
    },
    "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	'Microsoft.Automation/automationAccounts/runbooks'
apiVersion	The resource api version	'2023-11-01'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required) Character limit: 1-63 Valid characters: Alphanumerics, underscores, and hyphens. Start with letter.
location	Gets or sets the location of the resource.	string
tags	Gets or sets the tags attached to the resource.	Dictionary of tag names and values. See Tags in templates
properties	Gets or sets runbook create or update properties.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (required)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	Description	Value
description	Gets or sets the description of the runbook.	string
draft	Gets or sets the draft runbook properties.	RunbookDraft
logActivityTrace	Gets or sets the activity-level tracing options of the runbook.	int
logProgress	Gets or sets progress log option.	bool
logVerbose	Gets or sets verbose log option.	bool
publishContentLink	Gets or sets the published runbook content link.	ContentLink
runbookType	Gets or sets the type of the runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python2' 'Python3' 'Script' (required)

RunbookDraft

Name	Description	Value
creationTime	Gets or sets the creation time of the runbook draft.	string
draftContentLink	Gets or sets the draft runbook 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.	RunbookDraftParameters

ContentLink

Name	Description	Value
contentHash	Sets the hash.	ContentHash
uri	Sets the uri of the content.	string
version	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)

RunbookDraftParameters

Name	Description	Value
{customized property}		RunbookParameter

RunbookParameter

Name	Description	Value
defaultValue	Gets or sets the default value of parameter.	string
isMandatory	Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.	bool
position	Get or sets the position of the parameter.	int
type	Gets or sets the type of the parameter.	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
ASR Runbooks	Deploys Automation Runbooks for ASR Recovery Plans
OMS ASR Solution	Enables the ASR (v2) Solution in OMS
Azure Resource Optimization (ARO) Toolkit	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	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	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	A template for creating an OMS solution to monitor Hyper-V replica.
OMS Service Bus Solution	Monitors Azure Service Bus instances
OMS VMM Analytics	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	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.

Terraform (AzAPI provider) resource definition

The automationAccounts/runbooks resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2023-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      description = "string"
      draft = {
        creationTime = "string"
        draftContentLink = {
          contentHash = {
            algorithm = "string"
            value = "string"
          }
          uri = "string"
          version = "string"
        }
        inEdit = bool
        lastModifiedTime = "string"
        outputTypes = [
          "string"
        ]
        parameters = {
          {customized property} = {
            defaultValue = "string"
            isMandatory = bool
            position = int
            type = "string"
          }
        }
      }
      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	"Microsoft.Automation/automationAccounts/runbooks@2023-11-01"
name	The resource name	string (required) Character limit: 1-63 Valid characters: Alphanumerics, underscores, and hyphens. Start with letter.
location	Gets or sets the location of the resource.	string
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: automationAccounts
tags	Gets or sets the tags attached to the resource.	Dictionary of tag names and values.
properties	Gets or sets runbook create or update properties.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (required)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	Description	Value
description	Gets or sets the description of the runbook.	string
draft	Gets or sets the draft runbook properties.	RunbookDraft
logActivityTrace	Gets or sets the activity-level tracing options of the runbook.	int
logProgress	Gets or sets progress log option.	bool
logVerbose	Gets or sets verbose log option.	bool
publishContentLink	Gets or sets the published runbook content link.	ContentLink
runbookType	Gets or sets the type of the runbook.	"Graph" "GraphPowerShell" "GraphPowerShellWorkflow" "PowerShell" "PowerShell72" "PowerShellWorkflow" "Python2" "Python3" "Script" (required)

RunbookDraft

Name	Description	Value
creationTime	Gets or sets the creation time of the runbook draft.	string
draftContentLink	Gets or sets the draft runbook 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.	RunbookDraftParameters

ContentLink

Name	Description	Value
contentHash	Sets the hash.	ContentHash
uri	Sets the uri of the content.	string
version	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)

RunbookDraftParameters

Name	Description	Value
{customized property}		RunbookParameter

RunbookParameter

Name	Description	Value
defaultValue	Gets or sets the default value of parameter.	string
isMandatory	Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.	bool
position	Get or sets the position of the parameter.	int
type	Gets or sets the type of the parameter.	string

Share via

Microsoft.Automation automationAccounts/runbooks

Bicep resource definition

Resource format

Property values

automationAccounts/runbooks

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

ContentLink

ContentHash

RunbookDraftParameters

RunbookParameter

Quickstart templates

ARM template resource definition

Resource format

Property values

automationAccounts/runbooks

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

ContentLink

ContentHash

RunbookDraftParameters

RunbookParameter

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

automationAccounts/runbooks

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

ContentLink

ContentHash

RunbookDraftParameters

RunbookParameter

Feedback

Additional resources