Microsoft.Automation automationAccounts/modules 2015-10-31

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.Automation/automationAccounts/modules@2015-10-31' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    contentLink: {
      contentHash: {
        algorithm: 'string'
        value: 'string'
      }
      uri: 'string'
      version: 'string'
    }
  }
}

Property values

automationAccounts/modules

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)
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 the module create properties. ModuleCreateOrUpdatePropertiesOrModuleProperties (required)

ModuleCreateOrUpdatePropertiesOrModuleProperties

Name Description Value
contentLink Gets or sets the module content link. ContentLink (required)
Name Description Value
contentHash Gets or sets the hash. 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 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

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.Automation/automationAccounts/modules",
  "apiVersion": "2015-10-31",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "contentLink": {
      "contentHash": {
        "algorithm": "string",
        "value": "string"
      },
      "uri": "string",
      "version": "string"
    }
  }
}

Property values

automationAccounts/modules

Name Description Value
type The resource type 'Microsoft.Automation/automationAccounts/modules'
apiVersion The resource api version '2015-10-31'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
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 the module create properties. ModuleCreateOrUpdatePropertiesOrModuleProperties (required)

ModuleCreateOrUpdatePropertiesOrModuleProperties

Name Description Value
contentLink Gets or sets the module content link. ContentLink (required)
Name Description Value
contentHash Gets or sets the hash. 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 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

Terraform (AzAPI provider) resource definition

The automationAccounts/modules 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/modules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/modules@2015-10-31"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      contentLink = {
        contentHash = {
          algorithm = "string"
          value = "string"
        }
        uri = "string"
        version = "string"
      }
    }
  })
}

Property values

automationAccounts/modules

Name Description Value
type The resource type "Microsoft.Automation/automationAccounts/modules@2015-10-31"
name The resource name string (required)
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 the module create properties. ModuleCreateOrUpdatePropertiesOrModuleProperties (required)

ModuleCreateOrUpdatePropertiesOrModuleProperties

Name Description Value
contentLink Gets or sets the module content link. ContentLink (required)
Name Description Value
contentHash Gets or sets the hash. 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)