通过

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

适用于 Eclipse ThreadX API 的 Defender-IoT-micro-agent（预览版）

  • 项目

Defender for IoT API 受 Microsoft API 许可证和使用条款的约束。

此 API 仅用于 Eclipse ThreadX 的 Defender-IoT-micro-agent。 有关其他资源，请参阅 Eclipse ThreadX GitHub 资源的 Defender-IoT-micro-agent。

为 Eclipse ThreadX 启用 Defender-IoT-micro-agent

nx_azure_iot_security_module_enable

原型

UINT nx_azure_iot_security_module_enable(NX_AZURE_IOT *nx_azure_iot_ptr);

说明

此例程会启用适用于 Azure RTOS 的 Defender-IoT-micro-agent 子系统。 内部状态机管理安全事件的收集并将其发送到 Azure IoT 中心。 仅需要一个 NX_AZURE_IOT_SECURITY_MODULE 实例即可管理数据收集。

参数

名称 说明
nx_azure_iot_ptr [in] 一个指向 NX_AZURE_IOT 的指针。

返回值

返回值 说明
NX_AZURE_IOT_SUCCESS 已成功启用 Azure IoT 安全模块。
NX_AZURE_IOT_FAILURE 由于内部错误，未能启用 Azure IoT 安全模块。
NX_AZURE_IOT_INVALID_PARAMETER 安全模块需要有效的 #NX_AZURE_IOT 实例。

允许来自

线程

禁用适用于 Azure RTOS 的 Defender-IoT-micro-agent

nx_azure_iot_security_module_disable

原型

UINT nx_azure_iot_security_module_disable(NX_AZURE_IOT *nx_azure_iot_ptr);

说明

此例程会禁用适用于 Azure RTOS 的 Defender-IoT-micro-agent 子系统。

参数

名称 说明
nx_azure_iot_ptr [in] 一个指向 NX_AZURE_IOT 的指针。 如果为 NULL，则禁用单一实例。

返回值

返回值 说明
NX_AZURE_IOT_SUCCESS 成功禁用 Azure IoT 安全模块时为“Successful”。
NX_AZURE_IOT_INVALID_PARAMETER Azure IoT 中心实例与单一实例复合实例不同。
NX_AZURE_IOT_FAILURE 由于内部错误，未能禁用 Azure IoT 安全模块。

允许来自

线程

后续步骤

若要详细了解如何开始使用 Eclipse ThreadX Defender-IoT-micro-agent，请参阅以下文章：

  • 查看 Defender for IoT Eclipse ThreadX Defender-IoT-micro-agent 概述。