快速入门:使用适用于 IoT 中心设备预配服务的 Node.js 设备 SDK 创建和预配 X.509 模拟设备Quickstart: Create and provision an X.509 simulated device using Node.js device SDK for IoT Hub Device Provisioning Service

在本快速入门中,我们在 Windows 计算机上创建一台模拟 X.509 设备。In this quickstart, you create a simulated X.509 device on a Windows computer. 我们使用设备预配服务 (DPS) 的单个注册,通过设备示例 Node.js 代码将此模拟设备连接到 IoT 中心。You use device sample Node.js code to connect this simulated device with your IoT hub using an individual enrollment with the Device Provisioning Service (DPS).

先决条件Prerequisites

备注

初始的设备孪生状态配置仅在 IoT 中心的标准层中提供。The initial device twin state configuration is available only in the standard tier of IoT Hub. 有关基本和标准 IoT 中心层的详细信息,请参阅如何选择合适的 IoT 中心层For more information about the basic and standard IoT Hub tiers, see How to choose the right IoT Hub tier.

准备环境Prepare the environment

  1. 在继续操作之前,请完成通过 Azure 门户设置 IoT 中心设备预配服务中的步骤。Complete the steps in the Setup IoT Hub Device Provisioning Service with the Azure portal before you proceed.

  2. 请确保已在计算机上安装 Node.js v4.0 或更高版本Make sure you have Node.js v4.0 or above installed on your machine.

  3. 确保在计算机上安装 Git 并将其添加到可供命令窗口访问的环境变量。Make sure Git is installed on your machine and is added to the environment variables accessible to the command window.

  4. 确保在计算机上安装 OpenSSL 并将其添加到可供命令窗口访问的环境变量。Make sure OpenSSL is installed on your machine and is added to the environment variables accessible to the command window. 此库可以从源生成和安装,也可以从第三方(例如这个第三方)下载和安装。This library can either be built and installed from source or downloaded and installed from a third party such as this.

    备注

    如果已创建“根” 、“中间” 和/或“叶” X.509 证书,则可跳过此步骤以及与生成证书相关的所有后续步骤。If you have already created your root, intermediate, and/or leaf X.509 certificates, you may skip this step and all following steps regarding certificate generation.

创建自签名的 X.509 设备证书和单个注册项Create a self-signed X.509 device certificate and individual enrollment entry

在本部分,你将使用自签名的 X.509 证书。请务必记住以下事项:In this section you, will use a self-signed X.509 certificate, it is important to keep in mind the following:

  • 自签名证书仅用于测试,不应在生产环境中使用。Self-signed certificates are for testing only, and should not be used in production.
  • 自签名证书的默认过期日期为一年。The default expiration date for a self-signed certificate is one year.

你将使用来自 Azure IoT SDK for Node.js 的示例代码创建要与模拟设备的个体注册条目一起使用的证书。You will use sample code from the Azure IoT SDK for Node.js to create the certificate to be used with the individual enrollment entry for the simulated device.

Azure IoT 设备预配服务支持两类注册:The Azure IoT Device Provisioning Service supports two types of enrollments:

本文演示单个注册。This article demonstrates individual enrollments.

  1. 打开命令提示符。Open a command prompt. 克隆代码示例的 GitHub 存储库:Clone the GitHub repo for the code samples:

    git clone https://github.com/Azure/azure-iot-sdk-node.git --recursive
    
  2. 导航到证书生成器脚本,然后生成该项目。Navigate to the certificate generator script and build the project.

    cd azure-iot-sdk-node/provisioning/tools
    npm install
    
  3. 使用自己的 certificate-name 运行脚本,创建_叶_ X.509 证书。Create a leaf X.509 certificate by running the script using your own certificate-name. 叶证书的公用名称会成为注册 ID,因此请确保只使用小写的字母数字和连字符。The leaf certificate's common name becomes the Registration ID so be sure to only use lower-case alphanumerics and hyphens.

    node create_test_cert.js device {certificate-name}
    
  4. 登录到 Azure 门户,选择左侧菜单上的“所有资源”按钮,打开设备预配服务实例 。Sign in to the Azure portal, select the All resources button on the left-hand menu and open your Device Provisioning Service instance.

  5. 在“设备预配服务”菜单中,选择“管理注册” 。From the Device Provisioning Service menu, select Manage enrollments. 选择“个人注册”选项卡,然后选择顶部的“添加个人注册”按钮 。Select Individual Enrollments tab and select the Add individual enrollment button at the top.

  6. 在“添加注册”面板中,输入以下信息 :In the Add Enrollment panel, enter the following information:

    • 选择“X.509” 作为标识证明机制 。Select X.509 as the identity attestation Mechanism.

    • 在“主要证书 .pem 或 .cer 文件”下,选择“选择文件”以选择在前述步骤中创建的证书文件 {certificate-name}_cert.pem。 Under the Primary certificate .pem or .cer file, choose Select a file to select the certificate file {certificate-name}_cert.pem created in the previous steps.

    • (可选)可以提供以下信息:Optionally, you may provide the following information:

      • 选择与预配服务链接的 IoT 中心。Select an IoT hub linked with your provisioning service.
      • 输入唯一设备 ID。Enter a unique device ID. 为设备命名时,请确保避免使用敏感数据。Make sure to avoid sensitive data while naming your device.
      • 使用设备所需的初始配置更新“初始设备孪生状态” 。Update the Initial device twin state with the desired initial configuration for the device.
      • 完成后,按“保存”按钮 。Once complete, press the Save button.

      在门户中为 X.509 证明添加单个注册Add individual enrollment for X.509 attestation in the portal

      成功注册以后,X.509 设备会在“单独注册”选项卡的“注册 ID”列下显示为 {certificatename} 。 记下此值以备将来使用。On successful enrollment, your X.509 device appears as {certificatename} under the Registration ID column in the Individual Enrollments tab. Note this value for later.

