Dev Tunnels

https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/
Admin
Dev Tunnels is a Microsoft service that allows developers to securely expose local web services to...
Tokens:4,198
Snippets:82
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Diagnostic Examples

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Practical examples for checking cluster latency and starting a local diagnostic server.

```bash
devtunnel clusters --ping
```

```bash
devtunnel echo http --port 8080 --interface 127.0.0.1
```

--------------------------------

### Start hosting a dev tunnel

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Initiates hosting for a configured dev tunnel.

```powershell
devtunnel host
```

--------------------------------

### Install and verify devtunnel CLI with PowerShell

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started

Downloads the Windows x64 executable and displays the help menu to verify installation.

```PowerShell
Invoke-WebRequest -Uri https://aka.ms/TunnelsCliDownload/win-x64 -OutFile devtunnel.exe
.\devtunnel.exe -h
```

--------------------------------

### Install Dev Tunnel CLI

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started

Use this command to download and install the Dev Tunnel CLI on your system.

```bash
curl -sL https://aka.ms/DevTunnelCliInstall | bash
```

--------------------------------

### Host a Local Port

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started

Start a local server and expose it to the internet via a dev tunnel.

```bash
# Start a http server on port 8080
devtunnel echo http -p 8080
# Tunnel port 8080
devtunnel host -p 8080
```

--------------------------------

### Install devtunnel CLI with winget

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started

Installs the latest version of the devtunnel CLI on Windows using the winget package manager.

```PowerShell
winget install Microsoft.devtunnel
```

--------------------------------

### Host a temporary dev tunnel

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Basic command to start a temporary tunnel for a local server.

```bash
devtunnel host -p 3000
```

--------------------------------

### Example Host Output

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started

The console output after successfully running the host command, displaying tunnel IDs and access URLs.

```text
Connecting to host tunnel relay wss://usw2-data.rel.tunnels.api.visualstudio.com/api/v1/Host/Connect/<tunnel_id>
Hosting port 8080 at https://<tunnel_id>.usw2.devtunnels.ms:8080/, https://<tunnel_id>-8080.usw2.devtunnels.ms/ and inspect it at https:/<tunnel_id>-8080-inspect.usw2.devtunnels.ms/
Ready to accept connections for tunnel: <tunnel_id>
```

--------------------------------

### View successful client connection output

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Example output displayed after successfully connecting to a tunnel via the CLI.

```PowerShell
Connected to tunnel: l3rs99qw
SSH: Forwarding from 127.0.0.1:3000 to host port 3000.
SSH: Forwarding from [::1]:3000 to host port 3000.
```

--------------------------------

### Manage devtunnel CLI with Homebrew

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started

Commands for installing, removing, upgrading, and listing versions of the devtunnel CLI using Homebrew.

```Bash
brew install --cask devtunnel
```

```Bash
brew uninstall --cask devtunnel
```

```Bash
brew upgrade --cask devtunnel
```

```Bash
brew list --versions devtunnel
```

```Bash
brew switch --cask devtunnel <older_version>
```

--------------------------------

### Host an existing dev tunnel

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Starts a previously configured tunnel using its unique identifier.

```bash
devtunnel host TUNNELID
```

--------------------------------

### View dev tunnel host output

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Example output displayed after running the devtunnel host command.

```PowerShell
Hosting port 3000 at https://l3rs99qw-3000.usw2.devtunnels.ms/
```

--------------------------------

### Upgrade devtunnel CLI with winget

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started

Updates the existing devtunnel CLI installation to the latest version available via winget.

```PowerShell
winget upgrade Microsoft.devtunnel
```

--------------------------------

### Show dev tunnel port details

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Displays the configuration details for a specific port.

```bash
devtunnel port show TUNNELID -p 3000
```

--------------------------------

### Troubleshooting Commands

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Commands used to verify CLI version and enable verbose logging for debugging.

```bash
devtunnel --version
```

```bash
--verbose
```

--------------------------------

### Create access control entries

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Configures various access control settings for tunnels and ports.

```bash
devtunnel access create TUNNELID --anonymous
```

```bash
devtunnel access create TUNNELID --anonymous --expiration 4h
```

```bash
devtunnel access create TUNNELID --port 3000 --anonymous
```

```bash
devtunnel access create TUNNELID --tenant
```

