Defender-IoT-micro-agent for Eclipse ThreadX API (wersja zapoznawcza)

Interfejsy API usługi Defender dla IoT podlegają licencji interfejsu API firmy Microsoft i warunkom użytkowania.

Ten interfejs API jest przeznaczony do użycia z agentem Defender-IoT-micro-agent tylko dla środowiska Eclipse ThreadX. Aby uzyskać dodatkowe zasoby, zobacz zasób usługi GitHub Defender-IoT-micro-agent for Eclipse ThreadX.

Uwaga

Defender for IoT planuje wycofać mikro agenta 1 sierpnia 2025 r.

Włączanie agenta Defender-IoT-micro-agent dla środowiska Eclipse ThreadX

nx_azure_iot_security_module_enable

Prototyp

UINT nx_azure_iot_security_module_enable(NX_AZURE_IOT *nx_azure_iot_ptr);

Opis

Ta procedura umożliwia Azure podsystemu IoT Defender-IoT-micro-agent. Maszyna stanu wewnętrznego zarządza kolekcją zdarzeń zabezpieczeń i wysyła je do Azure IoT Hub. Do zarządzania zbieraniem danych jest wymagane tylko jedno wystąpienie NX_AZURE_IOT_SECURITY_MODULE.

Parametry

Name (Nazwa) Opis
nx_azure_iot_ptr [w] Wskaźnik do elementu NX_AZURE_IOT.

Zwracane wartości

Zwracane wartości Opis
NX_AZURE_IOT_SUCCESS Pomyślnie włączono Azure modułu zabezpieczeń IoT.
NX_AZURE_IOT_FAILURE Nie można włączyć modułu zabezpieczeń Azure IoT z powodu błędu wewnętrznego.
NX_AZURE_IOT_INVALID_PARAMETER Moduł zabezpieczeń wymaga prawidłowego wystąpienia #NX_AZURE_IOT.

Dozwolone z

Wątków

Wyłącz 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);

Opis

Ta procedura wyłącza podsystem Azure IoT Defender-IoT-micro-agent.

Parametry

Name (Nazwa) Opis
nx_azure_iot_ptr [w] Wskaźnik do .NX_AZURE_IOT Jeśli wartość NULL pojedynczego wystąpienia jest wyłączona.

Zwracane wartości

Zwracane wartości Opis
NX_AZURE_IOT_SUCCESS Po pomyślnym wyłączeniu modułu zabezpieczeń Azure IoT.
NX_AZURE_IOT_INVALID_PARAMETER Azure IoT Hub wystąpienie różni się od pojedynczego wystąpienia złożonego.
NX_AZURE_IOT_FAILURE Nie można wyłączyć modułu zabezpieczeń Azure IoT z powodu błędu wewnętrznego.

Dozwolone z

Wątków

Następne kroki

Aby dowiedzieć się więcej na temat rozpoczynania pracy z usługą Eclipse ThreadX Defender-IoT-micro-agent, zobacz następujące artykuły:

  • Zapoznaj się z omówieniem usługi Defender for IoT Eclipse ThreadX Defender-IoT-micro-agent.