Tutorial: Create and publish a lab

Note

This article references features available since the August 2022 Update, in which lab plans replaced lab accounts. For more information, see What's New in the August 2022 Update.

In this tutorial, you set up a lab with virtual machines that are used by students in the classroom by doing the following actions:

  • Create a lab
  • Publish a lab
  • Add users to the lab
  • Set schedule for the lab
  • Send invitation email to students

Prerequisites

Here's the typical workflow when using Azure Lab Services:

  1. The person that created the lab plan adds other users to the Lab Creator role. For example, the administrator (who created the lab plan) assigns educators to the Lab Creator role on the lab plan or resource group so that they can create labs for their classes. The administrator can also assign educators the Lab Creator role on the resource group that contains one or more lab plans. To assign the Lab Creator role to someone, see Add a user to the Lab Creator role.
  2. Then, the educators create labs with VMs for their classes and send registration links to students in the class. If the administrator assigned the Lab Creator role at the resource group, the educator can choose from all lab plans in that resource group when creating new labs.
  3. Students use the registration link that they receive from educators to register to the lab. Once they're registered, they can use VMs in the labs to do the class work and homework. If Canvas or Teams integration with Azure Lab Services is used, this step is skipped by the students.

Create a lab

In this step, you create a lab for your class in Azure Lab Services portal.

  1. Navigate to Lab Services web portal: https://labs.azure.com.

  2. Select Sign in and enter your credentials. Azure Lab Services supports organizational accounts and Microsoft accounts.

  3. Select New lab.

    Screenshot of Azure Lab Services portal.  New lab button is highlighted.

  4. In the New Lab window, do the following actions:

    1. Specify a name, virtual machine image, size, and region for your lab, and select Next. For more information about naming restrictions, see Microsoft.LabServices resource name rules.

      Possibly, you'll need to choose a lab plan. If more than one lab plan is in the resource group, you'll see a dropdown to choose a lab plan. If there's only one lab plan in the resource group, this option will be hidden.

      Important

      Talk to your admin, if you don't see the virtual machine image you need. They may have to specify Marketplace images or specify custom images available to lab creators. If using custom images, the admin must also verify the custom image is replicated to the same region as the lab plan.

      Note

      Prices shown are for example only. For current pricing information, see Azure Lab Services pricing.

      Screenshot of the New lab window for Azure Lab Services.

    2. On the Virtual machine credentials page, specify default administrator credentials for all VMs in the lab. Specify the name and the password for the administrator. By default all the student VMs will have the same password as the one specified here.

      Important

      Make a note of user name and password. They won't be shown again.

    3. This step is optional for the tutorial. Select Give lab user a non-admin account on their virtual machines to give the student non-administrator account rather the default administrator account.

      Important

      Make a note of non-admin user name and password. They won't be shown again.

    4. If you would like students to set their own password the first time they sign into their VM, uncheck Use same password for all virtual machines. Note, students will have to wait for the password set function to complete before the connect button is available for their VM if Use same password for all virtual machines is unchecked. Select Next.

      Screenshot that shows the Virtual machine credentials window when creating a new Azure Lab Services lab.

    5. On the Lab policies page, leave the default selections and select Next.

      Screenshot of the Lab policy window when creating a new Azure Lab Services lab.

    6. On the Template virtual machine settings window, leave the selection on Create a template virtual machine if you need to make modifications to the template used to create all the student VMs. If you don't need to make any modifications to the image chosen earlier, choose Use a virtual machine image without customization. Select Finish.

      Screenshot of the Template virtual machine settings windows when creating a new Azure Lab Services lab.

  5. You should see the following screen that shows the status of the template VM creation.

    Screenshot of status of the template VM creation.

  6. If Use a virtual machine image without customization was selected on the Template virtual machine settings window when creating the lab, skip this step. On the Template page, optionally do the following steps:

    1. Connect to the template VM by selecting Start. If it's a Linux template VM, you choose whether you want to connect using SSH or RDP (if RDP is enabled). Screenshot of the template page of an Azure Lab Services lab. Start template button is highlighted.
    2. Install and configure software required for your class on the template VM.
    3. Stop the template VM.

    Note

    Template VMs incur cost when running, so ensure that the template VM is shutdown when you don’t need it to be running.

If you chose to create a Linux template VM, more setup is required to use a GUI remote desktop. For more information, see Enable graphical remote desktop for Linux virtual machines in Azure Lab Services.

Publish a lab

In this step, you publish the lab. When you publish the template VM, Azure Lab Services creates VMs in the lab by using the template. All virtual machines have the same configuration as the template.

  1. On the Template page, select Publish on the toolbar.

    Screenshot of Azure Lab Services template page. The Publish template menu button is highlighted.

    Warning

    Publishing is an irreversible action! It can't be undone.

  2. On the Publish template page, select Publish. Select OK when warned that publishing is a permanent action.

