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
Copy file name to clipboardExpand all lines: articles/dev-box/how-to-setup-dev-tunnels.md
+14-11Lines changed: 14 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ ms.author: rosemalcolm
9
9
ms.reviewer: rosemalcolm
10
10
---
11
11
12
-
# Setup & Connect to your Dev Box via VS Code
12
+
# Setup and Connect to your Dev Box via VS Code
13
13
14
14
Azure Dev Box makes it easy to provision and manage cloud-based development environments. This article shows you how to set up and connect to your Azure Dev Box using Visual Studio Code. You learn how to register for the Open in VS Code feature, install the required extension, enable secure tunnels, and connect remotely for a seamless development experience. Follow these steps to get started quickly and work efficiently from anywhere.
15
15
@@ -31,55 +31,55 @@ Steps to connect to Dev Box with Open in VS Code Feature
31
31
32
32
You can skip this step if you already have a Dev Box.
33
33
34
-
Sign in to [<u>Developer Portal</u>](https://devportal.microsoft.com/) with your Microsoft account, and create a Dev Box in the project you have access to.
34
+
Sign in to [Developer Portal](https://devportal.microsoft.com/) with your Microsoft account, and create a Dev Box in the project you have access to.
35
35
36
36
1. Install VS Code Extension
37
37
38
-
Search for **Dev Box** in the VS Code Extension Marketplace and install the latest version (2.0.0 as of 05/15/2025) in your **local** VS Code - **NOT** in the Dev Box you want to connect to.
38
+
Search for **Dev Box** in the VS Code Extension Marketplace and install the latest version (2.0.0 as of May 15, 2025) in your **local** VS Code - **NOT** in the Dev Box you want to connect to.
39
39
40
-
:::image type="content" source="media/how-to-setup-dev-tunnels/image1.png" alt-text="Screenshot of the Dev Box extension in the VS Code Extension Marketplace.":::
40
+
:::image type="content" source="media/how-to-setup-dev-tunnels/dev-tunnels-dev-box-extension.png" alt-text="Screenshot of the Dev Box extension in the VS Code Extension Marketplace.":::
41
41
42
42
1. Sign in to Dev Box Extension
43
43
44
44
Select the Dev Box icon in the left sidebar, and select Sign In.
45
45
46
-
:::image type="content" source="media/how-to-setup-dev-tunnels/image2.png" alt-text="Screenshot of the Dev Box extension sign-in screen in VS Code.":::
46
+
:::image type="content" source="media/how-to-setup-dev-tunnels/dev-tunnels-sign-in-extension.png" alt-text="Screenshot of the Dev Box extension sign-in screen in VS Code.":::
47
47
48
48
1. Create and Enable Dev Box Tunnel
49
49
50
50
After signing in, you'll see all the projects you have access to. Choose the project where you created the Dev Box, and select the Dev Box you want to connect to.
51
51
52
52
If you see **No Tunnel** in the description, you need to manually create a tunnel resource first.
53
53
54
-
:::image type="content" source="media/how-to-setup-dev-tunnels/image3.png" alt-text="Screenshot of the Dev Box extension showing the option to create a tunnel.":::
54
+
:::image type="content" source="media/how-to-setup-dev-tunnels/dev-tunnels-create-tunnel.png" alt-text="Screenshot of the Dev Box extension showing the option to create a tunnel.":::
55
55
56
56
Before enabling the tunnel, you **MUST** log into the Dev Box at least once using any client (for example, browser, Windows App, Remote Desktop client). This step is **mandatory** after each shutdown and restart to establish the required user session for setting up the tunnel. Once logged in, you can disconnect from the Dev Box.
57
57
58
58
You **DO NOT** need to sign-in every time you enable or connect to the tunnel—only after a shutdown or restart.
59
59
60
-
:::image type="content" source="media/how-to-setup-dev-tunnels/image4.png" alt-text="Screenshot of enabling the tunnel in the Dev Box extension.":::
60
+
:::image type="content" source="media/how-to-setup-dev-tunnels/dev-tunnels-enable-tunnel.png" alt-text="Screenshot of enabling the tunnel in the Dev Box extension.":::
61
61
62
62
Then, you can enable the tunnel. This process might take up to 1-3 minutes, as it installs VS Code on the Dev Box (if not already installed) and set up the tunnel.
63
63
64
64
1. Connect to the Dev Box in VS Code
65
65
66
66
Once everything is set up, you can open the Dev Box in VS Code by clicking the **Connect to Tunnel** button.
67
67
68
-
:::image type="content" source="media/how-to-setup-dev-tunnels/image5.png" alt-text="Screenshot of the Connect to Tunnel button in the Dev Box extension.":::
68
+
:::image type="content" source="media/how-to-setup-dev-tunnels/dev-tunnels-connect-tunnnel.png" alt-text="Screenshot of the Connect to Tunnel button in the Dev Box extension.":::
69
69
70
70
1. Dev Box Remote experience in VS Code
71
71
72
72
You can open any folder or workspace on the remote Dev Box using **File > Open File/Folder/Workspace** just as you would locally!
73
73
74
74
If you have WSL environment on the Dev Box, you can connect to it using **Remote Explorer**.
75
75
76
-
:::image type="content" source="media/how-to-setup-dev-tunnels/image6.png" alt-text="Screenshot of the Remote Explorer in VS Code showing WSL targets.":::
76
+
:::image type="content" source="media/how-to-setup-dev-tunnels/dev-tunnels-wsl-targets.png" alt-text="Screenshot of the Remote Explorer in VS Code showing WSL targets.":::
77
77
78
78
Select WSL targets from the dropdown and all the WSL distributions are listed. You can open any WSL distribution in the current or new window.
79
79
80
-
:::image type="content" source="media/how-to-setup-dev-tunnels/image7.png" alt-text="Screenshot of a WSL distribution terminal in VS Code.":::
80
+
:::image type="content" source="media/how-to-setup-dev-tunnels/dev-tunnels-ubuntu.png" alt-text="Screenshot of a WSL distribution terminal in VS Code.":::
81
81
82
-
For more information on the WSL development experience, refer to the [<u>Remote - WSL</u>](https://code.visualstudio.com/docs/remote/wsl) and [<u>Set up a WSL development environment</u>](https://learn.microsoft.com/en-us/windows/wsl/setup/environment) documentation.
82
+
For more information on the WSL development experience, see the [Remote - WSL](https://code.visualstudio.com/docs/remote/wsl) and [Set up a WSL development environment](https://learn.microsoft.com/en-us/windows/wsl/setup/environment) documentation.
83
83
84
84
FAQ
85
85
@@ -90,3 +90,6 @@ FAQ
90
90
1. Why can't I connect to the Dev Box even if the tunnel is enabled?
91
91
92
92
> Refresh the Dev Box extension explorer view with the button on the top right corner to check the latest status of the tunnel. If the tunnel is enabled, but you still can't connect, try disabling the tunnel, logging into the Dev Box, and then re-enabling the tunnel.
0 commit comments