Azure Native v2.20.1, Dec 1 23

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.20.1 published on Friday, Dec 1, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.automation.Schedule

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.20.1 published on Friday, Dec 1, 2023 by Pulumi

pulumi/pulumi-azure-native

Example Usage

Create or update a schedule

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var schedule = new AzureNative.Automation.Schedule("schedule", new()
    {
        AdvancedSchedule = null,
        AutomationAccountName = "myAutomationAccount33",
        Description = "my description of schedule goes here",
        ExpiryTime = "2017-04-01T17:28:57.2494819Z",
        Frequency = "Hour",
        Interval = 1,
        Name = "mySchedule",
        ResourceGroupName = "rg",
        ScheduleName = "mySchedule",
        StartTime = "2017-03-27T17:28:57.2494819Z",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure-native-sdk/automation/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := automation.NewSchedule(ctx, "schedule", &automation.ScheduleArgs{
			AdvancedSchedule:      nil,
			AutomationAccountName: pulumi.String("myAutomationAccount33"),
			Description:           pulumi.String("my description of schedule goes here"),
			ExpiryTime:            pulumi.String("2017-04-01T17:28:57.2494819Z"),
			Frequency:             pulumi.String("Hour"),
			Interval:              pulumi.Any(1),
			Name:                  pulumi.String("mySchedule"),
			ResourceGroupName:     pulumi.String("rg"),
			ScheduleName:          pulumi.String("mySchedule"),
			StartTime:             pulumi.String("2017-03-27T17:28:57.2494819Z"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.automation.Schedule;
import com.pulumi.azurenative.automation.ScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var schedule = new Schedule("schedule", ScheduleArgs.builder()        
            .advancedSchedule()
            .automationAccountName("myAutomationAccount33")
            .description("my description of schedule goes here")
            .expiryTime("2017-04-01T17:28:57.2494819Z")
            .frequency("Hour")
            .interval(1)
            .name("mySchedule")
            .resourceGroupName("rg")
            .scheduleName("mySchedule")
            .startTime("2017-03-27T17:28:57.2494819Z")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

schedule = azure_native.automation.Schedule("schedule",
    advanced_schedule=azure_native.automation.AdvancedScheduleArgs(),
    automation_account_name="myAutomationAccount33",
    description="my description of schedule goes here",
    expiry_time="2017-04-01T17:28:57.2494819Z",
    frequency="Hour",
    interval=1,
    name="mySchedule",
    resource_group_name="rg",
    schedule_name="mySchedule",
    start_time="2017-03-27T17:28:57.2494819Z")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const schedule = new azure_native.automation.Schedule("schedule", {
    advancedSchedule: {},
    automationAccountName: "myAutomationAccount33",
    description: "my description of schedule goes here",
    expiryTime: "2017-04-01T17:28:57.2494819Z",
    frequency: "Hour",
    interval: 1,
    name: "mySchedule",
    resourceGroupName: "rg",
    scheduleName: "mySchedule",
    startTime: "2017-03-27T17:28:57.2494819Z",
});

resources:
  schedule:
    type: azure-native:automation:Schedule
    properties:
      advancedSchedule: {}
      automationAccountName: myAutomationAccount33
      description: my description of schedule goes here
      expiryTime: 2017-04-01T17:28:57.2494819Z
      frequency: Hour
      interval: 1
      name: mySchedule
      resourceGroupName: rg
      scheduleName: mySchedule
      startTime: 2017-03-27T17:28:57.2494819Z

Create Schedule Resource

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

@overload
def Schedule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             advanced_schedule: Optional[AdvancedScheduleArgs] = None,
             automation_account_name: Optional[str] = None,
             description: Optional[str] = None,
             expiry_time: Optional[str] = None,
             frequency: Optional[Union[str, ScheduleFrequency]] = None,
             interval: Optional[Any] = None,
             name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             schedule_name: Optional[str] = None,
             start_time: Optional[str] = None,
             time_zone: Optional[str] = None)
@overload
def Schedule(resource_name: str,
             args: ScheduleArgs,
             opts: Optional[ResourceOptions] = None)

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

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

public Schedule(String name, ScheduleArgs args)
public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)

type: azure-native:automation:Schedule
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control 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.

name String: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The Schedule resource accepts the following input properties:

AutomationAccountName string: The name of the automation account.
Frequency string | Pulumi.AzureNative.Automation.ScheduleFrequency: Gets or sets the frequency of the schedule.
Name string: Gets or sets the name of the Schedule.
ResourceGroupName string: Name of an Azure Resource group.
StartTime string: Gets or sets the start time of the schedule.
AdvancedSchedule Pulumi.AzureNative.Automation.Inputs.AdvancedSchedule: Gets or sets the AdvancedSchedule.
Description string: Gets or sets the description of the schedule.
ExpiryTime string: Gets or sets the end time of the schedule.
Interval object: Gets or sets the interval of the schedule.
ScheduleName string: The schedule name.
TimeZone string: Gets or sets the time zone of the schedule.

AutomationAccountName string: The name of the automation account.
Frequency string | ScheduleFrequency: Gets or sets the frequency of the schedule.
Name string: Gets or sets the name of the Schedule.
ResourceGroupName string: Name of an Azure Resource group.
StartTime string: Gets or sets the start time of the schedule.
AdvancedSchedule AdvancedScheduleArgs: Gets or sets the AdvancedSchedule.
Description string: Gets or sets the description of the schedule.
ExpiryTime string: Gets or sets the end time of the schedule.
Interval interface{}: Gets or sets the interval of the schedule.
ScheduleName string: The schedule name.
TimeZone string: Gets or sets the time zone of the schedule.

automationAccountName String: The name of the automation account.
frequency String | ScheduleFrequency: Gets or sets the frequency of the schedule.
name String: Gets or sets the name of the Schedule.
resourceGroupName String: Name of an Azure Resource group.
startTime String: Gets or sets the start time of the schedule.
advancedSchedule AdvancedSchedule: Gets or sets the AdvancedSchedule.
description String: Gets or sets the description of the schedule.
expiryTime String: Gets or sets the end time of the schedule.
interval Object: Gets or sets the interval of the schedule.
scheduleName String: The schedule name.
timeZone String: Gets or sets the time zone of the schedule.

automationAccountName string: The name of the automation account.
frequency string | ScheduleFrequency: Gets or sets the frequency of the schedule.
name string: Gets or sets the name of the Schedule.
resourceGroupName string: Name of an Azure Resource group.
startTime string: Gets or sets the start time of the schedule.
advancedSchedule AdvancedSchedule: Gets or sets the AdvancedSchedule.
description string: Gets or sets the description of the schedule.
expiryTime string: Gets or sets the end time of the schedule.
interval any: Gets or sets the interval of the schedule.
scheduleName string: The schedule name.
timeZone string: Gets or sets the time zone of the schedule.

automation_account_name str: The name of the automation account.
frequency str | ScheduleFrequency: Gets or sets the frequency of the schedule.
name str: Gets or sets the name of the Schedule.
resource_group_name str: Name of an Azure Resource group.
start_time str: Gets or sets the start time of the schedule.
advanced_schedule AdvancedScheduleArgs: Gets or sets the AdvancedSchedule.
description str: Gets or sets the description of the schedule.
expiry_time str: Gets or sets the end time of the schedule.
interval Any: Gets or sets the interval of the schedule.
schedule_name str: The schedule name.
time_zone str: Gets or sets the time zone of the schedule.

automationAccountName String: The name of the automation account.
frequency String | "OneTime" | "Day" | "Hour" | "Week" | "Month" | "Minute": Gets or sets the frequency of the schedule.
name String: Gets or sets the name of the Schedule.
resourceGroupName String: Name of an Azure Resource group.
startTime String: Gets or sets the start time of the schedule.
advancedSchedule Property Map: Gets or sets the AdvancedSchedule.
description String: Gets or sets the description of the schedule.
expiryTime String: Gets or sets the end time of the schedule.
interval Any: Gets or sets the interval of the schedule.
scheduleName String: The schedule name.
timeZone String: Gets or sets the time zone of the schedule.

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.
StartTimeOffsetMinutes double: Gets the start time's offset in minutes.
Type string: The type of the resource.
CreationTime string: Gets or sets the creation time.
ExpiryTimeOffsetMinutes double: Gets or sets the expiry time's offset in minutes.
IsEnabled bool: Gets or sets a value indicating whether this schedule is enabled.
LastModifiedTime string: Gets or sets the last modified time.
NextRun string: Gets or sets the next run time of the schedule.
NextRunOffsetMinutes double: Gets or sets the next run time's offset in minutes.

Id string: The provider-assigned unique ID for this managed resource.
StartTimeOffsetMinutes float64: Gets the start time's offset in minutes.
Type string: The type of the resource.
CreationTime string: Gets or sets the creation time.
ExpiryTimeOffsetMinutes float64: Gets or sets the expiry time's offset in minutes.
IsEnabled bool: Gets or sets a value indicating whether this schedule is enabled.
LastModifiedTime string: Gets or sets the last modified time.
NextRun string: Gets or sets the next run time of the schedule.
NextRunOffsetMinutes float64: Gets or sets the next run time's offset in minutes.

id String: The provider-assigned unique ID for this managed resource.
startTimeOffsetMinutes Double: Gets the start time's offset in minutes.
type String: The type of the resource.
creationTime String: Gets or sets the creation time.
expiryTimeOffsetMinutes Double: Gets or sets the expiry time's offset in minutes.
isEnabled Boolean: Gets or sets a value indicating whether this schedule is enabled.
lastModifiedTime String: Gets or sets the last modified time.
nextRun String: Gets or sets the next run time of the schedule.
nextRunOffsetMinutes Double: Gets or sets the next run time's offset in minutes.

id string: The provider-assigned unique ID for this managed resource.
startTimeOffsetMinutes number: Gets the start time's offset in minutes.
type string: The type of the resource.
creationTime string: Gets or sets the creation time.
expiryTimeOffsetMinutes number: Gets or sets the expiry time's offset in minutes.
isEnabled boolean: Gets or sets a value indicating whether this schedule is enabled.
lastModifiedTime string: Gets or sets the last modified time.
nextRun string: Gets or sets the next run time of the schedule.
nextRunOffsetMinutes number: Gets or sets the next run time's offset in minutes.

id str: The provider-assigned unique ID for this managed resource.
start_time_offset_minutes float: Gets the start time's offset in minutes.
type str: The type of the resource.
creation_time str: Gets or sets the creation time.
expiry_time_offset_minutes float: Gets or sets the expiry time's offset in minutes.
is_enabled bool: Gets or sets a value indicating whether this schedule is enabled.
last_modified_time str: Gets or sets the last modified time.
next_run str: Gets or sets the next run time of the schedule.
next_run_offset_minutes float: Gets or sets the next run time's offset in minutes.

id String: The provider-assigned unique ID for this managed resource.
startTimeOffsetMinutes Number: Gets the start time's offset in minutes.
type String: The type of the resource.
creationTime String: Gets or sets the creation time.
expiryTimeOffsetMinutes Number: Gets or sets the expiry time's offset in minutes.
isEnabled Boolean: Gets or sets a value indicating whether this schedule is enabled.
lastModifiedTime String: Gets or sets the last modified time.
nextRun String: Gets or sets the next run time of the schedule.
nextRunOffsetMinutes Number: Gets or sets the next run time's offset in minutes.

Supporting Types

AdvancedSchedule, AdvancedScheduleArgs

MonthDays List<int>: Days of the month that the job should execute on. Must be between 1 and 31.
MonthlyOccurrences List<Pulumi.AzureNative.Automation.Inputs.AdvancedScheduleMonthlyOccurrence>: Occurrences of days within a month.
WeekDays List<string>: Days of the week that the job should execute on.

MonthDays []int: Days of the month that the job should execute on. Must be between 1 and 31.
MonthlyOccurrences []AdvancedScheduleMonthlyOccurrence: Occurrences of days within a month.
WeekDays []string: Days of the week that the job should execute on.

monthDays List<Integer>: Days of the month that the job should execute on. Must be between 1 and 31.
monthlyOccurrences List<AdvancedScheduleMonthlyOccurrence>: Occurrences of days within a month.
weekDays List<String>: Days of the week that the job should execute on.

monthDays number[]: Days of the month that the job should execute on. Must be between 1 and 31.
monthlyOccurrences AdvancedScheduleMonthlyOccurrence[]: Occurrences of days within a month.
weekDays string[]: Days of the week that the job should execute on.

month_days Sequence[int]: Days of the month that the job should execute on. Must be between 1 and 31.
monthly_occurrences Sequence[AdvancedScheduleMonthlyOccurrence]: Occurrences of days within a month.
week_days Sequence[str]: Days of the week that the job should execute on.

monthDays List<Number>: Days of the month that the job should execute on. Must be between 1 and 31.
monthlyOccurrences List<Property Map>: Occurrences of days within a month.
weekDays List<String>: Days of the week that the job should execute on.

AdvancedScheduleMonthlyOccurrence, AdvancedScheduleMonthlyOccurrenceArgs

Day string | Pulumi.AzureNative.Automation.ScheduleDay: 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

Day string | ScheduleDay: 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

day String | ScheduleDay: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
occurrence Integer: Occurrence of the week within the month. Must be between 1 and 5

day string | ScheduleDay: 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

day str | ScheduleDay: 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

day String | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday": 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

AdvancedScheduleMonthlyOccurrenceResponse, AdvancedScheduleMonthlyOccurrenceResponseArgs

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

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

day String: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
occurrence Integer: Occurrence of the week within the month. Must be between 1 and 5

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

day str: 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

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

AdvancedScheduleResponse, AdvancedScheduleResponseArgs

MonthDays List<int>: Days of the month that the job should execute on. Must be between 1 and 31.
MonthlyOccurrences List<Pulumi.AzureNative.Automation.Inputs.AdvancedScheduleMonthlyOccurrenceResponse>: Occurrences of days within a month.
WeekDays List<string>: Days of the week that the job should execute on.

MonthDays []int: Days of the month that the job should execute on. Must be between 1 and 31.
MonthlyOccurrences []AdvancedScheduleMonthlyOccurrenceResponse: Occurrences of days within a month.
WeekDays []string: Days of the week that the job should execute on.

monthDays List<Integer>: Days of the month that the job should execute on. Must be between 1 and 31.
monthlyOccurrences List<AdvancedScheduleMonthlyOccurrenceResponse>: Occurrences of days within a month.
weekDays List<String>: Days of the week that the job should execute on.

monthDays number[]: Days of the month that the job should execute on. Must be between 1 and 31.
monthlyOccurrences AdvancedScheduleMonthlyOccurrenceResponse[]: Occurrences of days within a month.
weekDays string[]: Days of the week that the job should execute on.

month_days Sequence[int]: Days of the month that the job should execute on. Must be between 1 and 31.
monthly_occurrences Sequence[AdvancedScheduleMonthlyOccurrenceResponse]: Occurrences of days within a month.
week_days Sequence[str]: Days of the week that the job should execute on.

monthDays List<Number>: Days of the month that the job should execute on. Must be between 1 and 31.
monthlyOccurrences List<Property Map>: Occurrences of days within a month.
weekDays List<String>: Days of the week that the job should execute on.

ScheduleDay, ScheduleDayArgs

Monday: Monday
Tuesday: Tuesday
Wednesday: Wednesday
Thursday: Thursday
Friday: Friday
Saturday: Saturday
Sunday: Sunday

ScheduleDayMonday: Monday
ScheduleDayTuesday: Tuesday
ScheduleDayWednesday: Wednesday
ScheduleDayThursday: Thursday
ScheduleDayFriday: Friday
ScheduleDaySaturday: Saturday
ScheduleDaySunday: Sunday

Monday: Monday
Tuesday: Tuesday
Wednesday: Wednesday
Thursday: Thursday
Friday: Friday
Saturday: Saturday
Sunday: Sunday

Monday: Monday
Tuesday: Tuesday
Wednesday: Wednesday
Thursday: Thursday
Friday: Friday
Saturday: Saturday
Sunday: Sunday

MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday

"Monday": Monday
"Tuesday": Tuesday
"Wednesday": Wednesday
"Thursday": Thursday
"Friday": Friday
"Saturday": Saturday
"Sunday": Sunday

ScheduleFrequency, ScheduleFrequencyArgs

OneTime: OneTime
Day: Day
Hour: Hour
Week: Week
Month: Month
Minute: Minute
The minimum allowed interval for Minute schedules is 15 minutes.

ScheduleFrequencyOneTime: OneTime
ScheduleFrequencyDay: Day
ScheduleFrequencyHour: Hour
ScheduleFrequencyWeek: Week
ScheduleFrequencyMonth: Month
ScheduleFrequencyMinute: Minute
The minimum allowed interval for Minute schedules is 15 minutes.

OneTime: OneTime
Day: Day
Hour: Hour
Week: Week
Month: Month
Minute: Minute
The minimum allowed interval for Minute schedules is 15 minutes.

OneTime: OneTime
Day: Day
Hour: Hour
Week: Week
Month: Month
Minute: Minute
The minimum allowed interval for Minute schedules is 15 minutes.

ONE_TIME: OneTime
DAY: Day
HOUR: Hour
WEEK: Week
MONTH: Month
MINUTE: Minute
The minimum allowed interval for Minute schedules is 15 minutes.

"OneTime": OneTime
"Day": Day
"Hour": Hour
"Week": Week
"Month": Month
"Minute": Minute
The minimum allowed interval for Minute schedules is 15 minutes.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:automation:Schedule mySchedule /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName}

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.20.1 published on Friday, Dec 1, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.automation.Schedule

On this page

On this page

Example Usage

Create or update a schedule

Create Schedule Resource

Schedule Resource Properties

Inputs

Outputs

Supporting Types

AdvancedSchedule, AdvancedScheduleArgs

AdvancedScheduleMonthlyOccurrence, AdvancedScheduleMonthlyOccurrenceArgs

AdvancedScheduleMonthlyOccurrenceResponse, AdvancedScheduleMonthlyOccurrenceResponseArgs

AdvancedScheduleResponse, AdvancedScheduleResponseArgs

ScheduleDay, ScheduleDayArgs

ScheduleFrequency, ScheduleFrequencyArgs

Import

Package Details

On this page

On this page