These are just a few examples of when you may want to use port tunneling with your web projects. This feature depends on a private preview which you must sign up for.<\/p>\n
To get started follow these steps.<\/p>\n
- \n
- Sign up for the private preview of port tunneling in Visual Studio.<\/li>\n
- Download the 17.3 Preview 1.1 Visual Studio update.<\/li>\n
- Enable the preview feature in Visual Studio.<\/li>\n
- Configure your project.<\/li>\n<\/ol>\n
1: Sign up for the private preview of port tunneling in Visual Studio<\/h2>\n
To get started with the, sign up for the private preview at the link below. You should sign in with the same account that you are using in Visual Studio. Port tunneling will not work without signing up for this preview.<\/p>\n
https:\/\/aka.ms\/tunnels-signup<\/a><\/div><\/p>\nAfter signing up, download the Visual Studio preview and enable the feature in Visual Studio.<\/p>\n
2: Download the latest preview Visual Studio update<\/h2>\n
We added support for this preview feature in Visual Studio 2022 17.3 Preview 1.1, but you should use the latest current preview available. You can download that at the link below.<\/p>\n
https:\/\/visualstudio.microsoft.com\/vs\/preview\/ <\/a><\/div><\/p>\n3: Enable the preview in Visual Studio<\/h2>\n
In Visual Studio go to Tool > Options > Preview Features<\/em> and check the Enable port tunneling for Web Applications<\/em><\/strong> option.<\/p>\n
![\"vs](\"https:\/\/devblogs.microsoft.com\/visualstudio\/wp-content\/uploads\/sites\/4\/2022\/05\/01-preview-features-min.png\")
<\/a><\/p>\n4: Configure your project<\/h2>\n
When developing ASP.NET Core projects in Visual Studio, the settings to launch your application are stored in the file at Properties\/launchSettings.json<\/em>. This file contains one, or more, launch profiles for your web app. In order to enable the tunnel to be created, or connected, when you run your app, add the property \u201ccreateTunnel\u201d: true in the launch profile. For example, below is a full launchSettings.json<\/em> file for an ASP.NET Core web project.<\/p>\n
{\r\n \"iisSettings\": {\r\n \"windowsAuthentication\": false,\r\n \"anonymousAuthentication\": true,\r\n \"iisExpress\": {\r\n \"applicationUrl\": \"http:\/\/localhost:28981\",\r\n \"sslPort\": 44342\r\n }\r\n },\r\n \"profiles\": {\r\n \"MyWebApp\": {\r\n \"commandName\": \"Project\",\r\n \"dotnetRunMessages\": true,\r\n \"launchBrowser\": true,\r\n \"applicationUrl\": \"https:\/\/localhost:7130;http:\/\/localhost:5130\",\r\n \"environmentVariables\": {\r\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\r\n },\r\n \"createTunnel\": true, \r\n \"tunnelAuthentication\": public<\/strong>\r\n },\r\n \"IIS Express\": {\r\n \"commandName\": \"IISExpress\",\r\n \"launchBrowser\": true,\r\n \"environmentVariables\": {\r\n \"ASPNETCORE_ENVIRONMENT\": \"Development\"\r\n }\r\n }\r\n }\r\n}<\/pre>\nThe property that needs to be added is in bold above. When you run, or debug, your application in Visual Studio. Instead of launching the localhost URL, the tunnel URL will be launched, which will then connect to the localhost endpoint. Take a look at the animation below.<\/p>\n
Note: when this feature was originally implemented the access was set to public by default. In more recent updates, we default to private access, where only the signed in user has access to that tunnel. You can control the access with the property “tunnelAuthentication”, which can be set to “private”, “org” or “public”. For org access, the user accessing that tunnel must have access to the organization in which the tunnel was created.<\/span><\/strong><\/p>\n
![\"run](\"https:\/\/devblogs.microsoft.com\/visualstudio\/wp-content\/uploads\/sites\/4\/2022\/05\/02-run-in-vs-with-tunnel-min.gif\")
<\/a><\/p>\n![\"qr](\"https:\/\/devblogs.microsoft.com\/visualstudio\/wp-content\/uploads\/sites\/4\/2022\/05\/03-qr-code-min.png\")
<\/a><\/p>\n![\"preview](\"https:\/\/devblogs.microsoft.com\/visualstudio\/wp-content\/uploads\/sites\/4\/2022\/05\/05-tools-options-dev-tunnels.png\")
<\/a><\/p>\n![\"user](\"https:\/\/devblogs.microsoft.com\/visualstudio\/wp-content\/uploads\/sites\/4\/2022\/05\/04-user-acct-error-min.png\")
<\/a><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n