Microsoft.Automation automationAccounts/jobSchedules 2023-11-01

• Latest
• 2023-11-01
• 2023-05-15-preview
• 2022-08-08
• 2020-01-13-preview
• 2019-06-01
• 2015-10-31

Bicep resource definition

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

resource symbolicname 'Microsoft.Automation/automationAccounts/jobSchedules@2023-11-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    parameters: {
      {customized property}: 'string'
    }
    runbook: {
      name: 'string'
    }
    runOn: 'string'
    schedule: {
      name: 'string'
    }
  }
}

Property values

automationAccounts/jobSchedules

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	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 job schedule properties.	JobScheduleCreatePropertiesOrJobScheduleProperties (required)

JobScheduleCreatePropertiesOrJobScheduleProperties

Name	Description	Value
parameters	Gets or sets a list of job properties.	JobScheduleCreatePropertiesParameters
runbook	Gets or sets the runbook.	RunbookAssociationProperty (required)
runOn	Gets or sets the hybrid worker group that the scheduled job should run on.	string
schedule	Gets or sets the schedule.	ScheduleAssociationProperty (required)

JobScheduleCreatePropertiesParameters

Name	Description	Value
{customized property}		string

RunbookAssociationProperty

Name	Description	Value
name	Gets or sets the name of the runbook.	string

ScheduleAssociationProperty

Name	Description	Value
name	Gets or sets the name of the Schedule.	string

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

{
  "type": "Microsoft.Automation/automationAccounts/jobSchedules",
  "apiVersion": "2023-11-01",
  "name": "string",
  "properties": {
    "parameters": {
      "{customized property}": "string"
    },
    "runbook": {
      "name": "string"
    },
    "runOn": "string",
    "schedule": {
      "name": "string"
    }
  }
}

Property values

automationAccounts/jobSchedules

Name	Description	Value
type	The resource type	'Microsoft.Automation/automationAccounts/jobSchedules'
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)
properties	Gets or sets the list of job schedule properties.	JobScheduleCreatePropertiesOrJobScheduleProperties (required)

JobScheduleCreatePropertiesOrJobScheduleProperties

Name	Description	Value
parameters	Gets or sets a list of job properties.	JobScheduleCreatePropertiesParameters
runbook	Gets or sets the runbook.	RunbookAssociationProperty (required)
runOn	Gets or sets the hybrid worker group that the scheduled job should run on.	string
schedule	Gets or sets the schedule.	ScheduleAssociationProperty (required)

JobScheduleCreatePropertiesParameters

Name	Description	Value
{customized property}		string

RunbookAssociationProperty

Name	Description	Value
name	Gets or sets the name of the runbook.	string

ScheduleAssociationProperty

Name	Description	Value
name	Gets or sets the name of the Schedule.	string

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/jobSchedules@2023-11-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      parameters = {
        {customized property} = "string"
      }
      runbook = {
        name = "string"
      }
      runOn = "string"
      schedule = {
        name = "string"
      }
    }
  })
}

Property values

automationAccounts/jobSchedules

Name	Description	Value
type	The resource type	"Microsoft.Automation/automationAccounts/jobSchedules@2023-11-01"
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 job schedule properties.	JobScheduleCreatePropertiesOrJobScheduleProperties (required)

JobScheduleCreatePropertiesOrJobScheduleProperties

Name	Description	Value
parameters	Gets or sets a list of job properties.	JobScheduleCreatePropertiesParameters
runbook	Gets or sets the runbook.	RunbookAssociationProperty (required)
runOn	Gets or sets the hybrid worker group that the scheduled job should run on.	string
schedule	Gets or sets the schedule.	ScheduleAssociationProperty (required)

JobScheduleCreatePropertiesParameters

Name	Description	Value
{customized property}		string

RunbookAssociationProperty

Name	Description	Value
name	Gets or sets the name of the runbook.	string

ScheduleAssociationProperty

Name	Description	Value
name	Gets or sets the name of the Schedule.	string