Skip to content

Commit b2198d0

Browse files
committed
Update for readability after team review
1 parent a012470 commit b2198d0

File tree

2 files changed

+45
-22
lines changed

2 files changed

+45
-22
lines changed

articles/lab-services/how-to-configure-canvas-for-lab-plans.md

Lines changed: 44 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.custom: engagement-fy23
1010

1111
# Configure Canvas to use Azure Lab Services
1212

13-
In this article, you learn how to add the Azure Lab Services app to [Canvas](https://www.instructure.com/canvas). The Azure Lab Services app lets educators and students access to their labs directly from Canvas 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+
In this article, you learn how to add the Azure Lab Services app to [Canvas](https://www.instructure.com/canvas). Educators and students can use the Azure Lab Services app to access their labs directly from Canvas, without having to navigate to the Azure Lab Services web portal. Learn more about the [benefits of using Azure Lab Services within Canvas](./lab-services-within-canvas-overview.md).
1414

1515
For information about creating and managing labs in Canvas, see [Create and manage labs in Canvas](./how-to-manage-labs-within-canvas.md).
1616

@@ -19,38 +19,54 @@ For information about creating and managing labs in Canvas, see [Create and mana
1919
## Prerequisites
2020

2121
- 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.
22-
- To add the Azure Lab Services app, your Canvas user account needs Canvas administrator permissions.
23-
- To link lab plans, your account needs:
24-
- Canvas administrator permissions.
22+
23+
- 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, and to link lab plans.
24+
25+
- 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).
2526
- Reader role on the Azure subscription.
2627
- Contributor role on the resource group that contains your lab plan.
2728
- Write access to the lab plan.
2829

2930
## Enable the Azure Lab Services app in Canvas
3031

31-
You can use Canvas for accessing Azure Lab Services by enabling the Azure Lab Services Canvas app. The Azure Lab Services app is an inherited app in Canvas. To use the app, enable the corresponding developer key:
32+
The first step to let users access their labs and lab plans 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.
33+
34+
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).
35+
36+
To enable the Azure Lab Services app, your Canvas account needs Canvas administrator permissions.
37+
38+
To enable the developer key for the Azure Lab Services app:
3239

3340
1. In Canvas, select the **Admin** page.
41+
3442
1. Select **Developer Keys** in the left navigation.
43+
3544
1. Select the **Inherited** tab of the developer keys.
45+
3646
1. In the list, change the state of the **Azure Lab Services** entry to **On**.
3747

3848
:::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.":::
3949

4050
## Add Azure Lab Services app to an account (optional)
4151

42-
After enabling the Azure Lab Services app in Canvas, you might enable the Azure Lab Services app for the entire account. Enabling the app at the account level lets educators quickly enable or disable navigation to Azure Lab Services on a per-course basis.
52+
You can enable the Azure Lab Services app for a Canvas course in either of two ways:
53+
54+
- Add the Azure Lab Services app at the Canvas account level.
4355

44-
If you want to add the app to a specific course, skip to [Add the Azure Lab Services app to a course](#add-the-azure-lab-services-app-to-a-course).
56+
- [Add the Azure Lab Services app for a specific course](#add-the-azure-lab-services-app-to-a-course) in Canvas.
4557

46-
To add the app at the account level:
58+
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).
59+
60+
To add the app at the Canvas account level:
4761

4862
1. In Canvas, select the **Admin** menu.
49-
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.
63+
64+
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.
5065

5166
:::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.":::
5267

53-
1. Choose **Settings**, then select the **Apps** tab.
68+
1. Choose **Settings**, and then select the **Apps** tab.
69+
5470
1. Select **View App Configurations** button at the top right of the page.
5571

5672
:::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.":::
@@ -65,20 +81,24 @@ To add the app at the account level:
6581

6682
1. When the **Add App** dialog asks *Tool "Azure Lab Services" found for client ID 170000000000711. Would you like to install it?*, select **Install**.
6783

68-
The Azure Lab Services app is now available for all courses in that account. The app doesn't show up in the course navigation by default. Move to the next step to [enable the app in course navigation](#enable-azure-lab-services-in-course-navigation).
84+
The Azure Lab Services app is now available for all courses in that account.
6985

7086
## Add Azure Lab Services to a course
7187

72-
To use Azure Lab Services in a course, you now add the Azure Lab Services app to a course.
88+
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:
89+
90+
- 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).
7391

74-
If you previously added the app at the account level, you only need to enable the app in the course navigation. Skip to [enable the app in the course navigation](#enable-azure-lab-services-in-course-navigation).
92+
- Otherwise, [add the Azure Lab Services app to a course](#add-the-azure-lab-services-app-to-a-course).
7593

7694
### Add the Azure Lab Services app to a course
7795

78-
To add the app at the course level:
96+
You add the Azure Lab Services app to a specific course in Canvas, if you didn't previously add the Azure Lab Services app at the Canvas account level.
7997

8098
1. In Canvas, go to the course that uses Azure Lab Services.
99+
81100
1. Choose **Settings**, and then select the **Apps** tab.
101+
82102
1. Select **View App Configurations** button at the top right of the page.
83103

84104
:::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.":::
@@ -95,36 +115,39 @@ To add the app at the course level:
95115

96116
The Azure Lab Services app takes a few moments to show in the course navigation list.
97117

98-
You can now move to [Link a lab plan to a course](#link-lab-plans-to-canvas) to finalize the configuration of Canvas.
118+
You can skip to [Link a lab plan to a course](#link-lab-plans-to-canvas) to finalize the configuration of Canvas.
99119

100120
### Enable Azure Lab Services in course navigation
101121

102-
If you added the app at the account level, you should enable the app in the course navigation to use Azure Lab Services in course:
122+
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:
103123

104124
1. In Canvas, go to the course that uses Azure Lab Services.
125+
105126
1. Choose **Settings**, then select the **Navigation** tab.
106-
1. Find the **Azure Lab Services** entry, select the three vertical dots, then select **Enable**.
127+
128+
1. Find the **Azure Lab Services** entry, select the three vertical dots, and then select **Enable**.
107129

108130
:::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.":::
109131

110132
1. Select **Save**.
111133

112-
You can now move to [Link a lab plan to a course](#link-lab-plans-to-canvas) to finalize the configuration of Canvas.
113-
114134
## Link lab plans to Canvas
115135

116-
After enabling the Azure Lab Services app in Canvas, you can link lab plans to Canvas. Only linked lab plans are available for Canvas educators to use when creating labs.
136+
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.
117137

118-
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.
138+
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.
119139

120140
- Reader role on the subscription.
121141
- Contributor role on the resource group that contains your lab plan.
122142

123143
Perform the following steps to link lab plans to Canvas:
124144

125145
1. In Canvas, go to a course for which you previously added the Azure Lab Services app.
146+
126147
1. Open the Azure Lab Services app in the course.
148+
127149
1. Select the tool icon in the upper right to see the list all the lab plans.
150+
128151
1. Choose the lab plans you want to link to Canvas from the list.
129152

130153
:::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.":::

articles/lab-services/includes/lab-services-new-update-focused-article.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ ms.custom: devdivchpfy22
77
---
88

99
> [!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

Comments
 (0)