次の方法で共有


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

この記事では、Microsoft Defender for IoT とパートナー サービスの統合でサポートされる API の一覧を示します。

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

手記

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

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

URI: /external/v3/integration/

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

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

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

URI パラメーター:

名前 形容 必須/省略可能
タイムスタンプ を する 結果が返される開始時刻 (エポック時間 ミリ秒、UTC タイムゾーン)。 /external/v3/integration/devices/1664781014000 必須

取得

クエリ パラメーター:

名前 形容 必須/省略可能
sensorId を する 特定のセンサーによって表示されるデバイスのみを返します。 センサー (センサーの取得) API の結果の ID 値を使用します。 1 随意
notificationType を する 返すデバイスの種類を決定します。 サポートされる値は次のとおりです。
- 0: 更新されたデバイスと新しいデバイスの両方 (既定)。
- 1: 新しいデバイスのみ。
- 2: 更新されたデバイスのみ。
2 随意
ページ 結果ページ番号の開始位置を定義します。 たとえば、= 最初のページは 0
既定値 = 0
0 随意
サイズの ページのサイズ設定を定義します。 既定値 = 50 75 随意

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

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

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

URI パラメーター:

名前 形容 必須/省略可能
タイムスタンプ を する 結果が返される開始時刻 (エポック時間 ミリ秒、UTC タイムゾーン)。 /external/v3/integration/devices/1664781014000 必須

取得

クエリ パラメーター:

名前 形容 必須/省略可能
ページ 結果ページ番号の開始位置を定義します。 たとえば、= 最初のページは 0
既定値 = 0
0 随意
サイズの ページのサイズ設定を定義します。 既定値 = 50 75 随意

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

この API は、特定のデバイス ID ごとに特定のデバイスに関するデータを返します。

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

取得

クエリ パラメーター:

名前 形容 必須/省略可能
deviceId を する オンプレミス管理コンソールで要求されたデバイスの ID 1 必須

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

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

URI: /external/v3/integration/deleteddevices/

取得

URI パラメーター:

名前 形容 必須/省略可能
タイムスタンプ を する 結果が返される開始時刻 (エポック時間 ミリ秒、UTC タイムゾーン)。 /external/v3/integration/deleteddevices/1664781014000 必須

センサー (センサーの取得)

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

URI: /external/v3/integration/sensors/

取得

URI: /sensors

クエリ パラメーターなし

devicecves (デバイス CVE の取得)

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

URI: /external/v3/integration/devicecves/

取得

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

URI パラメーター

名前 形容 必須/省略可能
タイムスタンプ を する 結果が返される開始時刻 (エポック時間 ミリ秒、UTC タイムゾーン)。 /external/v3/integration/devicecves/1664781014000 必須

クエリ パラメーター

名前 形容 必須/省略可能
ページ 結果ページ番号の開始位置を定義します。 = 最初のページは 0です。
既定値 = 0
随意
サイズの ページのサイズ設定を定義します。 既定値 = 50 随意
sensorId を する 特定のセンサー ID で定義された、特定のセンサーからの結果を表示します。 1 随意
スコア 取得する CVE の最小スコアを決定します。 すべての結果には、指定された値以上の CVE スコアがあります。 既定値 = 0です。 随意
deviceIds を する 結果を表示するデバイス ID のコンマ区切りの一覧。 例: 1232,34,2,456 随意

次の手順

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