Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 6ca1a07

Browse files
committedFeb 2, 2022
review of 'how to connect' articles.
1 parent e8b2a7d commit 6ca1a07

12 files changed

+155
-137
lines changed
 

‎articles/lab-services/TOC.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,16 +181,20 @@
181181
items:
182182
- name: Access labs
183183
href: how-to-use-lab.md
184-
- name: Connect to Linux VMs
185-
href: how-to-use-remote-desktop-linux-student.md
184+
- name: Connect to VM
185+
href: connect-virtual-machine.md
186+
- name: Connect to a VM from Windows using RDP
187+
href: connect-virtual-machine-windows-rdp.md
186188
- name: Connect to a VM from Mac using RDP
187189
href: connect-virtual-machine-mac-remote-desktop.md
188190
- name: Connect to a VM from Chromebook using RDP
189191
href: connect-virtual-machine-chromebook-remote-desktop.md
190-
- name: Set or reset passwords for virtual machines
192+
- name: Connect to Linux VM using X2Go
193+
href: how-to-use-remote-desktop-linux-student.md
194+
- name: Set or reset passwords for VMs
191195
href: how-to-set-virtual-machine-passwords-student.md
192196
- name: View support information (student)
193-
href: lab-user-support-information.md
197+
href: lab-user-support-information.md
194198
- name: Use labs within Canvas
195199
items:
196200
- name: Create a lab from Canvas
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Connect to a VM using Remote Desktop Protocol on Windows in Azure Lab Services | Microsoft Docs
3+
description: Learn how to connect from Windows to a Linux VM using Remote Desktop Protocol
4+
ms.topic: how-to
5+
ms.date: 02/01/2022
6+
---
7+
8+
# Connect to a VM using Remote Desktop Protocol on Windows
9+
10+
This article shows how a student can connect from Windows to a lab VM using Remote Desktop Protocol (RDP).
11+
12+
## Connect to VM from Windows using RDP
13+
14+
Students can use RDP to connect to their lab VMs. If the lab VM is a Windows VM, no extra configuration is required by the educator. If the lab VM is a Linux VM, the educator must [enable RDP](how-to-enable-remote-desktop-linux.md) and install GUI packages for a Linux graphical desktop.
15+
16+
Typically, the [Remote Desktop client](/windows-server/remote/remote-desktop-services/clients/remote-desktop-clients) is already installed and configured on Windows. As a result, all you need to do is select on the RDP file to open it and start the remote session.
17+
18+
1. On the tile for your VM, ensure the [VM is running](how-to-use-lab.md#start-or-stop-the-vm) and select the **Connect** icon.
19+
20+
:::image type="content" source="./media/connect-virtual-machine-windows-rdp/connect-vm.png" alt-text="Screenshot of My virtual machines page for Azure Lab Services. The connect icon button on the VM tile is highlighted.":::
21+
1. If you’re connecting *to a Linux VM*, you'll see two options to connect to the VM: **SSH** and **RDP**. Select the **RDP** option.
22+
23+
:::image type="content" source="./media/connect-virtual-machine-windows-rdp/student-vm-connect-options.png" alt-text="Screenshot that shows VM tile for student. The RDP and SSH connection options are highlighted.":::
24+
1. When the RDP file is downloaded onto your machine, open it to launch the RDP client.
25+
1. After adjusting RDP connection settings as needed, select **Connect** to start the remote session.
26+
27+
## Optimize RDP client settings
28+
29+
The RDP client includes various settings that can be adjusted to optimize the user's connection experience. Typically, these settings don't need to be changed. By default, the settings are already configured to choose the right experience based on your network connection. For more information on these settings, see [RDP client's **Experience** settings](/windows-server/administration/performance-tuning/role/remote-desktop/session-hosts#client-experience-settings).
30+
31+
If your instructor has configured the GNOME graphical desktop on a Linux VM with the RDP client, we recommend the following settings to optimize performance:
32+
33+
- Under the **Display** tab, set the color depth to **High Color (15 bit)**.
34+
35+
:::image type="content" source="./media/connect-virtual-machine-windows-rdp/rdp-display-settings.png" alt-text="Screenshot of display tab of the Windows R D P client. The color depth setting is highlighted.":::
36+
- Under the **Experience** tab, set the connection speed to **Modem (56 kbps)**.
37+
38+
:::image type="content" source="./media/connect-virtual-machine-windows-rdp/rdp-experience-settings.png" alt-text="Screenshot of experience tab of the Windows R D P client. The connection speed setting are highlighted.":::
39+
40+
## Next Steps
41+
42+
- [As an educator, enabled RDP on Linux](how-to-enable-remote-desktop-linux.md#rdp-setup)
43+
- [As a student, stop the VM](how-to-use-lab.md#start-or-stop-the-vm)
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: How to connect to an Azure Lab Services VM | Microsoft Docs
3+
description: Learn how to connect to a VM in Azure Lab Services
4+
services: lab-services
5+
ms.topic: how-to
6+
ms.date: 02/1/2022
7+
---
8+
9+
# Connect to a lab VM
10+
11+
As a student, you'll need to [start](how-to-use-lab.md#start-or-stop-the-vm) and then connect to your lab VM to complete your lab work. How you connect to your VM will depend on the operating system (OS) of the machine your using and the OS of the VM your connecting to.
12+
13+
## Connect to a Windows lab VM
14+
15+
If connecting *to a Windows VM*, follow the instructions based on the type of OS you're using.
16+
17+
| Client OS | Instructions |
18+
| --------- | ------------ |
19+
| Windows | [Connect to a VM using RDP on Windows](connect-virtual-machine-windows-rdp.md). |
20+
| Mac | [Connect to a VM using RDP on a Mac](connect-virtual-machine-mac-remote-desktop.md). |
21+
| Chromebook | [Connect to a VM using RDP on a Chromebook](connect-virtual-machine-chromebook-remote-desktop.md). |
22+
23+
## Connect to a Linux lab VM
24+
25+
This section shows students how to connect to a Linux VM in a lab using secure shell protocol (SSH), remote desktop protocol (RDP), or X2Go.
26+
27+
SSH is configured automatically for Linux VMs. Both students and educators can SSH into Linux VMs without any extra setup. However, if students need to connect to using a GUI, the educators may need to do extra setup on the template VM.
28+
29+
> [!WARNING]
30+
> If you need to use [GNOME](https://www.gnome.org/) or [MATE](https://mate-desktop.org/) you should coordinate with your educator to ensure your lab VM is properly configured. For details, see [Using GNOME or MATE graphical desktops](how-to-enable-remote-desktop-linux.md#using-gnome-or-mate-graphical-desktops).
31+
32+
### Connect to a Linux lab VM Using RDP
33+
34+
An educator must first [enable remote desktop connection for Linux VMs](how-to-enable-remote-desktop-linux.md#enable-remote-desktop-connection-for-rdp) to allow connections to a Linux VM using RDP.
35+
36+
To connect *to a Linux VM using RDP*, follow the instructions based on the type of OS you're using.
37+
38+
| Client OS | Instructions |
39+
| --------- | ------------ |
40+
| Windows | [Connect to a VM using RDP on Windows](connect-virtual-machine-windows-rdp.md). |
41+
| Mac | [Connect to a VM using RDP on a Mac](connect-virtual-machine-mac-remote-desktop.md).|
42+
| Chromebook | [Connect to a VM using RDP on a Chromebook](connect-virtual-machine-chromebook-remote-desktop.md). |
43+
44+
### Connect to a Linux lab VM Using X2Go
45+
46+
Linux VMs can have X2Go enabled and a graphical desktop installed. For more information, see [X2Go Setup](how-to-enable-remote-desktop-linux.md#x2go-setup) and [Using GNOME or MATE graphical desktops](how-to-enable-remote-desktop-linux.md#using-gnome-or-mate-graphical-desktops).
47+
48+
For instructions to connect *to a Linux VM using X2Go*, see [Connect to a VM using X2Go](how-to-use-remote-desktop-linux-student.md#connect-to-the-student-vm-using-x2go).
49+
50+
### Connect to a Linux lab VM using SSH
51+
52+
By default Linux VMs have SSH installed. To connect *to a Linux VM using SSH*, do the following actions:
53+
54+
1. If using a Windows machine to connect to a Linux VM, first install an ssh client like [PuTTY](https://www.putty.org/) or enable [OpenSSH in Windows](/windows-server/administration/openssh/openssh_install_firstuse).
55+
1. [Start the VM](how-to-use-lab.md#start-or-stop-the-vm), if not done already.
56+
1. Once the VM is running, select **Connect**, which will show a dialog box that provides the SSH command string. The connection command will look like the following sample:
57+
58+
```bash
59+
ssh -p 12345 student@ml-lab-00000000-0000-0000-0000-000000000000.eastus2.cloudapp.azure.com
60+
```
61+
62+
1. Copy the command.
63+
1. Go to your command prompt or terminal, paste in the command, and then press **ENTER**.
64+
1. Enter the password to sign in to the lab VM.
65+
66+
## Next Steps
67+
68+
- [As a student, stop the VM](how-to-use-lab.md#start-or-stop-the-vm)

‎articles/lab-services/how-to-create-manage-template.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,21 @@
22
title: Manage a template of a lab in Azure Lab Services | Microsoft Docs
33
description: Learn how to create and manage a lab template in Azure Lab Services.
44
ms.topic: how-to
5-
ms.date: 11/24/2021
5+
ms.date: 01/31/2022
66
---
77

88
# Create and manage a template in Azure Lab Services
99

10-
A template in a lab is a base virtual machine image from which all users’ virtual machines are created. Set up the template virtual machine so that it is configured with exactly what you want to provide to the lab users. You can provide a name and description of the template that the lab users see. Then, you publish the template to make instances of the template VM available to your lab users. When you publish a template, Azure Lab Services creates VMs in the lab by using the template. The number of VMs created in this process is same as the maximum number of users allowed into the lab, which you can set in the usage policy of the lab. All virtual machines have the same configuration as the template.
10+
A template in a lab is a base VM image from which all users’ virtual machines are created. Modify the template VM so that it’s configured with exactly what you want to provide to the lab users. You can provide a name and description of the template that the lab users see. Then, you publish the template to make instances of the template VM available to your lab users. When you publish a template, Azure Lab Services creates VMs in the lab using the template. The number of VMs created during publish equals lab capacity. If using [Teams integration](lab-services-within-teams-overview.md), or [Canvas integration](lab-services-within-canvas-overview.md), the number of VMs created during publish equals the number of users in the lab. All virtual machines have the same configuration as the template.
1111

12-
This article describes how to create and manage a template virtual machine in a lab of Azure Lab Services.
12+
When you create a lab, the template VM is created but it’s not started. You can start it, connect to it, and install any pre-requisite software for the lab, and then publish it. When you publish the template VM, it’s automatically shut down for you if you haven’t done so. This article describes how to manage a template VM of a lab.
1313

1414
> [!NOTE]
15-
> When you create a lab, the template VM is created but it’s not started. You can start it, connect to it, and install any pre-requisite software for the lab, and then publish it. When you publish the template VM, it’s is automatically shut down for you if you haven’t done so.
16-
>
17-
> Template VMs incur **cost** when running, so ensure that the template VM is shutdown when you don’t need it to be running.
15+
> Template VMs incur cost when running, so ensure that the template VM is shutdown when you aren't using it.
1816
1917
## Set or update template title and description
2018

21-
Use the following steps to set title and description for the first time, and update them later.
19+
Use the following steps to set title and description for the lab. Educators and students will see the title and description on the tiles of the [My Virtual Machines](instructor-access-virtual-machines.md) page.
2220

2321
1. On the **Template** page, enter the new **title** for the lab.
2422
2. Enter the new **description** for the template. When you move the focus out of the text box, it's automatically saved.
@@ -29,8 +27,9 @@ Use the following steps to set title and description for the first time, and upd
2927

3028
Use the following steps to update a template VM.
3129

32-
1. Wait until the template VM is started, and then select **Connect to template** on the toolbar to connect to the template VM, and follow instructions. If it's a Windows machine, you will see an option to download the RDP file.
33-
1. Once you connect to the template and make changes, it will no longer have the same setup as the virtual machines last published to your users. Template changes will not be reflected on your users' existing virtual machines until after you publish again.
30+
1. On the **Template** page for the lab, select **Start template** on the toolbar.
31+
1. Wait until the template VM is started, and then select **Connect to template** on the toolbar to connect to the template VM.
32+
1. Once you connect to the template and make changes, it will no longer have the same setup as the virtual machines last published to your users. Template changes won’t be reflected on your students' existing virtual machines until after you publish again.
3433

3534
![Connect to the template VM](./media/how-to-create-manage-template/connect-template-vm.png)
3635

@@ -48,14 +47,15 @@ In this step, you publish the template VM. When you publish the template VM, Azu
4847
![Publish template button](./media/how-to-create-manage-template/template-page-publish-button.png)
4948

5049
> [!WARNING]
51-
> Once you publish, you can't unpublish.
50+
> Publishing is a permanent action. It can't be undone.
51+
5252
2. On the **Publish template** page, enter the number of virtual machines you want to create in the lab, and then select **Publish**.
5353

5454
![Publish template - number of VMs](./media/how-to-create-manage-template/publish-template-number-vms.png)
5555
3. You see the **status of publishing** the template on page. This process can take up to an hour.
5656

5757
![Publish template - progress](./media/how-to-create-manage-template/publish-template-progress.png)
58-
4. Wait until the publishing is complete and then switch to the **Virtual machines pool** page by selecting **Virtual machines** on the left menu or by selecting **Virtual machines** tile. Confirm that you see virtual machines that are in **Unassigned** state. These VMs are not assigned to students yet. They should be in **Stopped** state. You can start a student VM, connect to the VM, stop the VM, and delete the VM on this page. You can start them in this page or let your students start the VMs.
58+
4. Wait until the publishing is complete and then switch to the **Virtual machines pool** page by selecting **Virtual machines** on the left menu or by selecting **Virtual machines** tile. 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. You can start a student VM, connect to the VM, stop the VM, and delete the VM on this page. You can start them in this page or let your students start the VMs.
5959

6060
![Virtual machines in stopped state](./media/how-to-create-manage-template/virtual-machines-stopped.png)
6161

‎articles/lab-services/how-to-enable-remote-desktop-linux.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,17 @@ When a lab is created from a **Linux** image, **SSH** (Secure Shell) access is a
1111

1212
You can also connect to a Linux VM using a **GUI** (graphical user interface). This article shows the steps to set up GUI connections using **Remote Desktop Protocol (RDP)** and **X2Go** .
1313

14-
In some cases, such as with Ubuntu LTS 18.04, X2Go provides better performance. If you use RDP and notice latency when interacting with the graphical desktop environment, consider trying X2Go since it may improve performance.
15-
1614
> [!NOTE]
1715
> Linux uses an open-source version of RDP called, [Xrdp](https://en.wikipedia.org/wiki/Xrdp). For simplicity, we use the term RDP throughout this article.
1816
17+
In some cases, such as with Ubuntu LTS 18.04, X2Go provides better performance. If you use RDP and notice latency when interacting with the graphical desktop environment, consider trying X2Go since it may improve performance.
18+
1919
> [!IMPORTANT]
2020
> Some marketplace images already have a graphical desktop environment and remote desktop server installed. For example, the [Data Science Virtual Machine for Linux (Ubuntu)](https://azuremarketplace.microsoft.com/marketplace/apps/microsoft-dsvm.ubuntu-1804) already has [XFCE and X2Go Server installed and configured to accept client connections](../machine-learning/data-science-virtual-machine/dsvm-ubuntu-intro.md#x2go).
2121
22+
> [!WARNING]
23+
> If you need to use [GNOME](https://www.gnome.org/) or [MATE](https://mate-desktop.org/), ensure your lab VM is properly configured. There is a known networking conflict that can occur with the Azure Linux Agent which is needed for the VMs to work properly in Azure Lab Services. Instead, we recommend using a different graphical desktop environment, such as [XFCE](https://www.xfce.org/).
24+
2225
## X2Go Setup
2326

2427
To use X2Go, the instructor must:
@@ -31,6 +34,8 @@ X2Go uses the same port that is already enabled for SSH. As a result, no extra
3134
> [!NOTE]
3235
> In some cases, such as with Ubuntu LTS 18.04, X2Go provides better performance. If you use RDP and notice latency when interacting with the graphical desktop environment, consider trying X2Go since it may improve performance.
3336
37+
### Install X2Go Server on the template VM
38+
3439
To set up X2Go on a template VM, first follow instructions to [update the template VM](how-to-create-manage-template.md#update-a-template-vm).
3540

3641
For optimal performance, we typically recommend using the XFCE graphical desktop and for users to connect to the desktop using X2Go. To set up XFCE with X2Go on Ubuntu, see [Install and configure X2Go](https://aka.ms/azlabs/scripts/LinuxDesktop-Xfce).
@@ -49,7 +54,7 @@ To use RDP, the instructor must:
4954
- Install the RDP remote desktop server.
5055
- Install a Linux graphical desktop environment.
5156

52-
### Enable remote desktop connection for RDP
57+
### Enable RDP connection in lab
5358

5459
This step is needed so Azure Lab Services opens port 3389 for RDP to the Linux VMs. By default, Linux VMs only have the SSH port opened.
5560

@@ -58,9 +63,7 @@ This step is needed so Azure Lab Services opens port 3389 for RDP to the Linux V
5863
1. On the **Enabling Remote Desktop Connection** message box, select **Continue with Remote Desktop**.
5964
:::image type="content" source="./media/how-to-enable-remote-desktop-linux/enabling-remote-desktop-connection-dialog.png" alt-text="Screenshot that shows the Enable Remote Desktop Connection confirmation window.":::
6065

61-
### Install RDP
62-
63-
To set up X2Go on a template VM, first follow instructions to [update the template VM](how-to-create-manage-template.md#update-a-template-vm).
66+
### Install RDP on the template VM
6467

6568
If you want to set up the GNOME with RDP on Ubuntu, see [Install and configure GNOME/RDP](https://aka.ms/azlabs/scripts/LinuxDesktop-GnomeMate). These instructions handle known issues with that configuration.
6669

@@ -90,4 +93,4 @@ In some cases, such as with Ubuntu LTS 18.04, X2Go provides better performance.
9093

9194
## Next steps
9295

93-
After an instructor sets up either RDP or X2Go on their template VM, they can [publish the template VM](how-to-create-manage-template.md#publish-the-template-vm).
96+
After an educator configures either RDP or X2Go on their template VM, they can [publish the template VM](how-to-create-manage-template.md#publish-the-template-vm).

0 commit comments

Comments
 (0)
Please sign in to comment.