```bash
devtunnel access create TUNNELID --org ORG
```

--------------------------------

### Host a dev tunnel for multiple ports

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Exposes multiple local ports through a single tunnel instance.

```bash
devtunnel host -p 3000 5000
```

--------------------------------

### Diagnostic Cluster and Echo Commands

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Commands for listing service clusters and running diagnostic echo servers.

```bash
devtunnel clusters
```

```bash
devtunnel echo
```

```bash
devtunnel ping
```

--------------------------------

### Host a dev tunnel with custom expiration

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Sets a specific duration for the tunnel to remain active, between 1 hour and 30 days.

```bash
devtunnel host -p 8000 --expiration 2d
```

--------------------------------

### Host a dev tunnel with HTTPS protocol

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Configures the tunnel to use the HTTPS protocol for the specified port.

```bash
devtunnel host -p 8443 --protocol https
```

--------------------------------

### Login to Dev Tunnels

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started

Authenticate using a Microsoft Entra ID, Microsoft, or GitHub account before hosting tunnels.

```bash
devtunnel user login
```

--------------------------------

### Host a dev tunnel with anonymous access

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Enables public access to the tunnel without requiring authentication.

```bash
devtunnel host -p 3000 --allow-anonymous
```

--------------------------------

### List dev tunnel ports

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Lists the current ports configured for a specific tunnel.

```bash
devtunnel port list TUNNELID
```

--------------------------------

### Connect to a dev tunnel via CLI

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Command to forward connections from a local port to a dev tunnel port.

```PowerShell
devtunnel connect TUNNELID
```

--------------------------------

### Create a dev tunnel port

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Adds a port with the specified protocol to a dev tunnel.

```bash
devtunnel port create -p 3000 --protocol http
```

--------------------------------

### Issue a dev tunnel access token

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Generates a connect access token for sharing temporary access.

```bash
devtunnel token TUNNELID --scopes connect
```

--------------------------------

### devtunnel user show

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Displays the current authentication status of the user.

```APIDOC
## devtunnel user show

### Description
Displays the current login status for the dev tunnel CLI.
```

--------------------------------

### devtunnel user login

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Authenticates the user with a Microsoft or GitHub account. Supports device code login for non-interactive environments.

```APIDOC
## devtunnel user login

### Description
Logs the user into the dev tunnel service using a Microsoft or GitHub account. The resulting token is cached securely.

### Parameters
- **-g** (flag) - Optional - Use GitHub account for authentication.
- **-d** (flag) - Optional - Use device code login flow.
```

--------------------------------

### devtunnel host

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

The devtunnel host command is used to host a dev tunnel on the local system, making a local server accessible via the internet.

```APIDOC
## devtunnel host

### Description
Hosts a dev tunnel for a local server. If no ID is provided, a temporary tunnel is created.

### Parameters
- **-p [ports]** (integer) - Optional - Local port(s) to expose.
- **--allow-anonymous** (flag) - Optional - Enables anonymous client access.
- **--protocol** (string) - Optional - Protocol to use (e.g., https).
- **--expiration** (string) - Optional - Custom expiration time (1h to 30d).
- **TUNNELID** (string) - Optional - ID of an existing dev tunnel to host.
```

--------------------------------

### Update a dev tunnel port

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Updates the description property of an existing dev tunnel port.

```bash
devtunnel port update -p 3000 --description 'frontend port'
```

--------------------------------

### Authorize Web Requests with Tunnel Tokens

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/security

Use the X-Tunnel-Authorization header to provide a token for non-interactive clients, bypassing the need for anonymous access.

```HTTP
X-Tunnel-Authorization: tunnel <TOKEN>
```

--------------------------------

### Set and Unset Default Dev Tunnel

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Commands to explicitly configure or clear the local cache of the last-used dev tunnel.

```bash
devtunnel set
```

```bash
devtunnel unset
```

--------------------------------

### devtunnel user logout

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Clears the cached authentication token from the system secure key chain.

```APIDOC
## devtunnel user logout

### Description
Logs the user out of the CLI by clearing the cached authentication token.
```

--------------------------------

### Delete a dev tunnel port

Source: https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/cli-commands

Removes a port from the dev tunnel configuration.

```bash
devtunnel port delete -p 3000
```
Tokens:
Raw