1. Packages
  2. Azure Classic
  3. API Docs
  4. automation
  5. Schedule

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi

azure.automation.Schedule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi

    Manages a Automation Schedule.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "tfex-automation-account",
        location: "West Europe",
    });
    const exampleAccount = new azure.automation.Account("example", {
        name: "tfex-automation-account",
        location: example.location,
        resourceGroupName: example.name,
        skuName: "Basic",
    });
    const exampleSchedule = new azure.automation.Schedule("example", {
        name: "tfex-automation-schedule",
        resourceGroupName: example.name,
        automationAccountName: exampleAccount.name,
        frequency: "Week",
        interval: 1,
        timezone: "Australia/Perth",
        startTime: "2014-04-15T18:00:15+02:00",
        description: "This is an example schedule",
        weekDays: ["Friday"],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="tfex-automation-account",
        location="West Europe")
    example_account = azure.automation.Account("example",
        name="tfex-automation-account",
        location=example.location,
        resource_group_name=example.name,
        sku_name="Basic")
    example_schedule = azure.automation.Schedule("example",
        name="tfex-automation-schedule",
        resource_group_name=example.name,
        automation_account_name=example_account.name,
        frequency="Week",
        interval=1,
        timezone="Australia/Perth",
        start_time="2014-04-15T18:00:15+02:00",
        description="This is an example schedule",
        week_days=["Friday"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/automation"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("tfex-automation-account"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := automation.NewAccount(ctx, "example", &automation.AccountArgs{
    			Name:              pulumi.String("tfex-automation-account"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			SkuName:           pulumi.String("Basic"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = automation.NewSchedule(ctx, "example", &automation.ScheduleArgs{
    			Name:                  pulumi.String("tfex-automation-schedule"),
    			ResourceGroupName:     example.Name,
    			AutomationAccountName: exampleAccount.Name,
    			Frequency:             pulumi.String("Week"),
    			Interval:              pulumi.Int(1),
    			Timezone:              pulumi.String("Australia/Perth"),
    			StartTime:             pulumi.String("2014-04-15T18:00:15+02:00"),
    			Description:           pulumi.String("This is an example schedule"),
    			WeekDays: pulumi.StringArray{
    				pulumi.String("Friday"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "tfex-automation-account",
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Automation.Account("example", new()
        {
            Name = "tfex-automation-account",
            Location = example.Location,
            ResourceGroupName = example.Name,
            SkuName = "Basic",
        });
    
        var exampleSchedule = new Azure.Automation.Schedule("example", new()
        {
            Name = "tfex-automation-schedule",
            ResourceGroupName = example.Name,
            AutomationAccountName = exampleAccount.Name,
            Frequency = "Week",
            Interval = 1,
            Timezone = "Australia/Perth",
            StartTime = "2014-04-15T18:00:15+02:00",
            Description = "This is an example schedule",
            WeekDays = new[]
            {
                "Friday",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.automation.Account;
    import com.pulumi.azure.automation.AccountArgs;
    import com.pulumi.azure.automation.Schedule;
    import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("tfex-automation-account")
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
                .name("tfex-automation-account")
                .location(example.location())
                .resourceGroupName(example.name())
                .skuName("Basic")
                .build());
    
            var exampleSchedule = new Schedule("exampleSchedule", ScheduleArgs.builder()        
                .name("tfex-automation-schedule")
                .resourceGroupName(example.name())
                .automationAccountName(exampleAccount.name())
                .frequency("Week")
                .interval(1)
                .timezone("Australia/Perth")
                .startTime("2014-04-15T18:00:15+02:00")
                .description("This is an example schedule")
                .weekDays("Friday")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: tfex-automation-account
          location: West Europe
      exampleAccount:
        type: azure:automation:Account
        name: example
        properties:
          name: tfex-automation-account
          location: ${example.location}
          resourceGroupName: ${example.name}
          skuName: Basic
      exampleSchedule:
        type: azure:automation:Schedule
        name: example
        properties:
          name: tfex-automation-schedule
          resourceGroupName: ${example.name}
          automationAccountName: ${exampleAccount.name}
          frequency: Week
          interval: 1
          timezone: Australia/Perth
          startTime: 2014-04-15T18:00:15+02:00
          description: This is an example schedule
          weekDays:
            - Friday
    

    Create Schedule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);
    @overload
    def Schedule(resource_name: str,
                 args: ScheduleArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Schedule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 automation_account_name: Optional[str] = None,
                 frequency: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 description: Optional[str] = None,
                 expiry_time: Optional[str] = None,
                 interval: Optional[int] = None,
                 month_days: Optional[Sequence[int]] = None,
                 monthly_occurrences: Optional[Sequence[ScheduleMonthlyOccurrenceArgs]] = None,
                 name: Optional[str] = None,
                 start_time: Optional[str] = None,
                 timezone: Optional[str] = None,
                 week_days: Optional[Sequence[str]] = 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:automation:Schedule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var scheduleResource = new Azure.Automation.Schedule("scheduleResource", new()
    {
        AutomationAccountName = "string",
        Frequency = "string",
        ResourceGroupName = "string",
        Description = "string",
        ExpiryTime = "string",
        Interval = 0,
        MonthDays = new[]
        {
            0,
        },
        MonthlyOccurrences = new[]
        {
            new Azure.Automation.Inputs.ScheduleMonthlyOccurrenceArgs
            {
                Day = "string",
                Occurrence = 0,
            },
        },
        Name = "string",
        StartTime = "string",
        Timezone = "string",
        WeekDays = new[]
        {
            "string",
        },
    });
    
    example, err := automation.NewSchedule(ctx, "scheduleResource", &automation.ScheduleArgs{
    	AutomationAccountName: pulumi.String("string"),
    	Frequency:             pulumi.String("string"),
    	ResourceGroupName:     pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	ExpiryTime:            pulumi.String("string"),
    	Interval:              pulumi.Int(0),
    	MonthDays: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    	MonthlyOccurrences: automation.ScheduleMonthlyOccurrenceArray{
    		&automation.ScheduleMonthlyOccurrenceArgs{
    			Day:        pulumi.String("string"),
    			Occurrence: pulumi.Int(0),
    		},
    	},
    	Name:      pulumi.String("string"),
    	StartTime: pulumi.String("string"),
    	Timezone:  pulumi.String("string"),
    	WeekDays: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var scheduleResource = new Schedule("scheduleResource", ScheduleArgs.builder()        
        .automationAccountName("string")
        .frequency("string")
        .resourceGroupName("string")
        .description("string")
        .expiryTime("string")
        .interval(0)
        .monthDays(0)
        .monthlyOccurrences(ScheduleMonthlyOccurrenceArgs.builder()
            .day("string")
            .occurrence(0)
            .build())
        .name("string")
        .startTime("string")
        .timezone("string")
        .weekDays("string")
        .build());
    
    schedule_resource = azure.automation.Schedule("scheduleResource",
        automation_account_name="string",
        frequency="string",
        resource_group_name="string",
        description="string",
        expiry_time="string",
        interval=0,
        month_days=[0],
        monthly_occurrences=[azure.automation.ScheduleMonthlyOccurrenceArgs(
            day="string",
            occurrence=0,
        )],
        name="string",
        start_time="string",
        timezone="string",
        week_days=["string"])
    
    const scheduleResource = new azure.automation.Schedule("scheduleResource", {
        automationAccountName: "string",
        frequency: "string",
        resourceGroupName: "string",
        description: "string",
        expiryTime: "string",
        interval: 0,
        monthDays: [0],
        monthlyOccurrences: [{
            day: "string",
            occurrence: 0,
        }],
        name: "string",
        startTime: "string",
        timezone: "string",
        weekDays: ["string"],
    });
    
    type: azure:automation:Schedule
    properties:
        automationAccountName: string
        description: string
        expiryTime: string
        frequency: string
        interval: 0
        monthDays:
            - 0
        monthlyOccurrences:
            - day: string
              occurrence: 0
        name: string
        resourceGroupName: string
        startTime: string
        timezone: string
        weekDays:
            - string
    

    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 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<ScheduleMonthlyOccurrence>
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    WeekDays List<string>
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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 []ScheduleMonthlyOccurrenceArgs
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    WeekDays []string
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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 Integer
    The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
    monthDays 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.
    monthlyOccurrences List<ScheduleMonthlyOccurrence>
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    weekDays List<String>
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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[]
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    weekDays string[]
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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 int
    The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
    month_days Sequence[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.
    monthly_occurrences Sequence[ScheduleMonthlyOccurrenceArgs]
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    week_days Sequence[str]
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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 List<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 List<Property Map>
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    weekDays List<String>
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            automation_account_name: Optional[str] = None,
            description: Optional[str] = None,
            expiry_time: Optional[str] = None,
            frequency: Optional[str] = None,
            interval: Optional[int] = None,
            month_days: Optional[Sequence[int]] = None,
            monthly_occurrences: Optional[Sequence[ScheduleMonthlyOccurrenceArgs]] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            start_time: Optional[str] = None,
            timezone: Optional[str] = None,
            week_days: Optional[Sequence[str]] = None) -> Schedule
    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)
    public static Schedule get(String name, Output<String> id, ScheduleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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<ScheduleMonthlyOccurrence>
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    WeekDays List<string>
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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 []ScheduleMonthlyOccurrenceArgs
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    WeekDays []string
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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 Integer
    The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
    monthDays 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.
    monthlyOccurrences List<ScheduleMonthlyOccurrence>
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    weekDays List<String>
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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[]
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    weekDays string[]
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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 int
    The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.
    month_days Sequence[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.
    monthly_occurrences Sequence[ScheduleMonthlyOccurrenceArgs]
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    week_days Sequence[str]
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
    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 List<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 List<Property Map>
    One monthly_occurrence blocks as defined below to specifies 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 Etc/UTC. For possible values see: https://docs.microsoft.com/en-us/rest/api/maps/timezone/gettimezoneenumwindows
    weekDays List<String>
    List of days of the week that the job should execute on. Only valid when frequency is Week. Possible values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

    Supporting Types

    ScheduleMonthlyOccurrence, ScheduleMonthlyOccurrenceArgs

    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 Integer
    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 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.

    Import

    Automation Schedule can be imported using the resource id, e.g.

    $ pulumi import azure:automation/schedule:Schedule schedule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/schedules/schedule1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi