You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Learn how to configure Canvas to access Azure Lab Services lab plans.
2
+
title: Configure Canvas to use Azure Lab Services
3
+
description: Learn how to configure Canvas to use Azure Lab Services.
5
4
ms.topic: how-to
6
-
ms.date: 11/29/2022
5
+
ms.date: 12/16/2022
7
6
author: ntrogh
8
7
ms.author: nicktrog
9
8
ms.custom: engagement-fy23
10
9
---
11
10
12
-
# Configure Canvas to access Azure Lab Services lab plans
11
+
# Configure Canvas to use Azure Lab Services
13
12
14
-
In this article, you learn how to configure [Canvas](https://www.instructure.com/canvas) to access Azure Lab Services lab plans. Add the Azure Lab Services app to let educators and students access to their labs directly without navigating to the Azure Lab Services portal. Learn more about the [benefits of using Azure Lab Services within Canvas](./lab-services-within-canvas-overview.md).
13
+
[Canvas Learning Management System](https://canvaslms.com/) (LMS) is a cloud-based learning management system that provides one place for course content, quizzes, and grades for both educators and students. In this article, you learn how to add the Azure Lab Services app to [Canvas](https://www.instructure.com/canvas). Educators can create labs from within Canvas and students will see their lab VMs alongside their other material for a course.
15
14
16
-
To use Azure Lab Services in Canvas, two tasks must be completed:
15
+
Learn more about the [benefits of using Azure Lab Services within Canvas](./lab-services-within-canvas-overview.md).
17
16
18
-
1. Enable the Azure Lab Services app in your school's Canvas instance. The Azure Lab Services app will be an inherited app in Canvas.
19
-
1. Connect the Canvas instance to a lab plan resource in Azure.
17
+
To configure Canvas to use Azure Lab Services, go through the one-time step to [enable the Azure Lab Services app in Canvas](#enable-the-azure-lab-services-app-in-canvas). Next, you can then [add the Azure Lab Services app to your course](#add-azure-lab-services-to-a-course).
20
18
21
-
For information about creating and managing labs in Canvas, see[Create and manage labs in Canvas](./how-to-manage-labs-within-canvas.md).
19
+
If you've already configured your course to use Azure Lab Services, learn how you can[Create and manage labs in Canvas](./how-to-manage-labs-within-canvas.md).
- Write access to [lab plan](tutorial-setup-lab-plan.md) to be linked to Canvas.
25
+
- An Azure Lab Services lab plan. Follow these steps to [Create a lab plan in the Azure portal](./tutorial-setup-lab-plan.md), if you don't have one yet.
29
26
30
-
## Enable Azure Lab Services app in Canvas
27
+
- Your Canvas account needs [Admin permissions](https://community.canvaslms.com/t5/Canvas-Basics-Guide/What-is-the-Admin-role/ta-p/78) to add the Azure Lab Services app to Canvas.
31
28
32
-
To use the Azure Lab Services Canvas app, first enable the corresponding developer key:
29
+
- To link lab plans, your Azure account needs the following permissions. Learn how to [assign Azure Active Directory roles to users](/azure/active-directory/roles/manage-roles-portal).
30
+
- Reader role on the Azure subscription.
31
+
- Contributor role on the resource group that contains your lab plan.
32
+
- Write access to the lab plan.
33
33
34
-
1. Select the **Admin** page in Canvas.
35
-
1. Select **Developer Keys** in the menu bar, and then select the **Inherited** view of the developer keys.
36
-
1. Change the **Azure Lab Services** entry to **On**. The Azure Lab Services developer key is **170000000000711**.
34
+
## Enable the Azure Lab Services app in Canvas
37
35
38
-
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-enable-lab-services-app.png" alt-text="Screenshot that shows how to turn on the inherited Azure Lab Services app in the Canvas Admin settings.":::
36
+
The first step to let users access their labs and labplans through Canvas is to enable the Azure Lab Services app in Canvas. To use a third-party application, such as Azure Lab Services, in Canvas, you have to enable the corresponding developer key in Canvas.
39
37
40
-
### Link lab plans to Canvas
38
+
The Canvas developer key for the Azure Lab Services app is an *inherited key*, also referred to as a *global developer key*. Learn more about [developer keys in the Canvas Community Hub](https://community.canvaslms.com/t5/Canvas-Admin-Blog/Administrative-guidelines-for-managing-Inherited-Developer-Keys/ba-p/269029).
41
39
42
-
After enabling the Azure Lab Services app in Canvas, you can link lab plans to Canvas. Only linked lab plans will be available for Canvas educators to use when creating labs.
40
+
To enable the developer key for the Azure Lab Services app:
43
41
44
-
To link lab plans to Canvas, your account must be a Canvas administrator. The Canvas administrator must have the following permissions on the lab plan.
42
+
1. In Canvas, select the **Admin** page.
45
43
46
-
- Reader role on the subscription.
47
-
- Contributor role on the resource group that contains your lab plan.
44
+
1. Select **Developer Keys** in the left navigation.
48
45
49
-
Perform the following steps to link lab plans to Canvas:
46
+
1. Select the **Inherited** tab of the developer keys.
50
47
51
-
1.[Add Azure Lab Services to a course in Canvas](#add-azure-lab-services-app-to-a-course). A 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.
52
-
1.[Create a lab plan in Azure](./tutorial-setup-lab-plan.md) if you haven't already.
53
-
1. Open the Azure Lab Services app in the course.
54
-
1. Select the tool icon in the upper right to see the list all the lab plans.
55
-
1. Choose which lab plans to link.
48
+
1. In the list, change the state of the **Azure Lab Services** entry to **On**.
56
49
57
-
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-select-lab-plans.png" alt-text="Screenshot that shows list of lab plans that can be linked to Canvas.":::
50
+
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-enable-lab-services-app.png" alt-text="Screenshot that shows how to turn on the inherited Azure Lab Services app in the Canvas Admin settings." lightbox="./media/how-to-configure-canvas-for-lab-plans/canvas-enable-lab-services-app.png":::
58
51
59
-
1. Select **Save**.
52
+
## Add Azure Lab Services app to an account (optional)
53
+
54
+
You can enable the Azure Lab Services app for a Canvas course in either of two ways:
60
55
61
-
In the [Azure portal](https://portal.azure.com), the **LMS settings** page for the lab plan shows that the lab plan is successfully linked.
56
+
- Add the Azure Lab Services app at the Canvas account level.
62
57
63
-
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/lab-plan-linked-canvas.png" alt-text="Screenshot of the L M S settings page for a lab plan.":::
58
+
-[Add the Azure Lab Services app for a specific course](#add-the-azure-lab-services-app-to-a-course) in Canvas.
64
59
65
-
### Add Azure Lab Servicesapp to an account
60
+
When you add the app at the Canvas account level, you avoid that you have to add the app for every individual course. If you have multiple courses that use Azure Lab Services, adding the app at the account level might be quicker. After adding the app for the Canvas account, you only have to [enable the Azure Lab Services app in the course navigation](#enable-azure-lab-services-in-course-navigation).
66
61
67
-
Canvas administrators may choose to enable the Azure Lab Services app for an account. Enabling an app at the account level allows educators to enable or disable navigation to the Azure Lab Services app per course. Educators can avoid adding the app for each individual course.
62
+
To add the app at the Canvas account level:
68
63
69
64
1. In Canvas, select the **Admin** menu.
70
-
1. Select the account that you want to add the Azure Lab Services app to. Alternatively, select **All Accounts** to add the Azure Lab Services app to all accounts for the Canvas LMS instance.
65
+
66
+
1. Select the account that you want to add the Azure Lab Services app to. Alternatively, select **All Accounts** to add the Azure Lab Services app to all accounts for the Canvas Learning Management System (LMS) instance.
71
67
72
68
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-admin-choose-account.png" alt-text="Screenshot that shows the Admin menu and accounts list in Canvas.":::
73
69
74
-
1. Choose **Settings**, then select the **Apps** tab.
70
+
1. Choose **Settings**, and then select the **Apps** tab.
71
+
75
72
1. Select **View App Configurations** button at the top right of the page.
76
73
77
-
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-admin-settings.png" alt-text="Screenshot that shows the App tab of the admin settings page in Canvas.":::
74
+
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-admin-settings.png" alt-text="Screenshot that shows the App tab of the admin settings page in Canvas." lightbox="./media/how-to-configure-canvas-for-lab-plans/canvas-admin-settings.png":::
78
75
79
-
1. Select the blue **+ App** button at the top right of the page.
76
+
1. Select the **+ App** button at the top right of the page.
80
77
81
78
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-add-app.png" alt-text="Screenshot that shows Add app button in the admin settings page.":::
82
79
83
80
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.
84
81
85
82
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/enable-lab-services.png" alt-text="Screenshot that shows Add by Client ID dialog in Canvas admin settings page.":::
86
83
87
-
1. When the **Add App** dialog asks *Tool "Azure Lab Services" found for client ID 170000000000711. Would you like to install it?* select **Install**.
84
+
1. When the **Add App** dialog asks *Tool "Azure Lab Services" found for client ID 170000000000711. Would you like to install it?*, select **Install**.
88
85
89
-
The Azure Lab Services app will now be available for all courses in that account. The app won't show in course navigation by default. Educators must first enable the app in course navigation before it can be used.
86
+
The Azure Lab Services app is now available for all courses in that account.
90
87
91
-
###Add Azure Lab Services app to a course
88
+
## Add Azure Lab Services to a course
92
89
93
-
If you already [added the Azure Lab Services app at the account level](#add-azure-lab-services-app-to-an-account), the educator must enable the app in the course navigation.
90
+
Next, you associate the Azure Lab Services app with a course in Canvas. You have two options to configure a course in Canvas to use Azure Lab Services:
94
91
95
-
To enable the Azure Lab Services app in the course navigation:
92
+
- If you added the Azure Lab Services app at the Canvas account level, [enable the app in the course navigation](#enable-azure-lab-services-in-course-navigation).
96
93
97
-
1. In Canvas, go to the course that will use Azure Lab Services.
98
-
1. Choose **Settings**, then select the **Navigation** tab.
99
-
1. Find the **Azure Lab Services** entry, select the three vertical dots, then select **Enable**.
94
+
- Otherwise, [add the Azure Lab Services app to a course](#add-the-azure-lab-services-app-to-a-course).
100
95
101
-
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-enable-lab-services-app-in-course-navigation.png" alt-text="Screenshot of enabling Lab Services app in course navigation.":::
102
-
103
-
1. Select **Save**.
96
+
### Add the Azure Lab Services app to a course
104
97
105
-
If you didn't add the Azure Lab Services app at the account level, use the following instructions to add the app at the course level:
98
+
You now add the Azure Lab Services app to a specific course in Canvas.
106
99
107
100
1. In Canvas, go to the course that will use Azure Lab Services.
101
+
108
102
1. Choose **Settings**, and then select the **Apps** tab.
103
+
109
104
1. Select **View App Configurations** button at the top right of the page.
110
105
111
-
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-settings-apps.png" alt-text="Screenshot that shows the App tab of the settings page for a course in Canvas.":::
106
+
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-settings-apps.png" alt-text="Screenshot that shows the App tab of the settings page for a course in Canvas." lightbox="./media/how-to-configure-canvas-for-lab-plans/canvas-settings-apps.png":::
112
107
113
-
1. Select the blue **+ App** button at the top right of the page.
108
+
1. Select the **+ App** button at the top right of the page.
114
109
115
110
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-add-app.png" alt-text="Screenshot that shows Add app button in Canvas.":::
116
111
@@ -120,13 +115,58 @@ If you didn't add the Azure Lab Services app at the account level, use the follo
120
115
121
116
1. When the **Add App** dialog asks *Tool "Azure Lab Services" found for client ID 170000000000711. Would you like to install it?*, select **Install**.
122
117
123
-
The Azure Lab Services app will take a few moments to show in the course navigation list.
118
+
The Azure Lab Services app takes a few moments to show in the course navigation list.
119
+
120
+
You can skip to [Link a lab plan to a course](#link-lab-plans-to-canvas) to finalize the configuration of Canvas.
121
+
122
+
### Enable Azure Lab Services in course navigation
123
+
124
+
If you previously added the app at the Canvas account level, you don't have to add the app for a specific course. Instead, you enable the app in the Canvas course navigation:
125
+
126
+
1. In Canvas, go to the course that uses Azure Lab Services.
127
+
128
+
1. Choose **Settings**, then select the **Navigation** tab.
129
+
130
+
1. Find the **Azure Lab Services** entry, select the three vertical dots, and then select **Enable**.
131
+
132
+
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-enable-lab-services-app-in-course-navigation.png" alt-text="Screenshot of enabling Lab Services app in course navigation.":::
133
+
134
+
1. Select **Save**.
135
+
136
+
## Link lab plans to Canvas
137
+
138
+
After you enable the Azure Lab Services app in Canvas and associate it with a course, you link specific lab plans to Canvas. You can only use linked lab plans for creating labs in Canvas.
139
+
140
+
To link lab plans to Canvas, your Canvas account must be a Canvas administrator. In addition, your Azure account must have the following permissions on the lab plan.
141
+
142
+
- Reader role on the subscription.
143
+
- Contributor role on the resource group that contains your lab plan.
144
+
145
+
Perform the following steps to link lab plans to Canvas:
146
+
147
+
1. In Canvas, go to a course for which you previously added the Azure Lab Services app.
148
+
149
+
1. Open the Azure Lab Services app in the course.
150
+
151
+
1. Select the tool icon in the upper right to see the list all the lab plans.
152
+
153
+
1. Choose the lab plans you want to link to Canvas from the list.
154
+
155
+
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/canvas-select-lab-plans.png" alt-text="Screenshot that shows the list of lab plans that can be linked to Canvas." lightbox="./media/how-to-configure-canvas-for-lab-plans/canvas-select-lab-plans.png":::
156
+
157
+
1. Select **Save**.
158
+
159
+
In the [Azure portal](https://portal.azure.com), the **LMS settings** page for the lab plan shows that you linked the lab plan successfully to Canvas.
160
+
161
+
:::image type="content" source="./media/how-to-configure-canvas-for-lab-plans/lab-plan-linked-canvas.png" alt-text="Screenshot of the L M S settings page for a lab plan." lightbox="./media/how-to-configure-canvas-for-lab-plans/lab-plan-linked-canvas.png":::
124
162
125
163
## Next steps
126
164
165
+
You've successfully configured Canvas to access Azure Lab Services. You can now continue to create and manage labs for your courses in Canvas.
166
+
127
167
See the following articles:
128
168
129
169
- As an admin, [add educators as lab creators to the lab plan](./add-lab-creator.md) in the Azure portal.
130
170
- As an educator, [create and manage labs in Canvas](./how-to-manage-labs-within-canvas.md).
131
-
- As an eductor, [manage user lists in Canvas](./how-to-manage-labs-within-canvas.md#manage-lab-user-lists-in-canvas).
171
+
- As an educator, [manage user lists in Canvas](./how-to-manage-labs-within-canvas.md#manage-lab-user-lists-in-canvas).
132
172
- As a student, [access a lab VM within Canvas](./how-to-access-vm-for-students-within-canvas.md).
Copy file name to clipboardExpand all lines: articles/lab-services/how-to-configure-teams-for-lab-plans.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,16 @@
1
1
---
2
-
title: Configure Teams to access lab plans
3
-
titleSuffix: Azure Lab Services
4
-
description: Learn how to configure Microsoft Teams to access Azure Lab Services lab plans.
2
+
title: Configure Teams to use Azure Lab Services
3
+
description: Learn how to configure Microsoft Teams to use Azure Lab Services.
5
4
ms.topic: how-to
6
5
ms.date: 11/15/2022
7
6
author: ntrogh
8
7
ms.author: nicktrog
9
8
ms.custom: engagement-fy23
10
9
---
11
10
12
-
# Configure Microsoft Teams to access Azure Lab Services lab plans
11
+
# Configure Microsoft Teams to use Azure Lab Services
13
12
14
-
In this article, you learn how to configure Microsoft Teams to access Azure Lab Services lab plans. Add the Azure Lab Services Teams app to a team channel to let educators and students access to their labs directly without navigating to the Azure Lab Services portal. Learn more about the [benefits of using Azure Lab Services within Teams](./lab-services-within-teams-overview.md).
13
+
In this article, you learn how to configure Microsoft Teams to use Azure Lab Services. Add the Azure Lab Services Teams app to a team channel to let educators and students access to their labs directly without navigating to the Azure Lab Services portal. Learn more about the [benefits of using Azure Lab Services within Teams](./lab-services-within-teams-overview.md).
15
14
16
15
For information about creating and managing labs in Microsoft Teams, see [Create and manage labs in Microsoft Teams](./how-to-manage-labs-within-teams.md).
Copy file name to clipboardExpand all lines: articles/lab-services/includes/lab-services-new-update-focused-article.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,4 +7,4 @@ ms.custom: devdivchpfy22
7
7
---
8
8
9
9
> [!NOTE]
10
-
> This article references features available since the August 2022 Update, in which[lab plans](../how-to-manage-lab-plans.md) replaced lab accounts. For more information, see [What's New in the August 2022 Update](../lab-services-whats-new.md).
10
+
> This article references features available since the August 2022 Update, when[lab plans](../how-to-manage-lab-plans.md) replaced lab accounts. For more information, see [What's New in the August 2022 Update](../lab-services-whats-new.md).
0 commit comments