オンプレミス管理コンソールの統合 API リファレンス (パブリック プレビュー)

この記事では、Microsoft Defender for IoT をパートナー サービスと統合するためにサポートされている API について説明します。

たとえば、この API は現在、ServiceNow の Defender for IoT 用の Service Graph Connector を介して、チュートリアル: ServiceNow を Microsoft Defender for IoT で実装されています。

注意

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

単純にデータに対してクエリを実行するには、通常の非統合 API を代わりに使用し、オンプレミスの管理コンソールですべてのデバイスをクエリするか、特定のセンサーでそのセンサーからのみのデバイスをクエリします。 詳細については、「Defender for IoT API リファレンス」を参照してください。

URI: /external/v3/integration/

devices (デバイスの作成と更新)

この API からは、指定したタイムスタンプより後に更新されたすべてのデバイスに関するデータが返されます。

URI: /external/v3/integration/devices/<timestamp>

URI パラメーター:

名前 説明 必須/省略可能
timestamp 結果が返される開始時刻 (エポック時間からのミリ秒、UTC タイムゾーン)。 /external/v3/integration/devices/1664781014000 必須

GET

クエリ パラメーター:

名前 説明 必須/省略可能
sensorId 特定のセンサーで確認されるデバイスのみを返します。 sensors (センサーの取得) API の結果の ID 値を使用します。 1 オプション
notificationType 返すデバイスの種類を決定します。 サポートされている値は次のとおりです。
- 0: 更新と新規デバイスの両方 (既定値)。
- 1: 新規デバイスのみ。
- 2: 更新されたデバイスのみ。
2 オプション
page 結果ページの番号付けが開始される番号を定義します。 たとえば、0 であれば、最初のページは 0 です。
既定値 = 0
0 オプション
size ページのサイズ設定を定義します。 既定値 = 50 75 オプション

connections (デバイス接続の取得)

この API からは、指定したタイムスタンプより後に更新されたすべてのデバイス接続に関するデータが返されます。

URI: /external/v3/integration/connections/<timestamp>

URI パラメーター:

名前 説明 必須/省略可能
timestamp 結果が返される開始時刻 (エポック時間からのミリ秒、UTC タイムゾーン)。 /external/v3/integration/devices/1664781014000 必須

GET

クエリ パラメーター:

名前 説明 必須/省略可能
page 結果ページの番号付けが開始される番号を定義します。 たとえば、0 であれば、最初のページは 0 です。
既定値 = 0
0 オプション
size ページのサイズ設定を定義します。 既定値 = 50 75 オプション

device (デバイスの詳細の取得)

この API からは、指定したデバイス ID ごとに、特定のデバイスに関するデータが返されます。

URI: /external/v3/integration/device/{deviceId}

GET

クエリ パラメーター:

名前 説明 必須/省略可能
deviceId オンプレミス管理コンソール上の要求されたデバイスの ID 1 必須

deleteddevices (削除されたデバイスの取得)

この API は、指定されたタイムスタンプから、最近削除されたデバイスの ID 一覧を返します。

URI: /external/v3/integration/deleteddevices/

GET

URI パラメーター:

名前 説明 必須/省略可能
timestamp 結果が返される開始時刻 (エポック時間からのミリ秒、UTC タイムゾーン)。 /external/v3/integration/deleteddevices/1664781014000 必須

sensors (センサーの取得)

この API は、接続されている OT ネットワーク センサーのセンサー オブジェクトの一覧を返します。

URI: /external/v3/integration/sensors/

GET

URI: /sensors

クエリ パラメーターなし

devicecves (デバイス CVE の取得)

この API は、指定されたタイムスタンプ以降に更新されたすべてのデバイスのアクティブな CVE 一覧を返します。

URI: /external/v3/integration/devicecves/

GET

URI: /external/v3/integration/devicecves/<timestamp>

URI パラメーター

名前 説明 必須/省略可能
timestamp 結果が返される開始時刻 (エポック時間からのミリ秒、UTC タイムゾーン)。 /external/v3/integration/devicecves/1664781014000 必須

クエリ パラメーター

名前 説明 必須/省略可能
page 結果ページの番号付けが開始される番号を定義します。 0 であれば、最初のページは 0 です。
既定値 = 0
オプション
size ページのサイズ設定を定義します。 既定値 = 50 オプション
sensorId 指定したセンサー ID で定義されている特定のセンサーの結果を示します。 1 省略可能
スコア 取得する CVE スコアの最小値を決定します。 すべての結果で、指定された値以上の CVE スコアになります。 既定値 = 0 オプション
deviceIds 結果を表示するデバイス ID のコンマ区切りリスト。 例: 1232,34,2,456 オプション

次のステップ

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