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

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.devtest.Schedule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleLab = new azure.devtest.Lab("example", {
        name: "YourDevTestLab",
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleSchedule = new azure.devtest.Schedule("example", {
        name: "LabVmAutoStart",
        location: example.location,
        resourceGroupName: example.name,
        labName: exampleLab.name,
        status: "Enabled",
        weeklyRecurrence: {
            time: "1100",
            weekDays: [
                "Monday",
                "Tuesday",
            ],
        },
        timeZoneId: "Pacific Standard Time",
        taskType: "LabVmsStartupTask",
        notificationSettings: {},
        tags: {
            environment: "Production",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_lab = azure.devtest.Lab("example",
        name="YourDevTestLab",
        location=example.location,
        resource_group_name=example.name)
    example_schedule = azure.devtest.Schedule("example",
        name="LabVmAutoStart",
        location=example.location,
        resource_group_name=example.name,
        lab_name=example_lab.name,
        status="Enabled",
        weekly_recurrence=azure.devtest.ScheduleWeeklyRecurrenceArgs(
            time="1100",
            week_days=[
                "Monday",
                "Tuesday",
            ],
        ),
        time_zone_id="Pacific Standard Time",
        task_type="LabVmsStartupTask",
        notification_settings=azure.devtest.ScheduleNotificationSettingsArgs(),
        tags={
            "environment": "Production",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/devtest"
    	"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("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleLab, err := devtest.NewLab(ctx, "example", &devtest.LabArgs{
    			Name:              pulumi.String("YourDevTestLab"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = devtest.NewSchedule(ctx, "example", &devtest.ScheduleArgs{
    			Name:              pulumi.String("LabVmAutoStart"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			LabName:           exampleLab.Name,
    			Status:            pulumi.String("Enabled"),
    			WeeklyRecurrence: &devtest.ScheduleWeeklyRecurrenceArgs{
    				Time: pulumi.String("1100"),
    				WeekDays: pulumi.StringArray{
    					pulumi.String("Monday"),
    					pulumi.String("Tuesday"),
    				},
    			},
    			TimeZoneId:           pulumi.String("Pacific Standard Time"),
    			TaskType:             pulumi.String("LabVmsStartupTask"),
    			NotificationSettings: nil,
    			Tags: pulumi.StringMap{
    				"environment": pulumi.String("Production"),
    			},
    		})
    		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 = "example-resources",
            Location = "West Europe",
        });
    
        var exampleLab = new Azure.DevTest.Lab("example", new()
        {
            Name = "YourDevTestLab",
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleSchedule = new Azure.DevTest.Schedule("example", new()
        {
            Name = "LabVmAutoStart",
            Location = example.Location,
            ResourceGroupName = example.Name,
            LabName = exampleLab.Name,
            Status = "Enabled",
            WeeklyRecurrence = new Azure.DevTest.Inputs.ScheduleWeeklyRecurrenceArgs
            {
                Time = "1100",
                WeekDays = new[]
                {
                    "Monday",
                    "Tuesday",
                },
            },
            TimeZoneId = "Pacific Standard Time",
            TaskType = "LabVmsStartupTask",
            NotificationSettings = null,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    
    });
    
    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.devtest.Lab;
    import com.pulumi.azure.devtest.LabArgs;
    import com.pulumi.azure.devtest.Schedule;
    import com.pulumi.azure.devtest.ScheduleArgs;
    import com.pulumi.azure.devtest.inputs.ScheduleWeeklyRecurrenceArgs;
    import com.pulumi.azure.devtest.inputs.ScheduleNotificationSettingsArgs;
    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("example-resources")
                .location("West Europe")
                .build());
    
            var exampleLab = new Lab("exampleLab", LabArgs.builder()
                .name("YourDevTestLab")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleSchedule = new Schedule("exampleSchedule", ScheduleArgs.builder()
                .name("LabVmAutoStart")
                .location(example.location())
                .resourceGroupName(example.name())
                .labName(exampleLab.name())
                .status("Enabled")
                .weeklyRecurrence(ScheduleWeeklyRecurrenceArgs.builder()
                    .time("1100")
                    .weekDays(                
                        "Monday",
                        "Tuesday")
                    .build())
                .timeZoneId("Pacific Standard Time")
                .taskType("LabVmsStartupTask")
                .notificationSettings()
                .tags(Map.of("environment", "Production"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleLab:
        type: azure:devtest:Lab
        name: example
        properties:
          name: YourDevTestLab
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleSchedule:
        type: azure:devtest:Schedule
        name: example
        properties:
          name: LabVmAutoStart
          location: ${example.location}
          resourceGroupName: ${example.name}
          labName: ${exampleLab.name}
          status: Enabled
          weeklyRecurrence:
            time: '1100'
            weekDays:
              - Monday
              - Tuesday
          timeZoneId: Pacific Standard Time
          taskType: LabVmsStartupTask
          notificationSettings: {}
          tags:
            environment: Production
    

    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,
                 lab_name: Optional[str] = None,
                 notification_settings: Optional[ScheduleNotificationSettingsArgs] = None,
                 resource_group_name: Optional[str] = None,
                 task_type: Optional[str] = None,
                 time_zone_id: Optional[str] = None,
                 daily_recurrence: Optional[ScheduleDailyRecurrenceArgs] = None,
                 hourly_recurrence: Optional[ScheduleHourlyRecurrenceArgs] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 status: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 weekly_recurrence: Optional[ScheduleWeeklyRecurrenceArgs] = 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:devtest: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 azureScheduleResource = new Azure.DevTest.Schedule("azureScheduleResource", new()
    {
        LabName = "string",
        NotificationSettings = new Azure.DevTest.Inputs.ScheduleNotificationSettingsArgs
        {
            Status = "string",
            TimeInMinutes = 0,
            WebhookUrl = "string",
        },
        ResourceGroupName = "string",
        TaskType = "string",
        TimeZoneId = "string",
        DailyRecurrence = new Azure.DevTest.Inputs.ScheduleDailyRecurrenceArgs
        {
            Time = "string",
        },
        HourlyRecurrence = new Azure.DevTest.Inputs.ScheduleHourlyRecurrenceArgs
        {
            Minute = 0,
        },
        Location = "string",
        Name = "string",
        Status = "string",
        Tags = 
        {
            { "string", "string" },
        },
        WeeklyRecurrence = new Azure.DevTest.Inputs.ScheduleWeeklyRecurrenceArgs
        {
            Time = "string",
            WeekDays = new[]
            {
                "string",
            },
        },
    });
    
    example, err := devtest.NewSchedule(ctx, "azureScheduleResource", &devtest.ScheduleArgs{
    	LabName: pulumi.String("string"),
    	NotificationSettings: &devtest.ScheduleNotificationSettingsArgs{
    		Status:        pulumi.String("string"),
    		TimeInMinutes: pulumi.Int(0),
    		WebhookUrl:    pulumi.String("string"),
    	},
    	ResourceGroupName: pulumi.String("string"),
    	TaskType:          pulumi.String("string"),
    	TimeZoneId:        pulumi.String("string"),
    	DailyRecurrence: &devtest.ScheduleDailyRecurrenceArgs{
    		Time: pulumi.String("string"),
    	},
    	HourlyRecurrence: &devtest.ScheduleHourlyRecurrenceArgs{
    		Minute: pulumi.Int(0),
    	},
    	Location: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	Status:   pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	WeeklyRecurrence: &devtest.ScheduleWeeklyRecurrenceArgs{
    		Time: pulumi.String("string"),
    		WeekDays: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    })
    
    var azureScheduleResource = new Schedule("azureScheduleResource", ScheduleArgs.builder()
        .labName("string")
        .notificationSettings(ScheduleNotificationSettingsArgs.builder()
            .status("string")
            .timeInMinutes(0)
            .webhookUrl("string")
            .build())
        .resourceGroupName("string")
        .taskType("string")
        .timeZoneId("string")
        .dailyRecurrence(ScheduleDailyRecurrenceArgs.builder()
            .time("string")
            .build())
        .hourlyRecurrence(ScheduleHourlyRecurrenceArgs.builder()
            .minute(0)
            .build())
        .location("string")
        .name("string")
        .status("string")
        .tags(Map.of("string", "string"))
        .weeklyRecurrence(ScheduleWeeklyRecurrenceArgs.builder()
            .time("string")
            .weekDays("string")
            .build())
        .build());
    
    azure_schedule_resource = azure.devtest.Schedule("azureScheduleResource",
        lab_name="string",
        notification_settings=azure.devtest.ScheduleNotificationSettingsArgs(
            status="string",
            time_in_minutes=0,
            webhook_url="string",
        ),
        resource_group_name="string",
        task_type="string",
        time_zone_id="string",
        daily_recurrence=azure.devtest.ScheduleDailyRecurrenceArgs(
            time="string",
        ),
        hourly_recurrence=azure.devtest.ScheduleHourlyRecurrenceArgs(
            minute=0,
        ),
        location="string",
        name="string",
        status="string",
        tags={
            "string": "string",
        },
        weekly_recurrence=azure.devtest.ScheduleWeeklyRecurrenceArgs(
            time="string",
            week_days=["string"],
        ))
    
    const azureScheduleResource = new azure.devtest.Schedule("azureScheduleResource", {
        labName: "string",
        notificationSettings: {
            status: "string",
            timeInMinutes: 0,
            webhookUrl: "string",
        },
        resourceGroupName: "string",
        taskType: "string",
        timeZoneId: "string",
        dailyRecurrence: {
            time: "string",
        },
        hourlyRecurrence: {
            minute: 0,
        },
        location: "string",
        name: "string",
        status: "string",
        tags: {
            string: "string",
        },
        weeklyRecurrence: {
            time: "string",
            weekDays: ["string"],
        },
    });
    
    type: azure:devtest:Schedule
    properties:
        dailyRecurrence:
            time: string
        hourlyRecurrence:
            minute: 0
        labName: string
        location: string
        name: string
        notificationSettings:
            status: string
            timeInMinutes: 0
            webhookUrl: string
        resourceGroupName: string
        status: string
        tags:
            string: string
        taskType: string
        timeZoneId: string
        weeklyRecurrence:
            time: 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:

    LabName string
    The name of the dev test lab. Changing this forces a new resource to be created.
    NotificationSettings ScheduleNotificationSettings
    The notification setting of a schedule. A notification_settings block as defined below.
    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
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    HourlyRecurrence ScheduleHourlyRecurrence
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. 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.
    WeeklyRecurrence ScheduleWeeklyRecurrence
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    LabName string
    The name of the dev test lab. Changing this forces a new resource to be created.
    NotificationSettings ScheduleNotificationSettingsArgs
    The notification setting of a schedule. A notification_settings block as defined below.
    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
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    HourlyRecurrence ScheduleHourlyRecurrenceArgs
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. 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.
    WeeklyRecurrence ScheduleWeeklyRecurrenceArgs
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    labName String
    The name of the dev test lab. Changing this forces a new resource to be created.
    notificationSettings ScheduleNotificationSettings
    The notification setting of a schedule. A notification_settings block as defined below.
    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
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    hourlyRecurrence ScheduleHourlyRecurrence
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. 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.
    weeklyRecurrence ScheduleWeeklyRecurrence
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    labName string
    The name of the dev test lab. Changing this forces a new resource to be created.
    notificationSettings ScheduleNotificationSettings
    The notification setting of a schedule. A notification_settings block as defined below.
    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
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    hourlyRecurrence ScheduleHourlyRecurrence
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. 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.
    weeklyRecurrence ScheduleWeeklyRecurrence
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    lab_name str
    The name of the dev test lab. Changing this forces a new resource to be created.
    notification_settings ScheduleNotificationSettingsArgs
    The notification setting of a schedule. A notification_settings block as defined below.
    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 ScheduleDailyRecurrenceArgs
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    hourly_recurrence ScheduleHourlyRecurrenceArgs
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. 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 Mapping[str, str]
    A mapping of tags to assign to the resource.
    weekly_recurrence ScheduleWeeklyRecurrenceArgs
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    labName String
    The name of the dev test lab. Changing this forces a new resource to be created.
    notificationSettings Property Map
    The notification setting of a schedule. A notification_settings block as defined below.
    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 Property Map
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    hourlyRecurrence Property Map
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. 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>
    A mapping of tags to assign to the resource.
    weeklyRecurrence Property Map
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.

    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,
            daily_recurrence: Optional[ScheduleDailyRecurrenceArgs] = None,
            hourly_recurrence: Optional[ScheduleHourlyRecurrenceArgs] = None,
            lab_name: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            notification_settings: Optional[ScheduleNotificationSettingsArgs] = None,
            resource_group_name: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            task_type: Optional[str] = None,
            time_zone_id: Optional[str] = None,
            weekly_recurrence: Optional[ScheduleWeeklyRecurrenceArgs] = 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:
    DailyRecurrence ScheduleDailyRecurrence
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    HourlyRecurrence ScheduleHourlyRecurrence
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. Changing this forces a new resource to be created.
    NotificationSettings ScheduleNotificationSettings
    The notification setting of a schedule. A notification_settings block as defined below.
    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 ScheduleWeeklyRecurrence
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    DailyRecurrence ScheduleDailyRecurrenceArgs
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    HourlyRecurrence ScheduleHourlyRecurrenceArgs
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. Changing this forces a new resource to be created.
    NotificationSettings ScheduleNotificationSettingsArgs
    The notification setting of a schedule. A notification_settings block as defined below.
    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 ScheduleWeeklyRecurrenceArgs
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    dailyRecurrence ScheduleDailyRecurrence
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    hourlyRecurrence ScheduleHourlyRecurrence
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. Changing this forces a new resource to be created.
    notificationSettings ScheduleNotificationSettings
    The notification setting of a schedule. A notification_settings block as defined below.
    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
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    dailyRecurrence ScheduleDailyRecurrence
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    hourlyRecurrence ScheduleHourlyRecurrence
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. Changing this forces a new resource to be created.
    notificationSettings ScheduleNotificationSettings
    The notification setting of a schedule. A notification_settings block as defined below.
    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
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    daily_recurrence ScheduleDailyRecurrenceArgs
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    hourly_recurrence ScheduleHourlyRecurrenceArgs
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. Changing this forces a new resource to be created.
    notification_settings ScheduleNotificationSettingsArgs
    The notification setting of a schedule. A notification_settings block as defined below.
    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 Mapping[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 ScheduleWeeklyRecurrenceArgs
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.
    dailyRecurrence Property Map
    The properties of a daily schedule. If the schedule occurs once each day of the week, specify the daily recurrence. A daily_recurrence block as defined below.
    hourlyRecurrence Property Map
    The properties of an hourly schedule. If the schedule occurs multiple times a day, specify the hourly recurrence. A hourly_recurrence block as defined below.
    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. Changing this forces a new resource to be created.
    notificationSettings Property Map
    The notification setting of a schedule. A notification_settings block as defined below.
    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>
    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 Property Map
    The properties of a weekly schedule. If the schedule occurs only some days of the week, specify the weekly recurrence. A weekly_recurrence block as defined below.

    Supporting Types

    ScheduleDailyRecurrence, ScheduleDailyRecurrenceArgs

    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 string
    The time each day when the schedule takes effect.
    time str
    The time each day when the schedule takes effect.
    time String
    The time each day when the schedule takes effect.

    ScheduleHourlyRecurrence, ScheduleHourlyRecurrenceArgs

    Minute int
    Minutes of the hour the schedule will run.
    Minute int
    Minutes of the hour the schedule will run.
    minute Integer
    Minutes of the hour the schedule will run.
    minute number
    Minutes of the hour the schedule will run.
    minute int
    Minutes of the hour the schedule will run.
    minute Number
    Minutes of the hour the schedule will run.

    ScheduleNotificationSettings, ScheduleNotificationSettingsArgs

    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 Integer
    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
    time_in_minutes int
    Time in minutes before event at which notification will be sent.
    webhook_url str
    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.

    ScheduleWeeklyRecurrence, ScheduleWeeklyRecurrenceArgs

    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 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 str
    The time when the schedule takes effect.
    week_days Sequence[str]
    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 List<String>
    A list of days that this schedule takes effect . Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

    Import

    DevTest Schedule’s can be imported using the resource id, e.g.

    $ pulumi import azure:devtest/schedule:Schedule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.DevTestLab/labs/myDevTestLab/schedules/labvmautostart
    

    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.80.0 published on Monday, Jun 10, 2024 by Pulumi