Defender for IoT API は、 Microsoft API ライセンスと使用条件によって管理されます。
この API は、Eclipse ThreadX 用の Defender-IoT-micro-agent でのみ使用することを目的としています。 その他のリソースについては、 Eclipse ThreadX GitHub リソースの Defender-IoT-micro-agent に関するページを参照してください。
注:
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-IoT-micro-agent サブシステムが有効になります。 内部状態マシンは、セキュリティ イベントのコレクションを管理し、Azure IoT Hubに送信します。 データ収集を管理するために必要なNX_AZURE_IOT_SECURITY_MODULE インスタンスは 1 つだけです。
パラメーター
| 名前 | 説明 |
|---|---|
| nx_azure_iot_ptr [in] |
NX_AZURE_IOTへのポインター。 |
戻り値
| 戻り値 | 説明 |
|---|---|
| NX_AZURE_IOT_SUCCESS | IoT セキュリティ モジュールAzure正常に有効になりました。 |
| NX_AZURE_IOT_FAILURE | 内部エラーのため、Azure IoT セキュリティ モジュールを有効にできませんでした。 |
| NX_AZURE_IOT_INVALID_PARAMETER | セキュリティ モジュールには、有効な #NX_AZURE_IOT インスタンスが必要です。 |
許可元
スレッド
Azure IoT Defender-IoT-micro-agent を無効にする
nx_azure_iot_security_module_disable
プロトタイプ
UINT nx_azure_iot_security_module_disable(NX_AZURE_IOT *nx_azure_iot_ptr);
説明
このルーチンは、Azure IoT Defender-IoT-micro-agent サブシステムを無効にします。
パラメーター
| 名前 | 説明 |
|---|---|
| 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 セキュリティ モジュールを無効にできませんでした。 |
許可元
スレッド
次の手順
Eclipse ThreadX Defender-IoT-micro-agent の使用を開始する方法の詳細については、次の記事を参照してください。
- Defender for IoT Eclipse ThreadX Defender-IoT-micro-agent の 概要を確認します。