ScheduleCreationParameter Class

Properties for creating a schedule.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

ScheduleCreationParameter(*, name: str | None = None, tags: dict[str, str] | None = None, status: str | _models.EnableStatus | None = None, task_type: str | None = None, weekly_recurrence: _models.WeekDetails | None = None, daily_recurrence: _models.DayDetails | None = None, hourly_recurrence: _models.HourDetails | None = None, time_zone_id: str | None = None, notification_settings: _models.NotificationSettings | None = None, target_resource_id: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str The name of the virtual machine or environment. Default value: None
tags	dict[str, str] The tags of the resource. Default value: None
status	str or EnableStatus The status of the schedule (i.e. Enabled, Disabled). Known values are: "Enabled" and "Disabled". Default value: None
task_type	str The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). Default value: None
weekly_recurrence	WeekDetails If the schedule will occur only some days of the week, specify the weekly recurrence. Default value: None
daily_recurrence	DayDetails If the schedule will occur once each day of the week, specify the daily recurrence. Default value: None
hourly_recurrence	HourDetails If the schedule will occur multiple times a day, specify the hourly recurrence. Default value: None
time_zone_id	str The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md). Default value: None
notification_settings	NotificationSettings Notification settings. Default value: None
target_resource_id	str The resource ID to which the schedule belongs. Default value: None

Variables

Name	Description
name	str The name of the virtual machine or environment.
location	str The location of the new virtual machine or environment.
tags	dict[str, str] The tags of the resource.
status	str or EnableStatus The status of the schedule (i.e. Enabled, Disabled). Known values are: "Enabled" and "Disabled".
task_type	str The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
weekly_recurrence	WeekDetails If the schedule will occur only some days of the week, specify the weekly recurrence.
daily_recurrence	DayDetails If the schedule will occur once each day of the week, specify the daily recurrence.
hourly_recurrence	HourDetails If the schedule will occur multiple times a day, specify the hourly recurrence.
time_zone_id	str The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md).
notification_settings	NotificationSettings Notification settings.
target_resource_id	str The resource ID to which the schedule belongs.