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 にはアクセストークンは必要 "ありません"。

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

[システム設定] ウィンドウで、[統合]>[アクセストークン] を選択します。
[Generate token](トークンの生成) を選択します。
新しいトークンの目的を [説明] に入力し、[生成] を選択します。
アクセストークンが表示されます。これは二度と表示されないため、コピーしておきます。
[完了] を選択します。
- 作成したトークンは、 [アクセストークン] ダイアログボックスに表示されます。 [Used] (使用日) は、このトークンを持つ外部呼び出しが最後に受信された日時を示します。
- [Used] (使用日) フィールドに "N/A" と表示されている場合、センサーとサーバーとの間の接続が機能していません。

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

Version	サポート対象 API
バージョンなし	認証とパスワードの管理: - set_password (パスワードの変更) - set_password_by_admin (管理者によるユーザーパスワードの更新) - validation (ユーザー資格情報の検証)
バージョン 1 の新機能	インベントリ: - connections (デバイス接続情報の取得) - cves (CVE に関する情報の取得) - devices (デバイス情報の取得) アラート: - alerts (アラート情報の取得) - events (タイムラインイベントの取得) 脆弱性: - operational (運用上の脆弱性の取得) - devices (デバイスの脆弱性情報の取得) - mitigation (軽減策の手順の取得) - security (セキュリティの脆弱性の取得)
バージョン 2 の新機能	アラート: - alerts (アラート情報の取得) への更新

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 日に等しくなります。

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