Microsoft.Automation automationAccounts/schedules

Article
04/10/2023

Bicep resource definition

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

resource symbolicname 'Microsoft.Automation/automationAccounts/schedules@2022-08-08' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    advancedSchedule: {
      monthDays: [
        int
      ]
      monthlyOccurrences: [
        {
          day: 'string'
          occurrence: int
        }
      ]
      weekDays: [
        'string'
      ]
    }
    description: 'string'
    expiryTime: 'string'
    frequency: 'string'
    interval: any()
    startTime: 'string'
    timeZone: 'string'
  }
}

Property values

automationAccounts/schedules

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required) Character limit: 1-128 Valid characters: Can't use: `<>*%&:\?.+/` or control characters Can't end with space.
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 list of schedule properties.	ScheduleCreateOrUpdatePropertiesOrScheduleProperties (required)

ScheduleCreateOrUpdatePropertiesOrScheduleProperties

Name	Description	Value
advancedSchedule	Gets or sets the AdvancedSchedule.	AdvancedSchedule
description	Gets or sets the description of the schedule.	string
expiryTime	Gets or sets the end time of the schedule.	string
frequency	Gets or sets the frequency of the schedule.	'Day' 'Hour' 'Minute' 'Month' 'OneTime' 'Week' (required)
interval	Gets or sets the interval of the schedule.	For Bicep, you can use the any() function.
startTime	Gets or sets the start time of the schedule.	string (required)
timeZone	Gets or sets the time zone of the schedule.	string

AdvancedSchedule

Name	Description	Value
monthDays	Days of the month that the job should execute on. Must be between 1 and 31.	int[]
monthlyOccurrences	Occurrences of days within a month.	AdvancedScheduleMonthlyOccurrence[]
weekDays	Days of the week that the job should execute on.	string[]

AdvancedScheduleMonthlyOccurrence

Name	Description	Value
day	Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.	'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday'
occurrence	Occurrence of the week within the month. Must be between 1 and 5	int

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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 Service Bus Solution	Monitors Azure Service Bus instances

ARM template resource definition

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

{
  "type": "Microsoft.Automation/automationAccounts/schedules",
  "apiVersion": "2022-08-08",
  "name": "string",
  "properties": {
    "advancedSchedule": {
      "monthDays": [ "int" ],
      "monthlyOccurrences": [
        {
          "day": "string",
          "occurrence": "int"
        }
      ],
      "weekDays": [ "string" ]
    },
    "description": "string",
    "expiryTime": "string",
    "frequency": "string",
    "interval": "int",
    "startTime": "string",
    "timeZone": "string"
  }
}

Property values

automationAccounts/schedules

Name	Description	Value
type	The resource type	'Microsoft.Automation/automationAccounts/schedules'
apiVersion	The resource api version	'2022-08-08'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required) Character limit: 1-128 Valid characters: Can't use: `<>*%&:\?.+/` or control characters Can't end with space.
properties	Gets or sets the list of schedule properties.	ScheduleCreateOrUpdatePropertiesOrScheduleProperties (required)

ScheduleCreateOrUpdatePropertiesOrScheduleProperties

Name	Description	Value
advancedSchedule	Gets or sets the AdvancedSchedule.	AdvancedSchedule
description	Gets or sets the description of the schedule.	string
expiryTime	Gets or sets the end time of the schedule.	string
frequency	Gets or sets the frequency of the schedule.	'Day' 'Hour' 'Minute' 'Month' 'OneTime' 'Week' (required)
interval	Gets or sets the interval of the schedule.
startTime	Gets or sets the start time of the schedule.	string (required)
timeZone	Gets or sets the time zone of the schedule.	string

AdvancedSchedule

Name	Description	Value
monthDays	Days of the month that the job should execute on. Must be between 1 and 31.	int[]
monthlyOccurrences	Occurrences of days within a month.	AdvancedScheduleMonthlyOccurrence[]
weekDays	Days of the week that the job should execute on.	string[]

AdvancedScheduleMonthlyOccurrence

Name	Description	Value
day	Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.	'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday'
occurrence	Occurrence of the week within the month. Must be between 1 and 5	int

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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 Service Bus Solution	Monitors Azure Service Bus instances

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/schedules@2022-08-08"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      advancedSchedule = {
        monthDays = [
          int
        ]
        monthlyOccurrences = [
          {
            day = "string"
            occurrence = int
          }
        ]
        weekDays = [
          "string"
        ]
      }
      description = "string"
      expiryTime = "string"
      frequency = "string"
      startTime = "string"
      timeZone = "string"
    }
  })
}

Property values

automationAccounts/schedules

Name	Description	Value
type	The resource type	"Microsoft.Automation/automationAccounts/schedules@2022-08-08"
name	The resource name	string (required) Character limit: 1-128 Valid characters: Can't use: `<>*%&:\?.+/` or control characters Can't end with space.
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: automationAccounts
properties	Gets or sets the list of schedule properties.	ScheduleCreateOrUpdatePropertiesOrScheduleProperties (required)

ScheduleCreateOrUpdatePropertiesOrScheduleProperties

Name	Description	Value
advancedSchedule	Gets or sets the AdvancedSchedule.	AdvancedSchedule
description	Gets or sets the description of the schedule.	string
expiryTime	Gets or sets the end time of the schedule.	string
frequency	Gets or sets the frequency of the schedule.	"Day" "Hour" "Minute" "Month" "OneTime" "Week" (required)
interval	Gets or sets the interval of the schedule.
startTime	Gets or sets the start time of the schedule.	string (required)
timeZone	Gets or sets the time zone of the schedule.	string

AdvancedSchedule

Name	Description	Value
monthDays	Days of the month that the job should execute on. Must be between 1 and 31.	int[]
monthlyOccurrences	Occurrences of days within a month.	AdvancedScheduleMonthlyOccurrence[]
weekDays	Days of the week that the job should execute on.	string[]

AdvancedScheduleMonthlyOccurrence

Name	Description	Value
day	Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.	"Friday" "Monday" "Saturday" "Sunday" "Thursday" "Tuesday" "Wednesday"
occurrence	Occurrence of the week within the month. Must be between 1 and 5	int

Microsoft.Automation automationAccounts/schedules

Bicep resource definition

Resource format

Property values

automationAccounts/schedules

ScheduleCreateOrUpdatePropertiesOrScheduleProperties

AdvancedSchedule

AdvancedScheduleMonthlyOccurrence

Quickstart templates

ARM template resource definition

Resource format

Property values

automationAccounts/schedules

ScheduleCreateOrUpdatePropertiesOrScheduleProperties

AdvancedSchedule

AdvancedScheduleMonthlyOccurrence

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

automationAccounts/schedules

ScheduleCreateOrUpdatePropertiesOrScheduleProperties

AdvancedSchedule

AdvancedScheduleMonthlyOccurrence

Additional resources

Additional resources