Defender-IoT-Micro-Agent für Eclipse ThreadX-API (Vorschau)

Defender für IoT-APIs unterliegen den Microsoft-API-Lizenz- und Nutzungsbedingungen.

Diese API ist nur für die Verwendung mit dem Defender-IoT-Micro-Agent für Eclipse ThreadX vorgesehen. Weitere Ressourcen finden Sie in der GitHub-Ressource Defender-IoT-micro-agent für Eclipse ThreadX.

Hinweis

Defender für IoT plant, den Micro-Agent am 1. August 2025 außer Betrieb zu nehmen.

Aktivieren des Defender-IoT-Micro-Agents für Eclipse ThreadX

nx_azure_iot_security_module_enable

Prototyp

UINT nx_azure_iot_security_module_enable(NX_AZURE_IOT *nx_azure_iot_ptr);

Beschreibung

Diese Routine ermöglicht das Azure IoT Defender-IoT-Micro-Agent-Subsystem. Ein interner Zustandscomputer verwaltet die Sammlung von Sicherheitsereignissen und sendet sie an Azure IoT Hub. Zum Verwalten der Datensammlung ist nur eine NX_AZURE_IOT_SECURITY_MODULE instance erforderlich.

Parameter

Name Beschreibung
nx_azure_iot_ptr [in] Ein Zeiger auf ein NX_AZURE_IOT.

Rückgabewerte

Rückgabewerte Beschreibung
NX_AZURE_IOT_SUCCESS Azure IoT-Sicherheitsmodul wurde erfolgreich aktiviert.
NX_AZURE_IOT_FAILURE Fehler beim Aktivieren des Azure IoT-Sicherheitsmoduls aufgrund eines internen Fehlers.
NX_AZURE_IOT_INVALID_PARAMETER Das Sicherheitsmodul erfordert eine gültige #NX_AZURE_IOT instance.

Zulässig von

Threads

Deaktivieren Azure IoT Defender-IoT-Micro-Agent

nx_azure_iot_security_module_disable

Prototyp

UINT nx_azure_iot_security_module_disable(NX_AZURE_IOT *nx_azure_iot_ptr);

Beschreibung

Diese Routine deaktiviert das Azure IoT Defender-IoT-Micro-Agent-Subsystem.

Parameter

Name Beschreibung
nx_azure_iot_ptr [in] Ein Zeiger auf NX_AZURE_IOT. Bei NULL ist die Singleton-instance deaktiviert.

Rückgabewerte

Rückgabewerte Beschreibung
NX_AZURE_IOT_SUCCESS Erfolgreich, wenn das Azure IoT-Sicherheitsmodul erfolgreich deaktiviert wurde.
NX_AZURE_IOT_INVALID_PARAMETER Azure IoT Hub instance unterscheidet sich von der zusammengesetzten Singleton-instance.
NX_AZURE_IOT_FAILURE Fehler beim Deaktivieren des Azure IoT-Sicherheitsmoduls aufgrund eines internen Fehlers.

Zulässig von

Threads

Nächste Schritte

Weitere Informationen zu den ersten Schritten mit Eclipse ThreadX Defender-IoT-micro-agent finden Sie in den folgenden Artikeln:

  • Lesen Sie die Übersicht über den Defender für IoT Eclipse ThreadX Defender-IoT-Micro-Agent.