Screenshot of confirmation window for publish action of Azure.

  1. You see the status of publishing the template on page.

    Screenshot of Azure Lab Services template page.  The publishing in progress message is highlighted.

  2. Wait until the publishing is complete.

  3. Select Virtual machine pool on the left menu or select Virtual machines tile on the dashboard page to see the list of available machines. Confirm that you see virtual machines that are in Unassigned state. These VMs aren't assigned to students yet. They should be in Stopped state. For more information about managing the virtual machine pool, see Manage a VM pool in Lab Services.

    Screenshot of virtual machines stopped.  The virtual machine pool menu is highlighted.

Note

When an educator turns on a student VM, quota for the student isn't affected. Quota for a user specifies the number of lab hours available to a student outside of the scheduled class time. For more information on quotas, see Set quotas for users.

Set a schedule for the lab

Create a scheduled event for the lab so that VMs in the lab are automatically started and stopped at specific times. The user quota (default: 10 hours) you specified earlier is the extra time assigned to each student outside this scheduled time.

  1. Switch to the Schedules page, and select Add scheduled event on the toolbar. Add scheduled event will be disabled if the lab is actively being published.

    Screenshot of the Add scheduled event button on the Schedules page. The Schedules menu and Add scheduled event button are highlighted.

  2. On the Add scheduled event page, do the following steps:

    1. Confirm that Standard is selected the Event type.
    2. Select the start date for the class.
    3. Select the start time at which you want the VMs to be started.
    4. Select the stop time at which the VMs are to be shut down.
    5. Select the time zone for the start and stop times you specified.
  3. On the same Add scheduled event page, select the current schedule in the Repeat section.
    Screenshot of the Add scheduled event window. The Repeat description of the scheduled event is highlighted.

  4. On the Repeat dialog box, do the following steps:

    1. Confirm that every week is set for the Repeat field.
    2. Select the days on which you want the schedule to take effect. In the following example, Monday-Friday is selected.
    3. Select an end date for the schedule.
    4. Select Save. Screenshot of the Repeat windows for scheduled events. Event repeats every week, Monday through Friday.
  5. On the Add scheduled event page, for Notes (optional), enter any description or notes for the schedule.

  6. On the Add scheduled event page, select Save. Screenshot of the Add scheduled event window.

  7. Navigate to the start date in the calendar to verify that the schedule is set. Screenshot of the Schedule page for Azure Lab Services.  Repeating schedule, Monday through Friday shown in the calendar.

For more information about creating and managing schedules for a class, see Create and manage schedule for labs.

Add users to the lab

In this section, you add students to the lab. Students can be added to a lab several ways including manually by entering an email address, uploading a CSV file with student information, or syncing to an Azure AD group.

By default, the Restrict access option, found on the Users page, is turned on for a lab. Only listed users can register with the lab by using the registration link you send. You can turn off restricted access, which allows students to register with the lab as long as they have the registration link.

  1. Select the Users page.

  2. Select Add users manually.

    Add users manually.

  3. Select Add by email address (default), enter the students' email addresses on separate lines or on a single line separated by semicolons.

    Add users' email addresses

  4. Select Save.

    The list displays the email addresses and statuses of the current users, whether they're registered with the lab or not.

    Users list.

    Note

    After the students are registered with the lab, the list displays their names. The name that's shown in the list is constructed by using the first and last names of the student's information from Azure AD or their Microsoft Account. For more information on supported account types, see Student accounts.

Send invitation emails to users

  1. Switch to the Users view if you aren't on the page already, and select Invite all on the toolbar. Screenshot of User page in Azure Lab Services.  Invite all button highlighted.
  2. On the Send invitation by email page, enter an optional message, and then select Send. The email automatically includes the registration link. You can get this registration link by selecting ... (ellipsis) on the toolbar, and Registration link. Screenshot of Send invitation by email windows for Azure Lab Services.
  3. You see the status of invitation in the Users list. The status should change to Sending and then to Sent on <date>.

For more information about managing usage of student VMs, see How to configure student usage.

Troubleshooting

Lab creation fails with You are not authorized to access this resource

When you create a new lab plan, it might take a few minutes for the permissions to propagate to the lab level. You can assign the Lab Creator role at the resource group level to prevent this behavior:

  1. In the Azure portal, go to the resource group that contains the lab plan.
  2. Select Access control (IAM) from the left navigation.
  3. Select Add > Add role assignment.
  4. Assign the Lab Creator role to the user account.

Next steps

In this tutorial, you created a lab for your class in Azure. To learn how a student can access a VM in the lab using the registration link, advance to the next tutorial.