使用 Visual Studio 2022 开发和调试适用于 Azure IoT Edge 的模块

1. 在解决方案资源管理器中，右键单击主项目名称，然后选择“设置 IoT Edge 运行时版本”。

   

2. 使用下拉菜单选择 IoT Edge 设备正在运行的运行时版本，然后选择“确定”以保存更改。 如果未进行更改，选择“取消”可退出。

   目前该扩展不包括针对最新运行时版本的选择。 如果要设置高于 1.2 的运行时版本，请打开 deployment.debug.template.json 部署清单文件。 更改系统运行时模块映像 edgeAgent 和 edgeHub 的运行时版本。 例如，如果要使用 IoT Edge 运行时版本 1.4，请更改部署清单文件中的以下行：

   "systemModules": {
      "edgeAgent": {
       //...
         "image": "mcr.microsoft.com/azureiotedge-agent:1.4"
       //...
      "edgeHub": {
      //...
         "image": "mcr.microsoft.com/azureiotedge-hub:1.4",
      //...
   

3. 如果更改了版本，请右键单击项目名称并选择“为 IoT Edge 生成部署”以重新生成部署清单。 该操作会基于部署模板生成部署清单，该清单将显示在 Visual Studio 项目的 “config” 文件夹中。

1. 打开 deployment.debug.template.json 部署清单文件。 部署清单是一个 JSON 文档，用于描述要在目标 IoT Edge 设备上配置的模块。

2. 更改系统运行时模块映像 edgeAgent 和 edgeHub 的运行时版本。 例如，如果要使用 IoT Edge 运行时版本 1.4，请更改部署清单文件中的以下行：

   "systemModules": {
       "edgeAgent": {
       //...
           "image": "mcr.microsoft.com/azureiotedge-agent:1.4",
       //...
       "edgeHub": {
       //...
           "image": "mcr.microsoft.com/azureiotedge-hub:1.4",
       //...
   

使用模拟器进行调试

Azure IoT EdgeHub 开发工具提供本地开发和调试体验。 该工具可在没有 IoT Edge 运行时的情况下帮助启动 IoT Edge 模块，以便可在本地创建、开发、测试、运行和调试 IoT Edge 模块和解决方案。 无需将映像推送到容器注册表并将其部署到设备进行测试。

有关详细信息，请参阅 Azure IoT EdgeHub 开发工具。

若要初始化 Visual Studio 中的工具，请执行以下操作：

1. 从 Azure 门户或 Azure CLI 中检索 IoT Edge 设备（在 IoT 中心找到）的连接字符串。

   如果使用 CLI 检索连接字符串，请使用此命令，将“[device_id]”和“[hub_name]”替换为自己的值：

   az iot hub device-identity connection-string show --device-id [device_id] --hub-name [hub_name]
   

2. 从 Visual Studio 的“工具”菜单中，选择“Azure IoT Edge Tools”>“设置 IoT Edge 模拟器”。

3. 粘贴连接字符串，然后选择“确定”。

生成和调试单个模块

通常，需要先测试和调试每个模块，然后再在具有多个模块的整个解决方案中运行此模块。 使用 IoT Edge 模拟器工具，能够独立地运行单个模块，并通过端口 53000 发送消息。

1. 在解决方案资源管理器中选择并突出显示模块项目文件夹（例如 IotEdgeModule1）。 将自定义模块设置为启动项目。 在菜单中选择“项目”>“设为启动项目”。

2. 按 F5 或选择“运行”工具栏按钮，启动单个模块的 IoT Edge 模拟器。 初次运行可能需要 10 到 20 秒。

   

3. 如果模块已成功初始化，应该会看到一个 .NET Core 控制台应用窗口。

4. 设置用于检查模块的断点。

   • 如果在 C# 环境中开发，请在 ModuleBackgroundService.cs 的 PipeMessage() 函数中设置断点。
   • 如果是 C 环境，在“main.c”的 InputQueue1Callback() 函数中设置断点。

5. 可通过发送消息来测试模块。 调试单个模块时，模拟器会侦听默认端口 53000 以获取消息。 若要向模块发送消息，请通过 Git Bash 或 WSL Bash 等命令 shell 运行以下 curl 命令。

   curl --header "Content-Type: application/json" --request POST --data '{"inputName": "input1","data":"hello world"}' http://localhost:53000/api/v1/messages
   

   如果收到错误“URL 中的右大括号/括号不匹配”，请尝试以下命令：

   curl --header "Content-Type: application/json" --request POST --data "{\"inputName\": \"input1\", \"data\", \"hello world\"}"  http://localhost:53000/api/v1/messages
   

   

   应触发断点。 可以在 Visual Studio 的“局部变量”窗口中监视变量，在调试器运行时可以找到该窗口。 转到“调试”>“窗口”>“局部变量”。

   在 Bash 或 shell 中，应会看到 {"message":"accepted"} 确认。

   在 .NET 控制台中，应会看到：

   IoT Hub module client initialized.
   Received message: 1, Body: [hello world]
   

   提示

   还可以使用 PostMan 或其他 API 工具（而非 curl）发送消息。

6. 按 Ctrl+F5 或选择“停止”按钮可停止调试 。

生成和调试多个模块

开发完单个模块之后，需要运行并调试具有多个模块的整个解决方案。 使用 IoT Edge模拟器工具，可以运行部署清单中定义的所有模块，包括用于消息路由的模拟 edgeHub。 本例将运行两个自定义模块和温度传感器模拟模块。 来自模拟温度传感器模块的消息会路由到每个自定义模块。

1. 在“解决方案资源管理器”中，右键单击主项目文件夹，将第二个模块添加到解决方案中。 在菜单中选择“添加”>“新 IoT Edge 模块”。

   

2. 在 Add module 窗口中，为新模块命名，并将存储库 URL 的 localhost:5000 部分替换为 Azure 容器注册表登录服务器，就像你之前所做的那样。

3. 打开文件 deployment.debug.template.json 会看到新模块已添加到“模块”部分。 EdgeHub 的“路由”部分也已添加新路由，以便将消息从新模块发送到 IoT 中心。 若要将数据从模拟温度传感器发送到新模块，请添加另一个带有 JSON 行的路由。 将 <NewModuleName>（在两个位置）替换为你自己的模块名称。

   "sensorTo<NewModuleName>": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/<NewModuleName>/inputs/input1\")"
   

4. 右键单击主项目（例如 AzureIotEdgeApp1）并选择“设为启动项目”。 通过将主项目设置为启动项目，会让系统运行解决方案中的所有模块。 包括添加到解决方案的两个模块，以及模拟的温度传感器模块和模拟的 Edge 中心。

5. 按 F5 或选择“运行”工具栏按钮以运行解决方案。 初次运行可能需要 10 到 20 秒。 请确保没有其他 Docker 容器正在运行，因为它们可能会绑定此项目所需的端口。

6. 应看到两个 .NET Core 控制台应用窗口，分别对应每个模块。

7. 设置用于检查模块的断点。

   • 如果在 C# 环境中开发，请在 ModuleBackgroundService.cs 的 PipeMessage() 函数中设置断点。
   • 如果是 C 环境，在“main.c”的 InputQueue1Callback() 函数中设置断点。

8. 在每个模块创建断点，然后按 F5 以同时运行和调试多个模块。 此时应会看到多个 .NET Core 控制台应用窗口，每个窗口表示一个不同的模块。

   

9. 按 Ctrl+F5 或选择“停止”按钮可停止调试 。

生成映像并将其推送到注册表

开发和调试模块后，可以生成模块映像并将其推送到 Azure 容器注册表。 随后可将模块部署到 IoT Edge 设备。

1. 请将 IoT Edge 主项目设为启动项目，而不是其中的单个模块。

2. 选择“调试”或“发布”作为配置，以生成模块映像 。

   注意

   如果选择“调试”，Visual Studio 使用 Dockerfile.(amd64|windows-amd64).debug 生成 Docker 映像。 生成容器映像时，它将在该映像中包含 .NET Core 命令行调试器 VSDBG。 对于生产就绪的 IoT Edge 模块，建议使用“发布”配置，此模块可在没有 VSDBG 的情况下使用 Dockerfile.(amd64|windows-amd64)。

3. 如果使用的是专用注册表（如 Azure 容器注册表 (ACR)），请使用以下 Docker 命令登录。 可以从 Azure 门户的注册表的“访问密钥”页中获取用户名和密码。

   docker login azure --cloud-name AzureChinaCloud <ACR login server>
   

4. 让我们将 Azure 容器注册表登录信息添加到文件 deployment.debug.template.json 中的运行时设置。 可通过两种方式来执行此操作。 可以将注册表凭据添加到 .env 文件（最安全），也可以将它们直接添加到 deployment.debug.template.json 文件中。

   将凭据添加到 .env 文件：

   在解决方案资源管理器中选择“显示所有文件”工具栏按钮。 .env 文件出现。 将 Azure 容器注册表用户名和密码添加到 .env 文件中。 可以在 Azure 门户中 Azure 容器注册表的“访问密钥”页上找到这些凭据。

   

       DEFAULT_RT_IMAGE=1.2
       CONTAINER_REGISTRY_USERNAME_myregistry=<my-registry-name>
       CONTAINER_REGISTRY_PASSWORD_myregistry=<my-registry-password>
   

   将凭据直接添加到 deployment.debug.template.json

   如果你要将凭据直接添加到部署模板，请将占位符替换为 ACR 管理员用户名、密码和注册表名称。

         "settings": {
           "minDockerVersion": "v1.25",
           "loggingOptions": "",
           "registryCredentials": {
             "registry1": {
               "username": "<username>",
               "password": "<password>",
               "address": "<registry name>.azurecr.cn"
             }
           }
         }
   

   注意

   本文使用 Azure 容器注册表的管理员登录凭据，其十分适用于开发和测试方案。 为生产方案做好准备后，建议使用最低权限身份验证选项（如服务主体）。 有关详细信息，请参阅管理容器注册表的访问权限。

5. 如果使用的是本地注册表，可运行本地注册表。

6. 最后，在“解决方案资源管理器”中，右键单击主项目文件夹并选择“生成并推送 IoT Edge 模块”，为每个模块生成并推送 Docker 映像。 这可能需要几分钟的时间。 如果在 Visual Studio 的输出控制台中看到 Finished Build and Push IoT Edge Modules.，表示操作已完成。

部署解决方案

生成模块映像并将其推送到 Azure 容器注册表后，可以将解决方案部署到 IoT Edge 设备。 你已经有了一个贯穿本教程的部署清单模板。 让我们基于该模板生成一个部署清单，然后使用 Azure CLI 命令将模块部署到 Azure 中的 IoT Edge 设备。

1. 右键单击 Visual Studio 解决方案资源管理器中的主项目，然后选择“为 IoT Edge 生成部署”。

   

2. 转到本地 Visual Studio 主项目文件夹并查看 config 文件夹。 文件路径可能如下所示：C:\Users\<YOUR-USER-NAME>\source\repos\<YOUR-IOT-EDGE-PROJECT-NAME>\config。 在此处可以找到生成的部署清单，例如 deployment.amd64.debug.json。

3. 检查 deployment.amd64.debug.json 文件以确认 edgeHub 架构版本设置为 1.2。

    "$edgeHub": {
        "properties.desired": {
          "schemaVersion": "1.2",
          "routes": {
            "IotEdgeModule2022ToIoTHub": "FROM /messages/modules/IotEdgeModule2022/outputs/* INTO $upstream",
            "sensorToIotEdgeModule2022": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/IotEdgeModule2022/inputs/input1\")",
            "IotEdgeModule2022bToIoTHub": "FROM /messages/modules/IotEdgeModule2022b/outputs/* INTO $upstream"
          },
          "storeAndForwardConfiguration": {
            "timeToLiveSecs": 7200
          }
        }
      }
   

   提示

   Visual Studio 2022 的部署模板需要 1.2 架构版本。 如果需要设置为 1.1 或 1.0，请等到生成部署后再操作（不要在 deployment.debug.template.json 中更改它）。 默认情况下，生成部署将创建 1.2 架构。 但是，如果需要，可以在将生成的清单 deployment.amd64.debug.json 部署到 Azure 之前手动更改它。

   重要

   部署 IoT Edge 设备后，它当前无法在架构版本为 1.2 的 Azure 门户中正确显示（版本 1.1 即可）。 这是一个已知 bug，即将得到解决。 但是，这不会影响设备，因为它仍在 IoT 中心连接，并且可以随时使用 Azure CLI 进行通信。

   

4. 现在，让我们使用 Azure CLI 命令部署清单。 打开 Visual Studio“开发人员命令提示符”并更改为“配置”目录。

       cd config
   

5. 将 IoT Edge 设备的清单部署到 IoT 中心。 该命令将设备配置为使用解决方案中开发的模块。 部署清单是在上一步中创建的，并存储在 config 文件夹中。 在“配置”文件夹中，执行以下部署命令。 将 [device id]、[hub name] 和 [file path] 替换为你的值。 如果 IoT 中心内不存在 IoT Edge 设备 ID，则必须创建它。

       az iot edge set-modules --device-id [device id] --hub-name [hub name] --content [file path]
   

   例如，命令可能如下所示：

   az iot edge set-modules --device-id my-device-name --hub-name my-iot-hub-name --content deployment.amd64.debug.json
   

6. 运行该命令后，将在命令提示符中看到 JSON 中打印的部署确认。

生成模块 Docker 映像

开发模块后，可以生成模块映像以存储在容器注册表中，以便部署到 IoT Edge 设备。

使用模块的 Dockerfile 生成模块 Docker 映像。

docker build --rm -f "<DockerFilePath>" -t <ImageNameAndTag> "<ContextPath>" 

例如，假设命令 shell 位于项目目录中，且模块名称为 IotEdgeModule1。 若要为本地注册表或 Azure 容器注册表生成映像，请使用以下命令：

# Build the image for the local registry

docker build --rm -f "./IotEdgeModule1/Dockerfile.amd64.debug" -t localhost:5000/iotedgemodule1:0.0.1-amd64 "./IotEdgeModule1"

# Or build the image for an Azure Container Registry

docker build --rm -f "./IotEdgeModule1/Dockerfile.amd64.debug" -t myacr.azurecr.cn/iotedgemodule1:0.0.1-amd64 "./IotEdgeModule1"

推送模块 Docker 映像

将模块映像推送到本地注册表或容器注册表。

docker push <ImageName>

例如：

# Push the Docker image to the local registry

docker push localhost:5000/iotedgemodule1:0.0.1-amd64

# Or push the Docker image to an Azure Container Registry
az acr login --name myacr
docker push myacr.azurecr.cn/iotedgemodule1:0.0.1-amd64

将模块部署到 IoT Edge 设备。

在 Visual Studio 中，打开主项目中的 deployment.debug.template.json 部署清单文件。 部署清单是一个 JSON 文档，用于描述要在目标 IoT Edge 设备上配置的模块。 在部署之前，需要更新 Azure 容器注册表凭据、模块映像以及适当的 createOptions 值。 若要了解 createOption 值的详细信息，请参阅如何配置 IoT Edge 模块的容器创建选项。

1. 如果使用 Azure 容器注册表来存储模块映像，则需要在 “edgeAgent” 设置中将凭据添加到 “deployment.debug.template.json”。 例如，

   "modulesContent": {
   "$edgeAgent": {
     "properties.desired": {
       "schemaVersion": "1.1",
       "runtime": {
         "type": "docker",
         "settings": {
           "minDockerVersion": "v1.25",
           "loggingOptions": "",
           "registryCredentials": {
             "myacr": {
               "username": "myacr",
               "password": "<your_acr_password>",
               "address": "myacr.azurecr.cn"
             }
           }
         }
       },
   //...
   

2. 将 image 属性值替换为推送到注册表的模块映像名称。 例如，如果为自定义模块 IotEdgeModule1 推送了标记为 myacr.azurecr.cn/iotedgemodule1:0.0.1-amd64 的映像，请使用该标记值替换映像属性值。

3. 对于部署模板中的每个系统和自定义模块，添加或将 createOptions 替换为字符串化内容。

   例如，IotEdgeModule1 的映像和 createOptions 设置应类似于以下内容：

   "IotEdgeModule1": {
   "version": "1.0.0",
   "type": "docker",
   "status": "running",
   "restartPolicy": "always",
   "settings": {
       "image": "myacr.azurecr.cn/iotedgemodule1:0.0.1-amd64",
       "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}],\"443/tcp\":[{\"HostPort\":\"443\"}]}}}"
   }
   

使用 IoT Edge Azure CLI set-modules 命令将模块部署到 Azure IoT 中心。 例如，若要将 deployment.debug.amd64.json 文件中定义的模块部署到 IoT Edge 设备 my-device 的 IoT 中心 my-iot-hub，请使用以下命令：

az iot edge set-modules --hub-name my-iot-hub --device-id my-device --content ./deployment.debug.template.json --login "HostName=my-iot-hub.azure-devices.cn;SharedAccessKeyName=iothubowner;SharedAccessKey=<SharedAccessKey>"