Micro-agent Defender-IoT pour l’API Eclipse ThreadX (préversion)

  • Article

Les API Defender pour IoT sont régies par les conditions d’utilisation et la licence d’API Microsoft.

Cette API est destinée à être utilisée uniquement avec le micro-agent Defender-IoT pour Eclipse ThreadX. Pour obtenir des ressources supplémentaires, consultez le micro-agent Defender-IoT pour la ressource GitHub Eclipse ThreadX.

Activer le micro-agent Defender-IoT pour Eclipse ThreadX

nx_azure_iot_security_module_enable

Prototype

UINT nx_azure_iot_security_module_enable(NX_AZURE_IOT *nx_azure_iot_ptr);

Description

Cette routine active le sous-système du micro-agent Defender-IoT Azure IoT. Une machine à états interne gère la collecte d’événements de sécurité et les transmet à Azure IoT Hub. Une seule instance de NX_AZURE_IOT_SECURITY_MODULE est requise pour gérer la collecte de données.

Paramètres

Nom Description
nx_azure_iot_ptr [in] Pointeur vers un NX_AZURE_IOT.

Valeurs retournées

Valeurs retournées Description
NX_AZURE_IOT_SUCCESS Le module de sécurité Azure IoT a été correctement activé.
NX_AZURE_IOT_FAILURE L’activation du module de sécurité Azure IoT a échoué, en raison d’une erreur interne.
NX_AZURE_IOT_INVALID_PARAMETER Le module de sécurité requiert une instance de #NX_AZURE_IOT valide.

Autorisé à partir de

Threads

Désactiver le micro-agent Defender-IoT Azure IoT

nx_azure_iot_security_module_disable

Prototype

UINT nx_azure_iot_security_module_disable(NX_AZURE_IOT *nx_azure_iot_ptr);

Description

Cette routine désactive le sous-système du micro-agent Defender-IoT Azure IoT.

Paramètres

Nom Description
nx_azure_iot_ptr [in] Pointeur vers NX_AZURE_IOT. Si la valeur est NULL, l’instance singleton est désactivée.

Valeurs retournées

Valeurs retournées Description
NX_AZURE_IOT_SUCCESS Le module de sécurité Azure IoT est correctement désactivé.
NX_AZURE_IOT_INVALID_PARAMETER L’instance de IoT Hub Azure est différente de l’instance composite singleton.
NX_AZURE_IOT_FAILURE La désactivation du module de sécurité Azure IoT a échoué, en raison d’une erreur interne.

Autorisé à partir de

Threads

Étapes suivantes

Pour en savoir plus sur la prise en main d’Eclipse ThreadX Defender-IoT-micro-agent, consultez les articles suivants :