模拟设备Simulate the device

Azure IoT 中心 Node.js 设备 SDK 提供了进行设备模拟的简单方式。The Azure IoT Hub Node.js Device SDK provides an easy way to simulate a device. 若要阅读更多材料,请参阅设备概念For further reading, see Device concepts.

  1. 在 Azure 门户中,选择设备预配服务的“概览”边栏选项卡,记下“全局设备终结点”和“ID 范围”的值。 In the Azure portal, select the Overview blade for your Device Provisioning service and note the GLobal Device Endpoint and ID Scope values.

    从门户边栏选项卡中提取设备预配服务终结点信息

  2. 将证书和密钥复制到示例文件夹。 Copy your certificate and key to the sample folder.

    copy .\{certificate-name}_cert.pem ..\device\samples\{certificate-name}_cert.pem
    copy .\{certificate-name}_key.pem ..\device\samples\{certificate-name}_key.pem
    
  3. 导航到设备测试脚本,然后生成项目。Navigate to the device test script and build the project.

    cd ..\device\samples
    npm install
    
  4. 编辑 register_x509.js 文件。Edit the register_x509.js file. 进行下述更改,然后保存文件。Save the file after making the following changes.

    • provisioning host 替换为在上面的“步骤 1”中注明的“全局设备终结点”。 Replace provisioning host with the Global Device Endpoint noted in Step 1 above.
    • id scope 替换为在上面的“步骤 1”中记下的“ID 范围”。 Replace id scope with the ID Scope noted in Step 1 above.
    • registration id 替换为在上一部分中记下的“注册 ID” 。Replace registration id with the Registration ID noted in the previous section.
    • cert filenamekey filename 替换为在上面的“步骤 2”中复制的文件。 Replace cert filename and key filename with the files you copied in Step 2 above.
  5. 执行脚本,验证该设备是否已成功预配。Execute the script and verify the device was provisioned successfully.

    node register_x509.js
    
  6. 在门户中导航到已链接到预配服务的 IoT 中心,然后打开“IoT 设备”边栏选项卡。 In the portal, navigate to the IoT hub linked to your provisioning service and open the IoT devices blade. 将模拟的 X.509 设备成功预配到中心以后,设备 ID 会显示在“IoT 设备”边栏选项卡上,“状态”为“已启用” 。On successful provisioning of the simulated X.509 device to the hub, its device ID appears on the IoT devices blade, with STATUS as enabled. 如果在运行示例设备应用程序之前已打开边栏选项卡,则可能需要按顶部的“刷新”按钮 。You might need to press the Refresh button at the top if you already opened the blade prior to running the sample device application.

    设备注册到 IoT 中心

    如果从设备的注册项中的默认值更改了“初始设备孪生状态” ,则它会从中心拉取所需的孪生状态,并执行相应的操作。If you changed the initial device twin state from the default value in the enrollment entry for your device, it can pull the desired twin state from the hub and act accordingly. 有关详细信息,请参阅了解并在 IoT 中心内使用设备孪生For more information, see Understand and use device twins in IoT Hub.

清理资源Clean up resources

如果打算继续使用和探索设备客户端示例,请勿清理在本快速入门中创建的资源。If you plan to continue working on and exploring the device client sample, do not clean up the resources created in this quickstart. 如果不打算继续学习,请按以下步骤删除本快速入门中创建的所有资源。If you do not plan to continue, use the following steps to delete all resources created by this quickstart.

  1. 关闭计算机上的设备客户端示例输出窗口。Close the device client sample output window on your machine.
  2. 在 Azure 门户的左侧菜单中选择“所有资源”,然后选择设备预配服务 。From the left-hand menu in the Azure portal, select All resources and then select your Device Provisioning service. 打开服务的“管理注册”边栏选项卡,然后选择“单个注册”选项卡 。选中在本快速入门中注册的设备的“注册 ID”旁边的复选框,然后按窗格顶部的“删除”按钮 。Open the Manage Enrollments blade for your service, and then select the Individual Enrollments tab. Select the check box next to the REGISTRATION ID of the device you enrolled in this quickstart, and press the Delete button at the top of the pane.
  3. 在 Azure 门户的左侧菜单中选择“所有资源”,然后选择 IoT 中心 。From the left-hand menu in the Azure portal, select All resources and then select your IoT hub. 打开中心的“IoT 设备”边栏选项卡,选中在本快速入门中注册的设备的“设备 ID”旁边的复选框,然后按窗格顶部的“删除”按钮 。Open the IoT devices blade for your hub, select the check box next to the DEVICE ID of the device you registered in this quickstart, and then press the Delete button at the top of the pane.

后续步骤Next steps

在本快速入门中,你已创建模拟 X.509 设备,并已使用门户中的 Azure IoT 中心设备预配服务将其预配到 IoT 中心。In this quickstart, you’ve created a simulated X.509 device and provisioned it to your IoT hub using the Azure IoT Hub Device Provisioning Service on the portal. 若要了解如何以编程方式注册 X.509 设备,请继续阅读快速入门中关于 X.509 设备的编程注册内容。To learn how to enroll your X.509 device programmatically, continue to the quickstart for programmatic enrollment of X.509 devices.