你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
本地管理控制台的集成 API 参考(公共预览版)
本文列出了支持将 Microsoft Defender for IoT 与合作伙伴服务集成的 API。
例如,此 API 当前根据教程:将 ServiceNow 与 Microsoft Defender for IoT 集成 通过 ServiceNow Service Graph Connector for Defender for IoT 实现。
注意
集成 API 旨在持续运行并创建持续运行的数据流,例如查询最近五分钟的新数据。 集成 API 返回带有时间戳的数据。
若要简单地查询数据,请改用常规的非集成 API,让本地管理控制台查询所有设备,或让特定传感器仅从该传感器查询设备。 有关详细信息,请参阅 Defender for IoT API 参考。
URI:/external/v3/integration/
devices(创建和更新设备)
此 API 返回有关给定时间戳后更新的所有设备的数据。
URI:/external/v3/integration/devices/<timestamp>
URI 参数:
名称 | 说明 | 示例 | 必需/可选 |
---|---|---|---|
timestamp | 从中返回结果的开始时间,以纪元时间(毫秒)为单位,采用 UTC 时区。 | /external/v3/integration/devices/1664781014000 |
必需 |
GET
查询参数:
名称 | 说明 | 示例 | 必需/可选 |
---|---|---|---|
sensorId | 仅返回特定传感器看到的设备。 使用 sensors(获取传感器)API 结果中的 ID 值。 | 1 |
可选 |
notificationType | 确定要返回的设备类型。 支持的值包括: - 0 :更新的设备和新设备(默认值)。 - 1 :仅新设备。 - 2 :仅更新的设备。 |
2 |
可选 |
page | 定义结果页码开始的编号。 例如,0 = 第一页为 0。 默认值 = 0 |
0 |
可选 |
大小 | 定义页面大小。 默认值 = 50 |
75 |
可选 |
connections(获取设备连接)
此 API 返回有关给定时间戳后更新的所有设备连接的数据。
URI:/external/v3/integration/connections/<timestamp>
URI 参数:
名称 | 说明 | 示例 | 必需/可选 |
---|---|---|---|
timestamp | 从中返回结果的开始时间,以纪元时间(毫秒)为单位,采用 UTC 时区。 | /external/v3/integration/devices/1664781014000 |
必需 |
GET
查询参数:
名称 | 说明 | 示例 | 必需/可选 |
---|---|---|---|
page | 定义结果页码开始的编号。 例如,0 = 第一页为 0。 默认值 = 0 |
0 |
可选 |
大小 | 定义页面大小。 默认值 = 50 |
75 |
可选 |
device(获取设备的详细信息)
此 API 根据每个给定的设备 ID 返回有关特定设备的数据。
URI:/external/v3/integration/device/{deviceId}
GET
deleteddevices(获取已删除的设备)
此 API 从提供的时间戳中返回最近删除设备的 ID 列表。
URI:/external/v3/integration/deleteddevices/
GET
URI 参数:
名称 | 说明 | 示例 | 必需/可选 |
---|---|---|---|
timestamp | 从中返回结果的开始时间,以纪元时间(毫秒)为单位,采用 UTC 时区。 | /external/v3/integration/deleteddevices/1664781014000 |
必需 |
sensors(获取传感器)
此 API 返回连接的 OT 网络传感器的传感器对象列表。
URI:/external/v3/integration/sensors/
GET
devicecves(获取设备 CVE)
此 API 返回自提供时间戳以来更新的所有设备的活动 CVE 列表。
URI:/external/v3/integration/devicecves/
GET
URI:/external/v3/integration/devicecves/<timestamp>
URI 参数
名称 | 说明 | 示例 | 必需/可选 |
---|---|---|---|
timestamp | 从中返回结果的开始时间,以纪元时间(毫秒)为单位,采用 UTC 时区。 | /external/v3/integration/devicecves/1664781014000 |
必需 |
查询参数
名称 | 说明 | 示例 | 必需/可选 |
---|---|---|---|
page | 定义结果页码开始的编号。 |
0 = 第一页为 0。 默认值 = 0 |
可选 |
大小 | 定义页面大小。 | 默认值 = 50 |
可选 |
sensorId | 显示特定传感器(由给定的传感器 ID 定义)的结果。 | 1 |
可选 |
score | 确定要检索的最低 CVE 分数。 所有结果的 CVE 分数将等于或大于给定值。 | 默认值 = 0 。 |
可选 |
deviceIds | 要根据其显示结果的设备 ID 的逗号分隔列表。 | 例如: 1232,34,2,456 |
可选 |
后续步骤
有关详细信息,请参阅: