Eclipse ThreadX API 用 Defender-IoT-micro-agent (プレビュー)

Defender for IoT API は、Microsoft API ライセンスと利用規約によって管理されています。

この API は、Eclipse ThreadX 用の Defender-IoT-micro-agent でのみ使用することを目的としています。 その他のリソースについては、Eclipse ThreadX GitHub リソースの Defender-IoT-micro-agentを参照してください。

Note

Defender for IoT は、2025 年 8 月 1 日にマイクロ エージェントを廃止する予定です。

Eclipse ThreadX の Defender-IoT-micro-agent を有効にする

nx_azure_iot_security_module_enable

プロトタイプ

UINT nx_azure_iot_security_module_enable(NX_AZURE_IOT *nx_azure_iot_ptr);

説明

このルーチンでは、Azure IoT の Defender for IoT マイクロ エージェントのサブシステムを有効にします。 内部ステート マシンによってセキュリティ イベントのコレクションが管理され、それらが Azure IoT Hub に送信されます。 データ コレクションを管理するために必要なのは、1 つの NX_AZURE_IOT_SECURITY_MODULE インスタンスだけです。

パラメーター

件名	Description
nx_azure_iot_ptr [in]	NX_AZURE_IOT を指すポインター。

戻り値

戻り値	説明
NX_AZURE_IOT_SUCCESS	Azure IoT セキュリティ モジュールが正常に有効になりました。
NX_AZURE_IOT_FAILURE	内部エラーのため、Azure IoT セキュリティ モジュールを有効にできませんでした。
NX_AZURE_IOT_INVALID_PARAMETER	セキュリティ モジュールには、有効な #NX_AZURE_IOT インスタンスが必要です。

許可元

Threads

Azure IoT の Defender for IoT マイクロ エージェントを無効にする

nx_azure_iot_security_module_disable

プロトタイプ

UINT nx_azure_iot_security_module_disable(NX_AZURE_IOT *nx_azure_iot_ptr);

説明

このルーチンでは、Azure IoT の Defender for IoT マイクロ エージェントのサブシステムを無効にします。

パラメーター

件名	Description
nx_azure_iot_ptr [in]	NX_AZURE_IOT を指すポインターです。 NULL の場合、シングルトン インスタンスは無効になります。

戻り値

戻り値	説明
NX_AZURE_IOT_SUCCESS	Azure IoT セキュリティ モジュールが正常に無効にされた場合は成功です。
NX_AZURE_IOT_INVALID_PARAMETER	Azure IoT Hub インスタンスがシングルトン複合インスタンスと異なります。
NX_AZURE_IOT_FAILURE	内部エラーのため、Azure IoT セキュリティ モジュールを無効にできませんでした。

許可元

Threads

次のステップ

Eclipse ThreadX Defender-IoT-micro-agent の使用を開始する方法の詳細については、次の記事を参照してください。

• Defender for IoT Eclipse ThreadX Defender-IoT-micro-agent overviewを確認します。