Microagente de Defender-IoT para la API de Eclipse ThreadX (versión preliminar)

  • Artículo

Las API de Defender para IoT se rigen por la licencia de API de Microsoft y Términos de uso.

Esta API está pensada para su uso solo con el microagente defender-IoT para Eclipse ThreadX. Para más recursos, consulte el recurso de GitHub Defender-IoT-micro-agent para Eclipse ThreadX.

Habilitación del microagente de Defender-IoT para Eclipse ThreadX

nx_azure_iot_security_module_enable

Prototipo

UINT nx_azure_iot_security_module_enable(NX_AZURE_IOT *nx_azure_iot_ptr);

Descripción

Esta rutina habilita el subsistema de Azure IoT Defender-IoT-micro-agent. Una máquina de estados interna administra la recopilación de eventos de seguridad y los envía a Azure IoT Hub. Solo se necesita una instancia de NX_AZURE_IOT_SECURITY_MODULE para administrar la recopilación de datos.

Parámetros

Name Descripción
nx_azure_iot_ptr [in] Puntero a un objeto NX_AZURE_IOT.

Valores devueltos

Valores devueltos Descripción
NX_AZURE_IOT_SUCCESS Módulo de seguridad de IoT de Azure habilitado correctamente.
NX_AZURE_IOT_FAILURE No se pudo habilitar el módulo de seguridad de IoT de Azure debido a un error interno.
NX_AZURE_IOT_INVALID_PARAMETER El módulo de seguridad requiere una instancia de #NX_AZURE_IOT válida.

Permitido desde

Subprocesos

Deshabilitación de Azure IoT Defender-IoT-micro-agent

nx_azure_iot_security_module_disable

Prototipo

UINT nx_azure_iot_security_module_disable(NX_AZURE_IOT *nx_azure_iot_ptr);

Descripción

Esta rutina deshabilita el subsistema de Azure IoT Defender-IoT-micro-agent.

Parámetros

Name Descripción
nx_azure_iot_ptr [in] Puntero a NX_AZURE_IOT. Si es NULL, la instancia del singleton está deshabilitada.

Valores devueltos

Valores devueltos Descripción
NX_AZURE_IOT_SUCCESS Correcto cuando el módulo de seguridad de IoT de Azure se ha deshabilitado correctamente.
NX_AZURE_IOT_INVALID_PARAMETER La instancia de IoT Hub de Azure es diferente de la instancia compuesta de singleton.
NX_AZURE_IOT_FAILURE No se pudo deshabilitar el módulo de seguridad de IoT de Azure debido a un error interno.

Permitido desde

Subprocesos

Pasos siguientes

Para más información sobre cómo empezar a trabajar con Eclipse ThreadX Defender-IoT-micro-agent, consulte los artículos siguientes:

  • Revise la introducción al microagente de Defender para IoT de Eclipse ThreadX Defender-IoT.