Share via

Defender-IoT-micro-agent für Eclipse ThreadX API (Vorschau)

  • Artikel

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

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

Aktivieren von Defender-IoT-Micro-Agent 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 aktiviert das Defender-IoT-Micro-Agent-Subsystem von Azure IoT. Ein interner Zustandsautomat verwaltet die Sammlung von Sicherheitsereignissen und sendet sie an Azure IoT Hub. Nur eine NX_AZURE_IOT_SECURITY_MODULE-Instanz ist erforderlich, um die Datensammlung zu verwalten.

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 erfolgreich aktiviert.
NX_AZURE_IOT_FAILURE Fehler beim Aktivieren des Azure IoT-Sicherheitsmoduls wegen eines internen Fehlers.
NX_AZURE_IOT_INVALID_PARAMETER Das Sicherheitsmodul erfordert eine gültige #NX_AZURE_IOT-Instanz.

Zulässig von

Threads

Deaktivieren des Azure IoT Defender-IoT-Micro-Agents

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 Defender-IoT-Micro-Agent-Subsystem von Azure IoT.

Parameter

Name Beschreibung
nx_azure_iot_ptr [in] Ein Zeiger auf NX_AZURE_IOT. Wenn NULL, wird die Singletoninstanz 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-Instanz unterscheidet sich von der zusammengesetzten Singletoninstanz.
NX_AZURE_IOT_FAILURE Fehler beim Deaktivieren des Azure IoT-Sicherheitsmoduls wegen 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: