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

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

azure.lab.Schedule

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

    Manages a Lab Service Schedule.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleLab = new Azure.Lab.Lab("exampleLab", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Title = "Test Title",
            Security = new Azure.Lab.Inputs.LabSecurityArgs
            {
                OpenAccessEnabled = false,
            },
            VirtualMachine = new Azure.Lab.Inputs.LabVirtualMachineArgs
            {
                AdminUser = new Azure.Lab.Inputs.LabVirtualMachineAdminUserArgs
                {
                    Username = "testadmin",
                    Password = "Password1234!",
                },
                ImageReference = new Azure.Lab.Inputs.LabVirtualMachineImageReferenceArgs
                {
                    Offer = "0001-com-ubuntu-server-focal",
                    Publisher = "canonical",
                    Sku = "20_04-lts",
                    Version = "latest",
                },
                Sku = new Azure.Lab.Inputs.LabVirtualMachineSkuArgs
                {
                    Name = "Classic_Fsv2_2_4GB_128_S_SSD",
                    Capacity = 1,
                },
            },
        });
    
        var exampleSchedule = new Azure.Lab.Schedule("exampleSchedule", new()
        {
            LabId = exampleLab.Id,
            StopTime = "2022-11-28T00:00:00Z",
            TimeZone = "America/Los_Angeles",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/lab"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleLab, err := lab.NewLab(ctx, "exampleLab", &lab.LabArgs{
    			ResourceGroupName: exampleResourceGroup.Name,
    			Location:          exampleResourceGroup.Location,
    			Title:             pulumi.String("Test Title"),
    			Security: &lab.LabSecurityArgs{
    				OpenAccessEnabled: pulumi.Bool(false),
    			},
    			VirtualMachine: &lab.LabVirtualMachineArgs{
    				AdminUser: &lab.LabVirtualMachineAdminUserArgs{
    					Username: pulumi.String("testadmin"),
    					Password: pulumi.String("Password1234!"),
    				},
    				ImageReference: &lab.LabVirtualMachineImageReferenceArgs{
    					Offer:     pulumi.String("0001-com-ubuntu-server-focal"),
    					Publisher: pulumi.String("canonical"),
    					Sku:       pulumi.String("20_04-lts"),
    					Version:   pulumi.String("latest"),
    				},
    				Sku: &lab.LabVirtualMachineSkuArgs{
    					Name:     pulumi.String("Classic_Fsv2_2_4GB_128_S_SSD"),
    					Capacity: pulumi.Int(1),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = lab.NewSchedule(ctx, "exampleSchedule", &lab.ScheduleArgs{
    			LabId:    exampleLab.ID(),
    			StopTime: pulumi.String("2022-11-28T00:00:00Z"),
    			TimeZone: pulumi.String("America/Los_Angeles"),
    		})
    		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.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.lab.Lab;
    import com.pulumi.azure.lab.LabArgs;
    import com.pulumi.azure.lab.inputs.LabSecurityArgs;
    import com.pulumi.azure.lab.inputs.LabVirtualMachineArgs;
    import com.pulumi.azure.lab.inputs.LabVirtualMachineAdminUserArgs;
    import com.pulumi.azure.lab.inputs.LabVirtualMachineImageReferenceArgs;
    import com.pulumi.azure.lab.inputs.LabVirtualMachineSkuArgs;
    import com.pulumi.azure.lab.Schedule;
    import com.pulumi.azure.lab.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleLab = new Lab("exampleLab", LabArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.location())
                .title("Test Title")
                .security(LabSecurityArgs.builder()
                    .openAccessEnabled(false)
                    .build())
                .virtualMachine(LabVirtualMachineArgs.builder()
                    .adminUser(LabVirtualMachineAdminUserArgs.builder()
                        .username("testadmin")
                        .password("Password1234!")
                        .build())
                    .imageReference(LabVirtualMachineImageReferenceArgs.builder()
                        .offer("0001-com-ubuntu-server-focal")
                        .publisher("canonical")
                        .sku("20_04-lts")
                        .version("latest")
                        .build())
                    .sku(LabVirtualMachineSkuArgs.builder()
                        .name("Classic_Fsv2_2_4GB_128_S_SSD")
                        .capacity(1)
                        .build())
                    .build())
                .build());
    
            var exampleSchedule = new Schedule("exampleSchedule", ScheduleArgs.builder()        
                .labId(exampleLab.id())
                .stopTime("2022-11-28T00:00:00Z")
                .timeZone("America/Los_Angeles")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_lab = azure.lab.Lab("exampleLab",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        title="Test Title",
        security=azure.lab.LabSecurityArgs(
            open_access_enabled=False,
        ),
        virtual_machine=azure.lab.LabVirtualMachineArgs(
            admin_user=azure.lab.LabVirtualMachineAdminUserArgs(
                username="testadmin",
                password="Password1234!",
            ),
            image_reference=azure.lab.LabVirtualMachineImageReferenceArgs(
                offer="0001-com-ubuntu-server-focal",
                publisher="canonical",
                sku="20_04-lts",
                version="latest",
            ),
            sku=azure.lab.LabVirtualMachineSkuArgs(
                name="Classic_Fsv2_2_4GB_128_S_SSD",
                capacity=1,
            ),
        ))
    example_schedule = azure.lab.Schedule("exampleSchedule",
        lab_id=example_lab.id,
        stop_time="2022-11-28T00:00:00Z",
        time_zone="America/Los_Angeles")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleLab = new azure.lab.Lab("exampleLab", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        title: "Test Title",
        security: {
            openAccessEnabled: false,
        },
        virtualMachine: {
            adminUser: {
                username: "testadmin",
                password: "Password1234!",
            },
            imageReference: {
                offer: "0001-com-ubuntu-server-focal",
                publisher: "canonical",
                sku: "20_04-lts",
                version: "latest",
            },
            sku: {
                name: "Classic_Fsv2_2_4GB_128_S_SSD",
                capacity: 1,
            },
        },
    });
    const exampleSchedule = new azure.lab.Schedule("exampleSchedule", {
        labId: exampleLab.id,
        stopTime: "2022-11-28T00:00:00Z",
        timeZone: "America/Los_Angeles",
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleLab:
        type: azure:lab:Lab
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.location}
          title: Test Title
          security:
            openAccessEnabled: false
          virtualMachine:
            adminUser:
              username: testadmin
              password: Password1234!
            imageReference:
              offer: 0001-com-ubuntu-server-focal
              publisher: canonical
              sku: 20_04-lts
              version: latest
            sku:
              name: Classic_Fsv2_2_4GB_128_S_SSD
              capacity: 1
      exampleSchedule:
        type: azure:lab:Schedule
        properties:
          labId: ${exampleLab.id}
          stopTime: 2022-11-28T00:00:00Z
          timeZone: America/Los_Angeles
    

    Create Schedule Resource

    new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);
    @overload
    def Schedule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 lab_id: Optional[str] = None,
                 name: Optional[str] = None,
                 notes: Optional[str] = None,
                 recurrence: Optional[ScheduleRecurrenceArgs] = None,
                 start_time: Optional[str] = None,
                 stop_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:lab: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:

    LabId string

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    StopTime string

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    TimeZone string

    The IANA Time Zone ID for the Schedule.

    Name string

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    Notes string

    The notes for the Schedule.

    Recurrence ScheduleRecurrence

    A recurrence block as defined below.

    StartTime string

    When Lab User Virtual Machines will be started in RFC-3339 format.

    LabId string

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    StopTime string

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    TimeZone string

    The IANA Time Zone ID for the Schedule.

    Name string

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    Notes string

    The notes for the Schedule.

    Recurrence ScheduleRecurrenceArgs

    A recurrence block as defined below.

    StartTime string

    When Lab User Virtual Machines will be started in RFC-3339 format.

    labId String

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    stopTime String

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    timeZone String

    The IANA Time Zone ID for the Schedule.

    name String

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    notes String

    The notes for the Schedule.

    recurrence ScheduleRecurrence

    A recurrence block as defined below.

    startTime String

    When Lab User Virtual Machines will be started in RFC-3339 format.

    labId string

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    stopTime string

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    timeZone string

    The IANA Time Zone ID for the Schedule.

    name string

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    notes string

    The notes for the Schedule.

    recurrence ScheduleRecurrence

    A recurrence block as defined below.

    startTime string

    When Lab User Virtual Machines will be started in RFC-3339 format.

    lab_id str

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    stop_time str

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    time_zone str

    The IANA Time Zone ID for the Schedule.

    name str

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    notes str

    The notes for the Schedule.

    recurrence ScheduleRecurrenceArgs

    A recurrence block as defined below.

    start_time str

    When Lab User Virtual Machines will be started in RFC-3339 format.

    labId String

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    stopTime String

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    timeZone String

    The IANA Time Zone ID for the Schedule.

    name String

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    notes String

    The notes for the Schedule.

    recurrence Property Map

    A recurrence block as defined below.

    startTime String

    When Lab User Virtual Machines will be started in RFC-3339 format.

    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,
            lab_id: Optional[str] = None,
            name: Optional[str] = None,
            notes: Optional[str] = None,
            recurrence: Optional[ScheduleRecurrenceArgs] = None,
            start_time: Optional[str] = None,
            stop_time: Optional[str] = None,
            time_zone: Optional[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:
    LabId string

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    Name string

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    Notes string

    The notes for the Schedule.

    Recurrence ScheduleRecurrence

    A recurrence block as defined below.

    StartTime string

    When Lab User Virtual Machines will be started in RFC-3339 format.

    StopTime string

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    TimeZone string

    The IANA Time Zone ID for the Schedule.

    LabId string

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    Name string

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    Notes string

    The notes for the Schedule.

    Recurrence ScheduleRecurrenceArgs

    A recurrence block as defined below.

    StartTime string

    When Lab User Virtual Machines will be started in RFC-3339 format.

    StopTime string

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    TimeZone string

    The IANA Time Zone ID for the Schedule.

    labId String

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    name String

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    notes String

    The notes for the Schedule.

    recurrence ScheduleRecurrence

    A recurrence block as defined below.

    startTime String

    When Lab User Virtual Machines will be started in RFC-3339 format.

    stopTime String

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    timeZone String

    The IANA Time Zone ID for the Schedule.

    labId string

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    name string

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    notes string

    The notes for the Schedule.

    recurrence ScheduleRecurrence

    A recurrence block as defined below.

    startTime string

    When Lab User Virtual Machines will be started in RFC-3339 format.

    stopTime string

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    timeZone string

    The IANA Time Zone ID for the Schedule.

    lab_id str

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    name str

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    notes str

    The notes for the Schedule.

    recurrence ScheduleRecurrenceArgs

    A recurrence block as defined below.

    start_time str

    When Lab User Virtual Machines will be started in RFC-3339 format.

    stop_time str

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    time_zone str

    The IANA Time Zone ID for the Schedule.

    labId String

    The resource ID of the Lab Service Schedule. Changing this forces a new resource to be created.

    name String

    The name which should be used for this Lab Service Schedule. Changing this forces a new resource to be created.

    notes String

    The notes for the Schedule.

    recurrence Property Map

    A recurrence block as defined below.

    startTime String

    When Lab User Virtual Machines will be started in RFC-3339 format.

    stopTime String

    When Lab User Virtual Machines will be stopped in RFC-3339 format.

    timeZone String

    The IANA Time Zone ID for the Schedule.

    Supporting Types

    ScheduleRecurrence, ScheduleRecurrenceArgs

    ExpirationDate string

    When the recurrence will expire in RFC-3339 format.

    Frequency string

    The frequency of the recurrence. Possible values are Daily and Weekly.

    Interval int

    The interval to invoke the schedule on. Possible values are between 1 and 365.

    WeekDays List<string>

    The interval to invoke the schedule on. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    ExpirationDate string

    When the recurrence will expire in RFC-3339 format.

    Frequency string

    The frequency of the recurrence. Possible values are Daily and Weekly.

    Interval int

    The interval to invoke the schedule on. Possible values are between 1 and 365.

    WeekDays []string

    The interval to invoke the schedule on. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    expirationDate String

    When the recurrence will expire in RFC-3339 format.

    frequency String

    The frequency of the recurrence. Possible values are Daily and Weekly.

    interval Integer

    The interval to invoke the schedule on. Possible values are between 1 and 365.

    weekDays List<String>

    The interval to invoke the schedule on. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    expirationDate string

    When the recurrence will expire in RFC-3339 format.

    frequency string

    The frequency of the recurrence. Possible values are Daily and Weekly.

    interval number

    The interval to invoke the schedule on. Possible values are between 1 and 365.

    weekDays string[]

    The interval to invoke the schedule on. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    expiration_date str

    When the recurrence will expire in RFC-3339 format.

    frequency str

    The frequency of the recurrence. Possible values are Daily and Weekly.

    interval int

    The interval to invoke the schedule on. Possible values are between 1 and 365.

    week_days Sequence[str]

    The interval to invoke the schedule on. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    expirationDate String

    When the recurrence will expire in RFC-3339 format.

    frequency String

    The frequency of the recurrence. Possible values are Daily and Weekly.

    interval Number

    The interval to invoke the schedule on. Possible values are between 1 and 365.

    weekDays List<String>

    The interval to invoke the schedule on. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

    Import

    Lab Service Schedules can be imported using the resource id, e.g.

     $ pulumi import azure:lab/schedule:Schedule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.LabServices/labs/lab1/schedules/schedule1
    

    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.49.0 published on Tuesday, Aug 29, 2023 by Pulumi