Dela via

Defender-IoT-micro-agent för Eclipse ThreadX API (förhandsversion)

Defender for IoT-API:er styrs av Licens och användningsvillkor för Microsoft API.

Det här API:et är endast avsett för användning med Defender-IoT-micro-agent för Eclipse ThreadX. Ytterligare resurser finns i Defender-IoT-micro-agent för Eclipse ThreadX GitHub-resursen.

Kommentar

Defender for IoT planerar att dra tillbaka mikroagenten den 1 augusti 2025.

Aktivera 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);

beskrivning

Den här rutinen aktiverar undersystemet Azure IoT Defender-IoT-micro-agent. En intern tillståndsdator hanterar insamling av säkerhetshändelser och skickar dem till Azure IoT Hub. Endast en NX_AZURE_IOT_SECURITY_MODULE instans krävs och behövs för att hantera datainsamling.

Parameters

Name beskrivning
nx_azure_iot_ptr [in] En pekare till en NX_AZURE_IOT.

Returvärden

Returvärden beskrivning
NX_AZURE_IOT_SUCCESS Azure IoT-säkerhetsmodulen har aktiverats.
NX_AZURE_IOT_FAILURE Det gick inte att aktivera Azure IoT-säkerhetsmodulen på grund av ett internt fel.
NX_AZURE_IOT_INVALID_PARAMETER Säkerhetsmodulen kräver en giltig #NX_AZURE_IOT-instans.

Tillåts från

Trådar

Inaktivera 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);

beskrivning

Den här rutinen inaktiverar undersystemet Azure IoT Defender-IoT-micro-agent.

Parameters

Name beskrivning
nx_azure_iot_ptr [in] En pekare till NX_AZURE_IOT. Om NULL är singleton-instansen inaktiverad.

Returvärden

Returvärden beskrivning
NX_AZURE_IOT_SUCCESS Lyckades när Azure IoT-säkerhetsmodulen har inaktiverats.
NX_AZURE_IOT_INVALID_PARAMETER Azure IoT Hub-instansen skiljer sig från den sammansatta singleton-instansen.
NX_AZURE_IOT_FAILURE Det gick inte att inaktivera Azure IoT-säkerhetsmodulen på grund av ett internt fel.

Tillåts från

Trådar

Nästa steg

Mer information om hur du kommer igång med Eclipse ThreadX Defender-IoT-micro-agent finns i följande artiklar:

  • Last updated on