Schedule

Manages automated startup and shutdown schedules for Azure Dev Test Lab.

Create a Schedule Resource

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

def Schedule(resource_name, opts=None, daily_recurrence=None, hourly_recurrence=None, lab_name=None, location=None, name=None, notification_settings=None, resource_group_name=None, status=None, tags=None, task_type=None, time_zone_id=None, weekly_recurrence=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:

LabName string: The name of the dev test lab. Changing this forces a new resource to be created.
NotificationSettings ScheduleNotificationSettingsArgs
ResourceGroupName string: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
TaskType string: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
TimeZoneId string: The time zone ID (e.g. Pacific Standard time).
DailyRecurrence ScheduleDailyRecurrenceArgs
HourlyRecurrence ScheduleHourlyRecurrenceArgs
Location string: The location where the schedule is created. Changing this forces a new resource to be created.
Name string: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
Status string: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
WeeklyRecurrence ScheduleWeeklyRecurrenceArgs

LabName string: The name of the dev test lab. Changing this forces a new resource to be created.
NotificationSettings ScheduleNotificationSettings
ResourceGroupName string: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
TaskType string: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
TimeZoneId string: The time zone ID (e.g. Pacific Standard time).
DailyRecurrence ScheduleDailyRecurrence
HourlyRecurrence ScheduleHourlyRecurrence
Location string: The location where the schedule is created. Changing this forces a new resource to be created.
Name string: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
Status string: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
Tags map[string]string: A mapping of tags to assign to the resource.
WeeklyRecurrence ScheduleWeeklyRecurrence

labName string: The name of the dev test lab. Changing this forces a new resource to be created.
notificationSettings ScheduleNotificationSettings
resourceGroupName string: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
taskType string: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
timeZoneId string: The time zone ID (e.g. Pacific Standard time).
dailyRecurrence ScheduleDailyRecurrence
hourlyRecurrence ScheduleHourlyRecurrence
location string: The location where the schedule is created. Changing this forces a new resource to be created.
name string: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
status string: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
weeklyRecurrence ScheduleWeeklyRecurrence

lab_name str: The name of the dev test lab. Changing this forces a new resource to be created.
notification_settings Dict[ScheduleNotificationSettings]
resource_group_name str: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
task_type str: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
time_zone_id str: The time zone ID (e.g. Pacific Standard time).
daily_recurrence Dict[ScheduleDailyRecurrence]
hourly_recurrence Dict[ScheduleHourlyRecurrence]
location str: The location where the schedule is created. Changing this forces a new resource to be created.
name str: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
status str: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
tags Dict[str, str]: A mapping of tags to assign to the resource.
weekly_recurrence Dict[ScheduleWeeklyRecurrence]

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, daily_recurrence=None, hourly_recurrence=None, lab_name=None, location=None, name=None, notification_settings=None, resource_group_name=None, status=None, tags=None, task_type=None, time_zone_id=None, weekly_recurrence=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:

DailyRecurrence ScheduleDailyRecurrenceArgs
HourlyRecurrence ScheduleHourlyRecurrenceArgs
LabName string: The name of the dev test lab. Changing this forces a new resource to be created.
Location string: The location where the schedule is created. Changing this forces a new resource to be created.
Name string: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
NotificationSettings ScheduleNotificationSettingsArgs
ResourceGroupName string: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
Status string: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
TaskType string: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
TimeZoneId string: The time zone ID (e.g. Pacific Standard time).
WeeklyRecurrence ScheduleWeeklyRecurrenceArgs

DailyRecurrence ScheduleDailyRecurrence
HourlyRecurrence ScheduleHourlyRecurrence
LabName string: The name of the dev test lab. Changing this forces a new resource to be created.
Location string: The location where the schedule is created. Changing this forces a new resource to be created.
Name string: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
NotificationSettings ScheduleNotificationSettings
ResourceGroupName string: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
Status string: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
Tags map[string]string: A mapping of tags to assign to the resource.
TaskType string: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
TimeZoneId string: The time zone ID (e.g. Pacific Standard time).
WeeklyRecurrence ScheduleWeeklyRecurrence

dailyRecurrence ScheduleDailyRecurrence
hourlyRecurrence ScheduleHourlyRecurrence
labName string: The name of the dev test lab. Changing this forces a new resource to be created.
location string: The location where the schedule is created. Changing this forces a new resource to be created.
name string: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
notificationSettings ScheduleNotificationSettings
resourceGroupName string: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
status string: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
taskType string: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
timeZoneId string: The time zone ID (e.g. Pacific Standard time).
weeklyRecurrence ScheduleWeeklyRecurrence

daily_recurrence Dict[ScheduleDailyRecurrence]
hourly_recurrence Dict[ScheduleHourlyRecurrence]
lab_name str: The name of the dev test lab. Changing this forces a new resource to be created.
location str: The location where the schedule is created. Changing this forces a new resource to be created.
name str: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
notification_settings Dict[ScheduleNotificationSettings]
resource_group_name str: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
status str: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
tags Dict[str, str]: A mapping of tags to assign to the resource.
task_type str: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
time_zone_id str: The time zone ID (e.g. Pacific Standard time).
weekly_recurrence Dict[ScheduleWeeklyRecurrence]

Supporting Types

ScheduleDailyRecurrence

See the input and output API doc for this type.

Time string: The time each day when the schedule takes effect.

Time string: The time each day when the schedule takes effect.

time string: The time each day when the schedule takes effect.

time str: The time each day when the schedule takes effect.

ScheduleHourlyRecurrence

See the input and output API doc for this type.

Minute int

Minute int

minute number

minute float

ScheduleNotificationSettings

See the input and output API doc for this type.

Status string: The status of the notification. Possible values are Enabled and Disabled. Defaults to Disabled
TimeInMinutes int: Time in minutes before event at which notification will be sent.
WebhookUrl string: The webhook URL to which the notification will be sent.

Status string: The status of the notification. Possible values are Enabled and Disabled. Defaults to Disabled
TimeInMinutes int: Time in minutes before event at which notification will be sent.
WebhookUrl string: The webhook URL to which the notification will be sent.

status string: The status of the notification. Possible values are Enabled and Disabled. Defaults to Disabled
timeInMinutes number: Time in minutes before event at which notification will be sent.
webhookUrl string: The webhook URL to which the notification will be sent.

status str: The status of the notification. Possible values are Enabled and Disabled. Defaults to Disabled
timeInMinutes float: Time in minutes before event at which notification will be sent.
webhookUrl str: The webhook URL to which the notification will be sent.

ScheduleWeeklyRecurrence

See the input and output API doc for this type.

Time string: The time when the schedule takes effect.
WeekDays List<string>: A list of days that this schedule takes effect . Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

Time string: The time when the schedule takes effect.
WeekDays []string: A list of days that this schedule takes effect . Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

time string: The time when the schedule takes effect.
weekDays string[]: A list of days that this schedule takes effect . Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

time str: The time when the schedule takes effect.
week_days List[str]: A list of days that this schedule takes effect . Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

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

Schedule

Create a Schedule Resource

Schedule Resource Properties

Inputs

Outputs

Look up an Existing Schedule Resource

Supporting Types

ScheduleDailyRecurrence

ScheduleHourlyRecurrence

ScheduleNotificationSettings

ScheduleWeeklyRecurrence

Package Details

On This Page