你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

适用于 JavaScript 的 Azure iotHub 客户端库 - 版本 6.3.0

此包包含一个同构 SDK, (在 Azure iotHub 客户端的 Node.js 和浏览器) 中运行。

使用此 API 管理 Azure 订阅中的 IoT 中心。

源代码 | 包 (NPM) | API 参考文档 | 样品

入门

目前支持的环境

有关更多详细信息,请参阅我们的支持政策

先决条件

安装 @azure/arm-iothub

使用 安装适用于 JavaScript 的 npmAzure iotHub 客户端库:

npm install @azure/arm-iothub

创建 IotHubClient 并对其进行身份验证

若要创建客户端对象以访问 Azure iotHub API,需要 endpoint Azure iotHub 资源的 和 credential。 Azure iotHub 客户端可以使用 Azure Active Directory 凭据进行身份验证。 可以在 Azure 门户中找到 Azure iotHub 资源的终结点。

可以使用 @azure/标识 库中的凭据或 现有 AAD 令牌向 Azure Active Directory 进行身份验证。

若要使用如下所示的 DefaultAzureCredential 提供程序或 Azure SDK 随附的其他凭据提供程序,请安装 @azure/identity 包:

npm install @azure/identity

还需要 注册新的 AAD 应用程序,并通过向服务主体分配合适的角色来授予对 Azure iotHub 的访问权限 (注意:角色(如) "Owner" 不会) 授予必要的权限。 将 AAD 应用程序的客户端 ID、租户 ID 和客户端机密的值设置为环境变量: AZURE_CLIENT_IDAZURE_TENANT_IDAZURE_CLIENT_SECRET

有关如何创建 Azure AD 应用程序的详细信息,检查本指南

const { IotHubClient } = require("@azure/arm-iothub");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new IotHubClient(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new IotHubClient(credential, subscriptionId);

JavaScript 捆绑包

若要在浏览器中使用此客户端库,首先需要使用捆绑程序。 有关如何执行此操作的详细信息,请参阅捆绑 文档

关键概念

IotHubClient

IotHubClient 是开发人员使用 Azure iotHub 客户端库的主要接口。 浏览此客户端对象上的方法,了解可以访问的 Azure iotHub 服务的不同功能。

疑难解答

日志记录

启用日志记录可能有助于发现有关故障的有用信息。 若要查看 HTTP 请求和响应的日志,请将 AZURE_LOG_LEVEL 环境变量设置为 info。 或者,可以在运行时通过调用 @azure/logger 中的 setLogLevel 来启用日志记录:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

有关如何启用日志的更详细说明,请查看 @azure/logger 包文档

后续步骤

请查看 示例 目录,获取有关如何使用此库的详细示例。

贡献

若要为此库做出贡献,请阅读贡献指南,详细了解如何生成和测试代码。

曝光数