Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2024-10-23' = {
parent: resourceSymbolicName
name: 'string'
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
Microsoft.Automation/automationAccounts/schedules
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| 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) |
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 |
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. | any |
| startTime | Gets or sets the start time of the schedule. | string (required) |
| timeZone | Gets or sets the time zone of the schedule. | string |
Usage Examples
Bicep Samples
A basic example of deploying Automation Schedule.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource automationAccount 'Microsoft.Automation/automationAccounts@2021-06-22' = {
name: resourceName
location: location
properties: {
encryption: {
keySource: 'Microsoft.Automation'
}
publicNetworkAccess: true
sku: {
name: 'Basic'
}
}
}
resource schedule 'Microsoft.Automation/automationAccounts/schedules@2020-01-13-preview' = {
parent: automationAccount
name: resourceName
properties: {
description: ''
frequency: 'OneTime'
startTime: '2024-07-05T08:51:00+00:00'
timeZone: 'Etc/UTC'
}
}
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": "2024-10-23",
"name": "string",
"properties": {
"advancedSchedule": {
"monthDays": [ "int" ],
"monthlyOccurrences": [
{
"day": "string",
"occurrence": "int"
}
],
"weekDays": [ "string" ]
},
"description": "string",
"expiryTime": "string",
"frequency": "string",
"interval": {},
"startTime": "string",
"timeZone": "string"
}
}
Property Values
Microsoft.Automation/automationAccounts/schedules
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-10-23' |
| name | The resource name | string (required) |
| properties | Gets or sets the list of schedule properties. | ScheduleCreateOrUpdatePropertiesOrScheduleProperties (required) |
| type | The resource type | 'Microsoft.Automation/automationAccounts/schedules' |
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 |
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. | any |
| startTime | Gets or sets the start time of the schedule. | string (required) |
| timeZone | Gets or sets the time zone of the schedule. | string |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
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. |
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@2024-10-23"
name = "string"
parent_id = "string"
body = {
properties = {
advancedSchedule = {
monthDays = [
int
]
monthlyOccurrences = [
{
day = "string"
occurrence = int
}
]
weekDays = [
"string"
]
}
description = "string"
expiryTime = "string"
frequency = "string"
interval = ?
startTime = "string"
timeZone = "string"
}
}
}
Property Values
Microsoft.Automation/automationAccounts/schedules
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| 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) |
| type | The resource type | "Microsoft.Automation/automationAccounts/schedules@2024-10-23" |
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 |
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. | any |
| startTime | Gets or sets the start time of the schedule. | string (required) |
| timeZone | Gets or sets the time zone of the schedule. | string |
Usage Examples
Terraform Samples
A basic example of deploying Automation Schedule.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "automationAccount" {
type = "Microsoft.Automation/automationAccounts@2021-06-22"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
encryption = {
keySource = "Microsoft.Automation"
}
publicNetworkAccess = true
sku = {
name = "Basic"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "schedule" {
type = "Microsoft.Automation/automationAccounts/schedules@2020-01-13-preview"
parent_id = azapi_resource.automationAccount.id
name = var.resource_name
body = {
properties = {
description = ""
frequency = "OneTime"
startTime = "2024-07-05T08:51:00+00:00"
timeZone = "Etc/UTC"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}