在远程主机上将 Visual Studio Code 与安全外壳（SSH）配合使用

重要

这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。

Visual Studio Code 可与 Azure Sphere SDK 配合使用，通过安全外壳（SSH）在远程主机上生成和调试代码。支持两种方案：

不支持第三种方案（本地计算机和设备上的远程计算机上的代码）。

设置本地计算机

下载并安装 Visual Studio Code。
安装适用于 Windows 或 Linux 的 Azure Sphere SDK。
通过在 Visual Studio Code 扩展面板中搜索 Azure Sphere 并单击“安装”来安装 Azure Sphere 扩展。

提示

有两 Azure Sphere 个扩展，其中任一扩展都将安装 ：UI 组件的 Azure Sphere UI 和 工作区组件的 Azure Sphere 。
通过在 Visual Studio Code 扩展面板中搜索 Remote-SSH 并单击“ 安装 ”按钮来安装 Remote-SSH 扩展。

通过 USB 将设备连接到本地计算机。
如果远程计算机上还没有项目，则可以克隆示例存储库，或者从 Microsoft示例浏览器获取单个项目。
在本地打开 Visual Studio Code。
仅第一次：从视图>命令面板>远程 SSH 打开 Visual Studio Code：添加新的 SSH 主机，并按提示输入 SSH 主机信息。（默认情况下，名为 config 的文件将写入主目录中的 .ssh 目录。如果本地计算机是 Windows，这有时会导致权限问题。可能需要将文件移动到另一个目录，并在文件>首选项>设置>扩展>远程 - SSH：配置文件中指定绝对路径。

通过执行 Visual Studio Code 命令视图>命令面板>Remote-SSH 连接到远程计算机：连接到主机（）。Shift+Ctrl+P
通过在 Visual Studio Code 扩展面板中搜索 Azure Sphere 并单击“ 在 SSH 中安装：[远程名称] ”按钮，将 Azure Sphere 扩展安装到远程计算机。安装后，可能需要重启 Visual Studio Code 并重新连接到远程计算机。

提示

若要检查扩展是否已正确安装在远程计算机上，请清除扩展面板中的搜索框，并确保 Azure Sphere 扩展显示在 SSH：[远程名称] - INSTALLED 视图中。
使用“文件>打开文件夹”或“文件>打开”工作区打开项目文件夹或工作区。

按 F5 生成和调试项目。如果项目以前尚未生成，或者文件已更改并重新生成，Visual Studio Code 将在调试开始之前生成项目。
等待几秒钟，Visual Studio Code 生成应用程序、创建映像包、将其部署到开发板，并在调试模式下启动它。在此过程中， 你将在“输出 ”窗格中看到状态更新。

首先，CMake 确定是否需要生成应用程序。如果是这样，焦点将移动到输出窗口，该窗口显示 CMake/Build 的输出。

接下来，“ 输出 ”窗格显示将映像包部署到设备时的结果。最后，调试控制台接收焦点并显示调试器输出。

使用 Visual Studio Code 调试器设置断点、暂停、单步执行、单步执行、重启或停止应用程序。

通过 USB 将设备连接到远程计算机。
如果远程计算机上还没有项目，则可以克隆示例存储库，或者从 Microsoft示例浏览器获取单个项目。
在本地打开 Visual Studio Code。
仅第一次：从视图>命令面板>远程 SSH 打开 Visual Studio Code：添加新的 SSH 主机，并按提示输入 SSH 主机信息。（默认情况下，名为 config 的文件将写入主目录中的 .ssh 目录。如果本地计算机是 Windows，这有时会导致权限问题。可能需要将文件移动到另一个目录，并在文件>首选项>设置>扩展>远程 - SSH：配置文件中指定绝对路径。

通过执行 VS Code 命令视图>命令面板>远程 SSH 连接到远程计算机：连接到主机（）。Shift+Ctrl+P
通过执行 VS Code 命令视图>命令面板>首选项添加远程设置：打开远程设置，并将以下字段添加到 JSON 对象（如果它是空文件，则需要将此文件包装到）：{}
```
    "remote.extensionKind": {
        "ms-vscode.azure-sphere-tools-ui": [
            "workspace"
        ]
    }
```
可以改为将此设置添加到用户/工作区设置，具体取决于项目和团队的设置。
通过在 Visual Studio Code 扩展面板中搜索 Azure Sphere 并单击“ 在 SSH 中安装：[远程名称] ”按钮，将 Azure Sphere 扩展安装到远程计算机。安装后，可能需要重启 Visual Studio Code 并重新连接到远程计算机。

提示

若要检查扩展是否已正确安装在远程计算机上，请清除扩展面板中的搜索框，并确保 Azure Sphere 扩展显示在 SSH：[远程名称] - INSTALLED 视图中。
使用“>文件打开文件夹”或“文件>打开工作区”打开项目文件夹或工作区。

按 F5 生成和调试项目。如果项目以前尚未生成，或者文件已更改并重新生成，Visual Studio Code 将在调试开始之前生成项目。
等待几秒钟，Visual Studio Code 生成应用程序、创建映像包、将其部署到开发板，并在调试模式下启动它。在此过程中， 你将在“输出 ”窗格中看到状态更新。

首先，CMake 确定是否需要生成应用程序。如果是这样，焦点将移动到输出窗口，该窗口显示 CMake/Build 的输出。

接下来，“ 输出 ”窗格显示将映像包部署到设备时的结果。最后，调试控制台接收焦点并显示调试器输出。

使用 Visual Studio Code 调试器设置断点、暂停、单步执行、单步执行、重启或停止应用程序。

若要结束远程调试会话，请选择“ 文件>关闭远程连接”。