通过

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

Defender for IoT API 参考

  • 项目

本部分介绍 Microsoft Defender for IoT 支持的公共 API。 Defender for IoT API 受 Microsoft API 许可证和使用条款的约束。

使用 Defender for IoT API 访问传感器和本地管理控制台发现的数据，并对这些数据执行操作。

API 连接通过 SSL 受到保护。

生成 API 访问令牌

许多 Defender for IoT API 都需要访问令牌。 身份验证 API 不需要访问令牌。

生成令牌：

  1. 在“系统设置”窗口中，选择“集成”>“访问令牌”。

  2. 选择“生成令牌”。

  3. 在“描述”中，描述新令牌的用途，并选择“生成”。

  4. 随即将显示访问令牌。 请复制该令牌，因为它不会再次显示。

  5. 选择“完成”。

    • 你创建的令牌将显示在“访问令牌”对话框中。 “已使用”指示上次接收此令牌的外部调用的时间。

    • “已使用”字段中的“N/A”指示传感器与其连接的服务器之间的连接无法正常工作。

生成令牌后，将标题为“授权”的 HTTP 标头添加到请求中，并将其值设置为生成的令牌。

传感器 API 版本参考

版本 受支持的 API
无版本 身份验证和密码管理：
- set_password（更改密码）
- set_password_by_admin（管理员更新用户密码）
- 验证（验证用户凭据）
版本 1 中的新增功能 清单：
- 连接（检索设备连接信息）
- cve（检索有关 CVE 的信息）
- 设备（检索设备信息）

警报：
- 警报（检索警报信息）
- 事件（检索时间线事件）

漏洞：
- 操作（检索操作漏洞）
- 设备（检索设备漏洞信息）
- 缓解（检索缓解步骤）
- 安全（检索安全漏洞）
版本 2 中的新增功能 警报：
- 更新 警报（检索警报信息）

本地管理控制台 API 版本参考

版本 API
无版本 身份验证和密码管理：
- set_password（更改密码）
- set_password_by_admin（系统管理员更新用户密码）
- 验证（验证用户凭据）
版本 1 中的新增功能 站点
- 设备（管理 OT 传感器设备）
清单：
- 设备（检索所有设备信息）

警报：
- 警报（检索警报信息）
- maintenanceWindow（创建警报排除项）
版本 2 中的新增功能 警报：
- 更新 警报（检索警报信息）
- pcap（请求警报 PCAP）
版本 3 中的新增功能 集成 API：
- 连接（获取设备连接）
- 设备（获取设备的详细信息）
- devicecve（获取设备 CVE）
- 设备（创建和更新设备）
- deleteddevice（获取已删除的设备）
- 传感器（获取传感器）

注意

集成 API 旨在持续运行并创建持续运行的数据流，例如查询最近五分钟的新数据。 集成 API 返回带有时间戳的数据。

若要简单地查询数据，可以改用常规的非集成的 API，用于本地管理控制台查询所有设备，或用于特定的传感器仅从该传感器查询设备。

Epoch 时间

在所有 Defender for IoT 时间戳值中，Epoch 时间等于 1970 年 1 月 1 日。

后续步骤

有关详细信息，请参阅：