|
2 | 2 | title: Get started and create an Azure Lab Services lab within Canvas
|
3 | 3 | description: Learn how to get started and create an Azure Lab Services lab within Canvas.
|
4 | 4 | ms.topic: how-to
|
5 |
| -ms.date: 10/29/2021 |
| 5 | +ms.date: 01/21/2022 |
6 | 6 | ---
|
7 | 7 |
|
8 | 8 | # Get started and create an Azure Lab Services lab within Canvas
|
9 | 9 |
|
10 |
| -This article shows how to add the Azure Lab Services app to [Canvas](https://www.instructure.com/canvas). It will also show how to create a lab within the Canvas environment. The Azure Lab Services app will be an inherited app in Canvas. |
| 10 | +This article shows you how to add the Azure Lab Services app to [Canvas](https://www.instructure.com/canvas). It will also show how to create a lab within the Canvas environment. The Azure Lab Services app will be an inherited app in Canvas. |
11 | 11 |
|
12 |
| -## Getting started |
13 |
| - |
14 |
| -To use Azure Lab Services in Canvas, two tasks must be completed. The first is to enable the Azure Lab Services app in your school's/organization's Canvas instance. The second is to connect the Canvas instance to a lab plan resource in Azure. |
| 12 | +To use Azure Lab Services in Canvas, two tasks must be completed. The first is to enable the Azure Lab Services app in your school's Canvas instance. The second is to connect the Canvas instance to a lab plan resource in Azure. |
15 | 13 |
|
16 | 14 | ### Prerequisites
|
17 | 15 |
|
18 | 16 | - Canvas administrator permissions.
|
19 |
| -- Write access to [lab plan](how-to-manage-lab-plans.md) to be linked to Canvas. |
| 17 | +- Write access to [lab plan](tutorial-setup-lab-plan.md) to be linked to Canvas. |
20 | 18 |
|
21 |
| -### Enable Azure Lab Service app in Canvas |
| 19 | +### Enable Azure Lab Services app in Canvas |
22 | 20 |
|
23 |
| -First, let's turn on Azure Lab Services developer key for Canvas. |
| 21 | +First, let us turn on Azure Lab Services developer key for Canvas. |
24 | 22 |
|
25 |
| -1. In Canvas, select **Admin** page. |
26 |
| -1. Select **Developer Keys** menu item on the left. |
| 23 | +1. Select **Admin** page in Canvas. |
| 24 | +1. Select **Developer Keys** in the menu bar. |
27 | 25 | 1. When the **Developer Keys** page appears, select **Inherited** view of the developer keys.
|
28 | 26 | 1. Change the **Azure Lab Services** entry to **On**. The Azure Lab Services developer key is **170000000000711**.
|
29 | 27 |
|
| 28 | +:::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/canvas-enable-lab-services-app.png" alt-text="Turn on the inherited Azure Lab Services app in the Canvas Admin settings."::: |
| 29 | + |
30 | 30 | ### Link lab plans to Canvas
|
31 | 31 |
|
32 |
| -Now that Azure Lab Services app is enabled in Canvas, we need to link the lab plans to Canvas. Only linked lab plans will be available for Canvas educators to use when creating labs. |
33 |
| - |
34 |
| -1. If not already done, [create a lab plan in Azure](./tutorial-setup-lab-plan.md). |
35 |
| -1. Verify Canvas administrator has the following permissions on the lab plan. |
36 |
| - - **Reader** role on the subscription. |
37 |
| - - **Contributor** role on the resource group that contains your lab plan. |
38 |
| -1. Add Azure Lab Services to a course in Canvas. Canvas administrator will need to add Azure Lab Services to the course *only* if there are no other courses with Azure Lab Services. If there's already a course with the Azure Lab Services app, navigate to that course in Canvas and skip this step. |
39 |
| - 1. In Canvas, go to the course that will use Azure Lab Services. |
40 |
| - 1. Choose **Settings**, then select the **Apps** tab. |
41 |
| - 1. Select **View App Configurations** button at the top right of the page. |
42 |
| - 1. Select the blue **+ App** button at the top right of the page. |
43 |
| - 1. On the **Add App** dialog, in the **Configuration Type** dropdown, choose **By Client ID**. Enter the Azure Lab Services client ID, which is **170000000000711**, into the **Client ID** field. Select the **Submit** button. |
44 |
| - 1. When the **Add App** dialog asks *Tool "Azure Lab Services" found for client ID 170000000000711. Would you like to install it?* select **Install**. |
45 |
| - 1. The Azure Lab Services app will take a few moments to show in the course navigation list. |
46 |
| -1. Link lap plan to Canvas. |
47 |
| - 1. Open the Azure Lab Services app in the course. |
48 |
| - 1. In the Azure Lab Services app, select the resource group that the lab plan is in. |
49 |
| - 1. Select the button to finish administrator setup. |
50 |
| - 1. If prompted, enter Azure credentials to finish setup. |
| 32 | +Now that Azure Lab Services app is enabled in Canvas, we need to link the lab plans to Canvas. Linking lab plans to Canvas must be done by a Canvas administrator. The Canvas administrator must have the following permissions on the lab plan. |
| 33 | +- **Reader** role on the subscription. |
| 34 | +- **Contributor** role on the resource group that contains your lab plan. |
51 | 35 |
|
52 |
| -## Create labs in Canvas |
| 36 | +Only linked lab plans will be available for Canvas educators to use when creating labs. |
53 | 37 |
|
54 |
| -1. Add Azure Lab Services app to the course. |
55 |
| - 1. In Canvas, go to the course that will use Azure Lab Services. |
56 |
| - 2. Choose **Settings**, then select the **Apps** tab. |
57 |
| - 3. Select **View App Configurations** and then the blue **+ App** button at the top right of the page. |
58 |
| - 4. In the Configuration Type dropdown, choose **By Client ID** and enter Azure Lab Services client ID, which is **170000000000711**, into the field. |
59 |
| - :::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/enable-lab-services.png" alt-text="Canvas -> Add App"::: |
60 |
| -1. Once Azure Lab Services is added to your course, you’ll see **Azure Lab Services** in the course navigation menu. |
61 |
| -1. If you're authenticated in Canvas as an educator, you'll see this sign in screen (shown below) before you can use the service. You'll need to sign in here with an Azure AD account or Microsoft account that has been added as a Lab Creator. |
62 |
| - :::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/welcome-to-lab-services.png" alt-text="Canvas -> Welcome"::: |
63 |
| -1. Create one or more labs for student. See [Tutorial: Set up a lab](tutorial-setup-lab.md) for further instructions. Make sure to verify the resource group in which to create the lab before creating the lab. |
64 |
| -1. [Publish the lab](tutorial-setup-lab.md#publish-a-lab). |
| 38 | +1. [Add Azure Lab Services to a course in Canvas](#add-azure-lab-services-app-to-a-course). Canvas administrator will need to add Azure Lab Services to the course *only* if there are no other courses with Azure Lab Services. If there is already a course with the Azure Lab Services app, navigate to that course in Canvas and skip this step. |
| 39 | +2. [Create a lab plan in Azure](./tutorial-setup-lab-plan.md) if you have not already. |
| 40 | +3. Open the Azure Lab Services app in the course. |
| 41 | +4. Select the tool icon in the upper right to see the list all the lab plans. |
| 42 | +5. Choose which lab plans to link. |
| 43 | +:::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/canvas-select-lab-plans.png" alt-text="Screenshot that shows list of lab plans that can be liked to Canvas."::: |
65 | 44 |
|
66 |
| -When you create a lab inside a Course in Canvas, the lab will automatically pull the list of students from Canvas’s course roster and add them as users in the lab’s user list. Virtual machines will be added and deleted automatically based on changes to the course roster. You can create multiple labs for a course. |
| 45 | +1. Select **Save**. |
| 46 | + |
| 47 | +If you view the lab plan in the [Azure portal](https://portal.azure.com), the **LMS settings** page will show the lab plan has been successfully linked. |
| 48 | +:::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/lab-plan-linked-canvas.png" alt-text="Screenshot of the L M S settings page for a lab plan."::: |
67 | 49 |
|
68 |
| -Instructors can access their labs through Canvas or the [Azure Lab Services portal](https://labs.azure.com). Students must access their VM through Canvas. |
| 50 | +### Add Azure Lab Services app to a course |
69 | 51 |
|
70 |
| -> [!NOTE] |
71 |
| -> A lab virtual machine will also be created for the course instructor. VM can be found in the virtual machine pool or by selecting the **My virtual machines** icon in the upper right of the Azure Lab Services portal. |
| 52 | + 1. In Canvas, go to the course that will use Azure Lab Services. |
| 53 | + 1. Choose **Settings**, then select the **Apps** tab. |
| 54 | + 1. Select **View App Configurations** button at the top right of the page. |
| 55 | + :::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/canvas-settings-apps.png" alt-text="Screenshot that shows the App tab of a the settings page for a course in Canvas."::: |
72 | 56 |
|
73 |
| -You'll see that each student is assigned a virtual machine. The VM is marked as “Unpublished” if the lab isn't yet published. Students don’t have access to the VMs until the lab is published. |
| 57 | + 1. Select the blue **+ App** button at the top right of the page. |
| 58 | + :::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/canvas-add-app.png" alt-text="Screenshot that shows Add app button in Canvas."::: |
| 59 | + |
| 60 | + 1. On the **Add App** dialog, in the **Configuration Type** dropdown, choose **By Client ID**. Enter the Azure Lab Services client ID, which is **170000000000711**, into the **Client ID** field. Select the **Submit** button. |
| 61 | + :::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/enable-lab-services.png" alt-text="Screenshot that shows Add by Client Id dialog in Canvas."::: |
74 | 62 |
|
75 |
| -:::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/user-list.png" alt-text="Canvas VM pool"::: |
| 63 | + 1. When the **Add App** dialog asks *Tool "Azure Lab Services" found for client ID 170000000000711. Would you like to install it?* select **Install**. |
| 64 | + 1. The Azure Lab Services app will take a few moments to show in the course navigation list. |
76 | 65 |
|
77 |
| -## Access labs (students) |
| 66 | +## Create labs in Canvas |
78 | 67 |
|
79 |
| -In Canvas, students can access the labs you set up for a course by clicking on the Azure Lab Services tab. If students are signed into Canvas, they get a single sign-on experience to Azure Lab Services. Students can see and access the virtual machines provided to them. Students will only see virtual machines from labs that were created for this course. |
| 68 | +Once Azure Lab Services is added to your course, you will see **Azure Lab Services** in the course navigation menu. If you are authenticated in Canvas as an educator, you will see this sign in screen before you can use the service. You will need to sign in here with an Azure AD account or Microsoft account that has been added as a Lab Creator. |
| 69 | + :::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/welcome-to-lab-services.png" alt-text="Canvas -> Welcome"::: |
80 | 70 |
|
81 |
| - :::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/student-experience.png" alt-text="Canvas student experience"::: |
| 71 | +For instructions to create a lab, see [Create a lab](quick-create-lab-portal.md). Make sure to verify the resource group in which to create the lab before creating the lab. |
| 72 | + |
| 73 | +> [!IMPORTANT] |
| 74 | +> Labs must be created using the Azure Lab Services app in Canvas. Labs created from the Azure Lab Services portal aren't visible from Canvas. |
| 75 | +
|
| 76 | +The student list for the course is automatically synced with the course roster. For more information, see [Manage Lab Services user lists from Canvas](how-to-manage-user-lists-within-canvas.md). A lab VM will also be created for the course instructor. |
82 | 77 |
|
83 | 78 | ## Troubleshooting
|
84 | 79 |
|
85 | 80 | This section outlines common error messages that you may see, along with the steps to resolve them.
|
86 | 81 |
|
87 |
| -- Student sees warning that the lab isn’t available yet. |
| 82 | +- Student sees warning that the lab is not available yet. |
88 | 83 |
|
89 |
| - In Canvas, you'll see the following message if the instructor hasn't published the lab yet. Instructors must [publish the lab](tutorial-setup-lab.md#publish-a-lab) and [sync users](how-to-manage-user-lists-within-canvas.md#sync-users) for students to have access to a lab. |
| 84 | + In Canvas, you will see the following message if the instructor has not published the lab yet. Instructors must [publish the lab](tutorial-setup-lab.md#publish-a-lab) and [sync users](how-to-manage-user-lists-within-canvas.md#sync-users) for students to have access to a lab. |
90 | 85 |
|
91 | 86 | :::image type="content" source="./media/how-to-get-started-create-labs-within-canvas/troubleshooting-lab-isnt-available-yet.png" alt-text="Troubleshooting -> This lab is not available yet":::
|
92 | 87 |
|
93 | 88 | - Insufficient permissions to create lab.
|
94 | 89 |
|
95 |
| - In Canvas, an instructor will see a message indicating that they don’t have sufficient permission. Instructors should contact their Azure admin so they may be assigned the appropriate [Lab Services built-in role](administrator-guide.md#rbac-roles). |
| 90 | + In Canvas, an instructor will see a message indicating that they do not have sufficient permission. Instructors should contact their Azure admin so they can be [added as a **Lab Creator**](tutorial-setup-lab-plan.md#add-a-user-to-the-lab-creator-role). |
| 91 | + |
| 92 | +- Message that there is not enough capacity to create lab VMs. |
| 93 | + |
| 94 | + [Request a limit increase](capacity-limits.md#request-a-limit-increase). |
| 95 | + |
| 96 | +## Next steps |
96 | 97 |
|
97 |
| -- Message that there isn't enough capacity to create lab VMs. |
| 98 | +See the following articles: |
98 | 99 |
|
99 |
| - [Request a limit increase](capacity-limits.md#request-a-limit-increase). To create a support request, you must be an [Owner](/azure/role-based-access-control/built-in-roles), [Contributor](/azure/role-based-access-control/built-in-roles), or be assigned to the [Support Request Contributor](/azure/role-based-access-control/built-in-roles) role at the subscription level. For information about creating support requests in general, see how to create a [How to create an Azure support request](/azure/azure-portal/supportability/how-to-create-azure-support-request). |
| 100 | +- [Manage user lists from Canvas](how-to-manage-user-lists-within-canvas.md) |
| 101 | +- [Create schedules from Canvas](how-to-create-schedules-within-canvas.md) |
| 102 | +- [Access a VM (student view) from Canvas](how-to-access-vm-for-students-within-canvas.md) |
0 commit comments