Class Schedule

Manages a Automation Schedule.

Inheritance

System.Object

Resource

CustomResource

Schedule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Automation

Assembly: Pulumi.Azure.dll

Syntax

public class Schedule : CustomResource

Constructors

Schedule(String, ScheduleArgs, CustomResourceOptions)

Create a Schedule resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ScheduleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AutomationAccountName

The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.

Declaration

public Output<string> AutomationAccountName { get; }

Property Value

Type	Description
Output<System.String>

Description

A description for this Schedule.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

ExpiryTime

The end time of the schedule.

Declaration

public Output<string> ExpiryTime { get; }

Property Value

Type	Description
Output<System.String>

Frequency

The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.

Declaration

public Output<string> Frequency { get; }

Property Value

Type	Description
Output<System.String>

Interval

The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.

Declaration

public Output<int> Interval { get; }

Property Value

Type	Description
Output<System.Int32>

MonthDays

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.

Declaration

public Output<ImmutableArray<int>> MonthDays { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.Int32>>

MonthlyOccurrences

List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.

Declaration

public Output<ImmutableArray<ScheduleMonthlyOccurrence>> MonthlyOccurrences { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ScheduleMonthlyOccurrence>>

Name

Specifies the name of the Schedule. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

StartTime

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.

Declaration

public Output<string> StartTime { get; }

Property Value

Type	Description
Output<System.String>

Timezone

The timezone of the start time. Defaults to UTC. For possible values see: https://msdn.microsoft.com/en-us/library/ms912391(v=winembedded.11).aspx

Declaration

public Output<string> Timezone { get; }

Property Value

Type	Description
Output<System.String>

WeekDays

List of days of the week that the job should execute on. Only valid when frequency is Week.

Declaration

public Output<ImmutableArray<string>> WeekDays { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

Get(String, Input<String>, ScheduleState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ScheduleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Schedule