次の方法で共有


Defender for IoT API リファレンス

このセクションでは、Microsoft Defender for IoT でサポートされるパブリック API について説明します。 Defender for IoT API は、Microsoft API ライセンスと利用規約によって管理されています。

Defender for IoT API を使用して、センサーおよびオンプレミスの管理コンソールによって検出されたデータにアクセスし、そのデータを使用してアクションを実行します。

API 接続は SSL 経由で保護されます。

API アクセス トークンを生成する

多くの Defender for IoT API にはアクセス トークンが必要です。 認証 API にはアクセス トークンは必要 "ありません"。

トークンを生成するには:

  1. [システム設定] ウィンドウで、[統合]>[アクセス トークン] を選択します。

  2. [Generate token](トークンの生成) を選択します。

  3. 新しいトークンの目的を [説明] に入力し、[生成] を選択します。

  4. アクセス トークンが表示されます。 これは二度と表示されないため、コピーしておきます。

  5. [完了] を選択します。

    • 作成したトークンは、 [アクセス トークン] ダイアログ ボックスに表示されます。 [Used] (使用日) は、このトークンを持つ外部呼び出しが最後に受信された日時を示します。

    • [Used] (使用日) フィールドに "N/A" と表示されている場合、センサーとサーバーとの間の接続が機能していません。

トークンの生成後、Authorization という名前の HTTP ヘッダーを要求に追加し、その値を生成したトークンに設定します。

Sensor API バージョン リファレンス

Version サポート対象 API
バージョンなし 認証とパスワードの管理:
- set_password (パスワードの変更)
- set_password_by_admin (管理者によるユーザー パスワードの更新)
- validation (ユーザー資格情報の検証)
バージョン 1 の新機能 インベントリ:
- connections (デバイス接続情報の取得)
- cves (CVE に関する情報の取得)
- devices (デバイス情報の取得)

アラート:
- alerts (アラート情報の取得)
- events (タイムライン イベントの取得)

脆弱性:
- operational (運用上の脆弱性の取得)
- devices (デバイスの脆弱性情報の取得)
- mitigation (軽減策の手順の取得)
- security (セキュリティの脆弱性の取得)
バージョン 2 の新機能 アラート:
- alerts (アラート情報の取得) への更新

オンプレミスの管理コンソール API バージョン リファレンス

Version API
バージョンなし 認証とパスワードの管理:
- set_password (パスワードの変更)
- set_password_by_admin (システム管理者によるユーザー パスワードの更新)
- validation (ユーザー資格情報の認証)
バージョン 1 の新機能 サイト
- appliances (OT センサー アプライアンスの管理)
インベントリ:
- devices (すべてのデバイス情報の取得)

アラート:
- alerts (アラート情報の取得)
- maintenanceWindow (アラートの除外の作成)
バージョン 2 の新機能 アラート:
- alerts (アラート情報の取得) への更新
- pcap (アラート PCAP の要求)
バージョン 3 の新機能 統合 API:
- connections (デバイス接続の取得)
- device (デバイスの詳細の取得)
- devicecves (デバイス CVE の取得)
- devices (デバイスの作成と更新)
- deleteddevices (削除されたデバイスの取得)
- sensors (センサーの取得)

Note

統合 API は、継続的に実行され、過去 5 分間の新しいデータを照会するなど、常に実行されているデータ ストリームを作成することを意図しています。 統合 API では、タイムスタンプ付きでデータが返されます。

単純にデータをクエリするには、代わりに通常の非統合 API を使用して、オンプレミスの管理コンソールですべてのデバイスをクエリするか、特定のセンサーでそのセンサーからのみデバイスをクエリします。

エポック時間

すべての Defender for IoT タイムスタンプ値では、エポック時間1970 年 1 月 1 日に等しくなります。

次のステップ

詳細については、次を参照してください。