Schedule

Manages a Automation Schedule.

Create a Schedule Resource

new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);

def Schedule(resource_name, opts=None, automation_account_name=None, description=None, expiry_time=None, frequency=None, interval=None, month_days=None, monthly_occurrences=None, name=None, resource_group_name=None, start_time=None, timezone=None, week_days=None, __props__=None);

func NewSchedule(ctx *Context, name string, args ScheduleArgs, opts ...ResourceOption) (*Schedule, error)

public Schedule(string name, ScheduleArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Schedule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Schedule resource accepts the following input properties:

AutomationAccountName string: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.
Frequency string: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.
ResourceGroupName string: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.
Description string: A description for this Schedule.
ExpiryTime string: The end time of the schedule.
Interval int: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
MonthDays List<int>: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.
MonthlyOccurrences List<ScheduleMonthlyOccurrenceArgs>: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.
Name string: Specifies the name of the Schedule. Changing this forces a new resource to be created.
StartTime string: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.
Timezone string: The timezone of the start time. Defaults to UTC. For possible values see: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
WeekDays List<string>: List of days of the week that the job should execute on. Only valid when frequency is Week.

AutomationAccountName string: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.
Frequency string: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.
ResourceGroupName string: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.
Description string: A description for this Schedule.
ExpiryTime string: The end time of the schedule.
Interval int: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
MonthDays []int: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.
MonthlyOccurrences []ScheduleMonthlyOccurrence: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.
Name string: Specifies the name of the Schedule. Changing this forces a new resource to be created.
StartTime string: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.
Timezone string: The timezone of the start time. Defaults to UTC. For possible values see: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
WeekDays []string: List of days of the week that the job should execute on. Only valid when frequency is Week.

automationAccountName string: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.
frequency string: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.
resourceGroupName string: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.
description string: A description for this Schedule.
expiryTime string: The end time of the schedule.
interval number: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
monthDays number[]: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.
monthlyOccurrences ScheduleMonthlyOccurrence[]: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.
name string: Specifies the name of the Schedule. Changing this forces a new resource to be created.
startTime string: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.
timezone string: The timezone of the start time. Defaults to UTC. For possible values see: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
weekDays string[]: List of days of the week that the job should execute on. Only valid when frequency is Week.

automation_account_name str: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.
frequency str: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.
resource_group_name str: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.
description str: A description for this Schedule.
expiry_time str: The end time of the schedule.
interval float: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
month_days List[Integer]: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.
monthly_occurrences List[ScheduleMonthlyOccurrence]: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.
name str: Specifies the name of the Schedule. Changing this forces a new resource to be created.
start_time str: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.
timezone str: The timezone of the start time. Defaults to UTC. For possible values see: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
week_days List[str]: List of days of the week that the job should execute on. Only valid when frequency is Week.

Outputs

All input properties are implicitly available as output properties. Additionally, the Schedule resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Schedule Resource

Get an existing Schedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ScheduleState, opts?: CustomResourceOptions): Schedule

static get(resource_name, id, opts=None, automation_account_name=None, description=None, expiry_time=None, frequency=None, interval=None, month_days=None, monthly_occurrences=None, name=None, resource_group_name=None, start_time=None, timezone=None, week_days=None, __props__=None);

func GetSchedule(ctx *Context, name string, id IDInput, state *ScheduleState, opts ...ResourceOption) (*Schedule, error)

public static Schedule Get(string name, Input<string> id, ScheduleState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutomationAccountName string: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.
Description string: A description for this Schedule.
ExpiryTime string: The end time of the schedule.
Frequency string: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.
Interval int: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
MonthDays List<int>: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.
MonthlyOccurrences List<ScheduleMonthlyOccurrenceArgs>: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.
Name string: Specifies the name of the Schedule. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.
StartTime string: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.
Timezone string: The timezone of the start time. Defaults to UTC. For possible values see: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
WeekDays List<string>: List of days of the week that the job should execute on. Only valid when frequency is Week.

AutomationAccountName string: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.
Description string: A description for this Schedule.
ExpiryTime string: The end time of the schedule.
Frequency string: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.
Interval int: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
MonthDays []int: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.
MonthlyOccurrences []ScheduleMonthlyOccurrence: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.
Name string: Specifies the name of the Schedule. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.
StartTime string: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.
Timezone string: The timezone of the start time. Defaults to UTC. For possible values see: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
WeekDays []string: List of days of the week that the job should execute on. Only valid when frequency is Week.

automationAccountName string: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.
description string: A description for this Schedule.
expiryTime string: The end time of the schedule.
frequency string: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.
interval number: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
monthDays number[]: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.
monthlyOccurrences ScheduleMonthlyOccurrence[]: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.
name string: Specifies the name of the Schedule. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.
startTime string: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.
timezone string: The timezone of the start time. Defaults to UTC. For possible values see: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
weekDays string[]: List of days of the week that the job should execute on. Only valid when frequency is Week.

automation_account_name str: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.
description str: A description for this Schedule.
expiry_time str: The end time of the schedule.
frequency str: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.
interval float: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
month_days List[Integer]: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.
monthly_occurrences List[ScheduleMonthlyOccurrence]: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.
name str: Specifies the name of the Schedule. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.
start_time str: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.
timezone str: The timezone of the start time. Defaults to UTC. For possible values see: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
week_days List[str]: List of days of the week that the job should execute on. Only valid when frequency is Week.

Supporting Types

ScheduleMonthlyOccurrence

See the input and output API doc for this type.

Day string: Day of the occurrence. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
Occurrence int: Occurrence of the week within the month. Must be between 1 and 5. -1 for last week within the month.

Day string: Day of the occurrence. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
Occurrence int: Occurrence of the week within the month. Must be between 1 and 5. -1 for last week within the month.

day string: Day of the occurrence. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
occurrence number: Occurrence of the week within the month. Must be between 1 and 5. -1 for last week within the month.

day str: Day of the occurrence. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
occurrence float: Occurrence of the week within the month. Must be between 1 and 5. -1 for last week within the month.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud