デバイスごとに評価方法とプロパティをエクスポートする
適用対象:
- Microsoft Defender for Endpoint Plan 1
- Microsoft Defender for Endpoint Plan 2
- Microsoft Defender 脆弱性の管理
- Microsoft Defender XDR
Microsoft Defender ATP を試してみたいですか? 無料試用版にサインアップしてください。
API の説明
デバイスごとに脆弱性管理データをプルする API に関するメソッドとプロパティの詳細を提供します。 さまざまな種類のデータを取得するためのさまざまな API 呼び出しがあります。 一般に、各 API 呼び出しには、organization内のデバイスに必要なデータが含まれています。
注:
特に明記されていない限り、一覧表示されているすべてのエクスポート評価方法は 、完全なエクスポート と デバイス別 ( デバイス別とも呼ばれます) です。
エクスポート評価 API を使用して、さまざまな種類の情報を取得 (エクスポート) できます。
- 1. セキュリティで保護された構成評価をエクスポートする
- 2. ソフトウェア インベントリ評価のエクスポート
- 3. ソフトウェアの脆弱性評価をエクスポートする
- 4. 製品コード以外のソフトウェア インベントリ評価をエクスポートする
エクスポート情報の種類に対応する API については、セクション 1、2、および 3 で説明します。
各メソッドには、さまざまな種類のデータを取得するための異なる API 呼び出しがあります。 データの量は大きくなる可能性があるため、取得する方法は 2 つあります。
JSON 応答API は、organization内のすべてのデータを JSON 応答としてプルします。 この方法は、 100 K 未満のデバイスを持つ小規模な組織に最適です。 応答はページ分割されるため、応答の@odata.nextLink フィールドを使用して、次の結果をフェッチできます。
ファイル経由 この API ソリューションを使用すると、大量のデータをより迅速かつ確実にプルできます。 そのため、100 K を超えるデバイスを持つ大規模な組織におすすめです。 この API は、組織内のすべてのデータをダウンロード ファイルとしてプルします。 応答には、Azure Storage からすべてのデータをダウンロードするための URL が含まれています。 この API を使用すると、次のように Azure Storage からすべてのデータをダウンロードできます:
- すべての組織データを含むダウンロード URL の一覧を取得するには、API を呼び出します。
- ダウンロード URL を使用してすべてのファイルをダウンロードし、データを好きなように処理します。
"JSON 応答 または ファイル経由" を使用して収集されるデータは、現在の状態の現在のスナップショットです。 履歴データは含まれません。 履歴データを収集するには、お客様が独自のデータ ストレージにデータを保存する必要があります。
1. セキュリティで保護された構成評価をエクスポートする
デバイスごとに、すべての構成とその状態を返します。
1.1 メソッド
| Method | データ型 | 説明 |
|---|---|---|
| デバイスコレクションによるセキュリティで保護された構成。 参照: 1.2 プロパティ (JSON 応答) | DeviceId、ConfigurationId のすべての一意の組み合わせのエントリを含むテーブルを返します。 API は、組織内のすべてのデータを JSON 応答としてプルします。 この方法は、10 万個未満のデバイスのある小規模な組織に最適です。 応答はページ分割されるため、応答のフィールドを @odata.nextLink 使用して次の結果をフェッチできます。 | |
| デバイスコレクションによるセキュリティで保護された構成。 参照: 1.3 プロパティ (ファイル経由) | DeviceId、ConfigurationId のすべての一意の組み合わせのエントリを含むテーブルを返します。 この API ソリューションを使用すると、より大量のデータをより迅速かつ確実にプルできます。 そのため、100 K を超えるデバイスを持つ大規模な組織におすすめです。 この API は、組織内のすべてのデータをダウンロード ファイルとしてプルします。 応答には、Azure Storage からすべてのデータをダウンロードするための URL が含まれています。 この API を使用すると、次のように Azure Storage からすべてのデータをダウンロードできます:
|
1.2 プロパティ (JSON 応答)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| configurationCategory | String | 構成が属するカテゴリまたはグループ: アプリケーション、OS、ネットワーク、アカウント、セキュリティ コントロール。 |
| configurationId | String | 特定の構成の一意識別子。 |
| configurationImpact | String | 構成の全体的な構成スコアに対する評価された効果 (1 から 10)。 |
| configurationName | String | 構成の表示名。 |
| configurationSubcategory | String | 構成が属するサブカテゴリまたはサブグループ。 多くの場合、特定の機能または機能。 |
| deviceId | String | サービス内のデバイスの一意の識別子。 |
| deviceName | String | デバイスの完全修飾ドメイン名 (FQDN)。 |
| isApplicable | ブール | 構成またはポリシーが適用可能かどうかを示します。 |
| isCompliant | ブール | 構成またはポリシーが適切に構成されているかどうかを示します。 |
| isExpectedUserImpact | ブール | 構成が適用される場合にユーザーが影響を受けるかどうかを示します。 |
| osPlatform | String | デバイスで実行されているオペレーティング システムのプラットフォーム。 Windows 10やWindows 11など、同じファミリ内のバリエーションを持つ特定のオペレーティング システム。 詳細については 、「サポートされているオペレーティング システム、プラットフォーム、機能 」を参照してください。 |
| osVersion | String | デバイスで実行されているオペレーティング システムの特定のバージョン。 |
| rbacGroupName | String | ロールベースのアクセス制御 (RBAC) グループ。 デバイスが RBAC グループに割り当てられていない場合、値は "未割り当て" になります。organizationに RBAC グループが含まれていない場合、値は "None" になります。 |
| rbacGroupId | String | ロールベースのアクセス制御 (RBAC) グループ ID。 |
| recommendationReference | String | ソフトウェアに関連する推奨事項 ID への参照。 |
| timestamp | String | デバイスで構成が最後に表示された時刻。 |
1.3 プロパティ (ファイル経由)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| ファイルをエクスポートする | array[string] | 組織の現在のスナップショットを保持しているファイルのダウンロード URL のリスト。 |
| GeneratedTime | String | エクスポートが生成された時刻。 |
2. ソフトウェア インベントリ評価のエクスポート
インストールされているすべてのソフトウェアとその詳細を各デバイスに返します。
2.1 メソッド
| Method | データ型 | 説明 |
|---|---|---|
| ソフトウェア インベントリ評価 のエクスポート (JSON 応答) | デバイス コレクション別のソフトウェア インベントリ。 参照: 2.2 プロパティ (JSON 応答) | DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion のすべての一意の組み合わせのエントリを持つテーブルを返します。 API は、組織内のすべてのデータを JSON 応答としてプルします。 この方法は、10 万個未満のデバイスのある小規模な組織に最適です。 応答はページ分割されるため、応答のフィールドを @odata.nextLink 使用して次の結果をフェッチできます。 |
| ソフトウェア インベントリ評価 のエクスポート (ファイル経由) | デバイス ファイル別のソフトウェア インベントリ。 参照: 2.3 プロパティ (ファイル経由) | DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion のすべての一意の組み合わせのエントリを持つテーブルを返します。 この API ソリューションを使用すると、より大量のデータをより迅速かつ確実にプルできます。 そのため、100 K を超えるデバイスを持つ大規模な組織におすすめです。 この API は、組織内のすべてのデータをダウンロード ファイルとしてプルします。 応答には、Azure Storage からすべてのデータをダウンロードするための URL が含まれています。 この API を使用すると、次のように Azure Storage からデータをダウンロードできます。
|
2.2 プロパティ (JSON 応答)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| DeviceId | String | サービス内のデバイスの一意の識別子。 |
| DeviceName | String | デバイスの完全修飾ドメイン名 (FQDN)。 |
| DiskPaths | Array[string] | デバイスに製品がインストールされていることを示すディスク証拠。 |
| EndOfSupportDate | String | このソフトウェアのサポートが終了する日付。 |
| EndOfSupportStatus | String | サポート終了の状態。 次の値を含めることができます:None、EOS バージョン、今後の EOS バージョン、EOS ソフトウェア、今後の EOS ソフトウェア。 |
| NumberOfWeaknesses | Int | このデバイス上のこのソフトウェアの弱点の数。 |
| OSPlatform | String | デバイスで実行されているオペレーティング システムのプラットフォーム。Windows 10やWindows 11など、同じファミリ内のバリエーションを持つ特定のオペレーティング システム。 詳細については 、「サポートされているオペレーティング システム、プラットフォーム、機能 」を参照してください。 |
| RbacGroupName | String | ロールベースのアクセス制御 (RBAC) グループ。 このデバイスが RBAC グループに割り当てられていない場合、値は "未割り当て" になります。organizationに RBAC グループが含まれていない場合、値は "None" になります。 |
| rbacGroupId | String | ロールベースのアクセス制御 (RBAC) グループ ID。 |
| RegistryPaths | Array[string] | 製品がデバイスにインストールされていることを示すレジストリの証拠。 |
| SoftwareFirstSeenTimestamp | String | このソフトウェアがデバイスで初めて見られた時。 |
| SoftwareName | String | ソフトウェア製品の名前。 |
| SoftwareVendor | String | ソフトウェア ベンダーの名前。 |
| SoftwareVersion | String | ソフトウェア製品のバージョン番号。 |
2.3 プロパティ (ファイル経由)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| ファイルをエクスポートする | array[string] | 組織の現在のスナップショットを保持しているファイルのダウンロード URL のリスト。 |
| GeneratedTime | String | エクスポートが生成された時刻。 |
3. ソフトウェアの脆弱性評価をエクスポートする
すべてのデバイスについて、デバイス上のすべての既知の脆弱性とその詳細を返します。
3.1 メソッド
| Method | データ型 | 説明 |
|---|---|---|
| 調査コレクション参照: 3.2 プロパティ (JSON 応答) | DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion、CveId のすべての一意の組み合わせのエントリを含むテーブルを返します。 API は、組織内のすべてのデータを JSON 応答としてプルします。 この方法は、10 万個未満のデバイスのある小規模な組織に最適です。 応答はページ分割されるため、応答のフィールドを @odata.nextLink 使用して次の結果をフェッチできます。 | |
| 調査エンティティ参照: 3.3 プロパティ (ファイル経由) | DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion、CveId のすべての一意の組み合わせのエントリを含むテーブルを返します。 この API ソリューションを使用すると、より大量のデータをより迅速かつ確実にプルできます。 そのため、100 K を超えるデバイスを持つ大規模な組織におすすめです。 この API は、組織内のすべてのデータをダウンロード ファイルとしてプルします。 応答には、Azure Storage からすべてのデータをダウンロードするための URL が含まれています。 この API を使用すると、次のように Azure Storage からすべてのデータをダウンロードできます:
|
|
| 調査コレクション参照: 3.4 プロパティ デルタ エクスポート (JSON 応答) | DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion、CveId、EventTimestamp の一意の組み合わせごとにエントリを含むテーブルを返します。 API は、organization内のデータを JSON 応答としてプルします。 応答はページ分割されるため、応答のフィールドを @odata.nextLink 使用して次の結果をフェッチできます。 完全なソフトウェア脆弱性評価 (JSON 応答) は、デバイスごとのorganizationのソフトウェア脆弱性評価のスナップショット全体を取得するために使用されます。 ただし、デルタ エクスポート API 呼び出しは、選択した日付と現在の日付 ("delta" API 呼び出し) の間で発生した変更のみをフェッチするために使用されます。 毎回大量のデータを含む完全なエクスポートを取得する代わりに、新しい、修正された、更新された脆弱性に関する特定の情報のみを取得します。 デルタ エクスポート API 呼び出しを使用して、"修正された脆弱性の数" や "organization に追加された新しい脆弱性の数" などのさまざまな KPI を計算することもできます。 ソフトウェアの脆弱性に対する Delta export API 呼び出しでは、対象の日付範囲についてのみデータが返されるため、 完全なエクスポートとは見なされません。 |
3.2 プロパティ (JSON 応答)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| CveId | String | 一般的な脆弱性と公開 (CVE) システムのセキュリティの脆弱性に割り当てられた一意の識別子。 |
| CvssScore | String | CVE の CVSS スコア。 |
| DeviceId | String | サービス内のデバイスの一意の識別子。 |
| DeviceName | String | デバイスの完全修飾ドメイン名 (FQDN)。 |
| DiskPaths | Array[string] | デバイスに製品がインストールされていることを示すディスク証拠。 |
| ExploitabilityLevel | String | この脆弱性の悪用可能性レベル (NoExploit、ExploitIsPublic、ExploitIsVerified、ExploitIsInKit) |
| FirstSeenTimestamp | String | この製品の CVE がデバイスに初めて表示されたとき。 |
| Id | String | レコードの一意識別子。 |
| LastSeenTimestamp | String | 前回、CVE がデバイスに表示されました。 |
| OSPlatform | String | デバイスで実行されているオペレーティング システムのプラットフォーム。Windows 10やWindows 11など、同じファミリ内のバリエーションを持つ特定のオペレーティング システム。 詳細については 、「サポートされているオペレーティング システム、プラットフォーム、機能 」を参照してください。 |
| RbacGroupName | String | ロールベースのアクセス制御 (RBAC) グループ。 このデバイスが RBAC グループに割り当てられていない場合、値は "未割り当て" になります。organizationに RBAC グループが含まれていない場合、値は "None" になります。 |
| rbacGroupId | String | ロールベースのアクセス制御 (RBAC) グループ ID。 |
| RecommendationReference | String | このソフトウェアに関連する推奨事項 ID への参照。 |
| RecommendedSecurityUpdate | String | ソフトウェア ベンダーが脆弱性に対処するために提供するセキュリティ更新プログラムの名前または説明。 |
| RecommendedSecurityUpdateId | String | 該当するセキュリティ更新プログラムの識別子、または対応するガイダンスまたはサポート情報 (KB) 記事の識別子。 |
| レジストリ パス | Array[string] | 製品がデバイスにインストールされていることを示すレジストリの証拠。 |
| SecurityUpdateAvailable | ブール型 | ソフトウェアでセキュリティ更新プログラムを使用できるかどうかを示します。 |
| SoftwareName | String | ソフトウェア製品の名前。 |
| SoftwareVendor | String | ソフトウェア ベンダーの名前。 |
| SoftwareVersion | String | ソフトウェア製品のバージョン番号。 |
| VulnerabilitySeverityLevel | String | CVSS スコアに基づいてセキュリティの脆弱性に割り当てられる重大度レベル。 |
3.3 プロパティ (ファイル経由)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| ファイルをエクスポートする | array[string] | 組織の現在のスナップショットを保持しているファイルのダウンロード URL のリスト。 |
| GeneratedTime | String | エクスポートが生成された時刻。 |
3.4 プロパティ (デルタ エクスポート JSON 応答)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| CveId | String | 一般的な脆弱性と公開 (CVE) システムのセキュリティの脆弱性に割り当てられた一意の識別子。 |
| CvssScore | String | CVE の CVSS スコア。 |
| DeviceId | String | サービス内のデバイスの一意の識別子。 |
| DeviceName | String | デバイスの完全修飾ドメイン名 (FQDN)。 |
| DiskPaths | Array[string] | デバイスに製品がインストールされていることを示すディスク証拠。 |
| EventTimestamp | String | デルタ イベントが見つかった時刻。 |
| ExploitabilityLevel | String | 脆弱性の悪用可能性レベル (NoExploit、ExploitIsPublic、ExploitIsVerified、ExploitIsInKit) |
| FirstSeenTimestamp | String | デバイスに製品の CVE が初めて表示されたとき。 |
| Id | String | レコードの一意識別子。 |
| LastSeenTimestamp | String | 前回、CVE がデバイスに表示されました。 |
| OSPlatform | String | デバイスで実行されているオペレーティング システムのプラットフォーム。Windows 10やWindows 11など、同じファミリ内のバリエーションを持つ特定のオペレーティング システム。 詳細については 、「サポートされているオペレーティング システム、プラットフォーム、機能 」を参照してください。 |
| RbacGroupName | String | ロールベースのアクセス制御 (RBAC) グループ。 このデバイスが RBAC グループに割り当てられていない場合、値は "未割り当て" になります。organizationに RBAC グループが含まれていない場合、値は "None" になります。 |
| RecommendationReference | String | このソフトウェアに関連する推奨事項 ID への参照。 |
| RecommendedSecurityUpdate | String | ソフトウェア ベンダーが脆弱性に対処するために提供するセキュリティ更新プログラムの名前または説明。 |
| RecommendedSecurityUpdateId | String | 該当するセキュリティ更新プログラムの識別子、または対応するガイダンスまたはサポート情報 (KB) 記事の識別子 |
| RegistryPaths | Array[string] | 製品がデバイスにインストールされていることを示すレジストリの証拠。 |
| SoftwareName | String | ソフトウェア製品の名前。 |
| SoftwareVendor | String | ソフトウェア ベンダーの名前。 |
| SoftwareVersion | String | ソフトウェア製品のバージョン番号。 |
| 状態 | String | New (デバイスに導入された新しい脆弱性の場合)。 修正済み (デバイスに存在しなくなった脆弱性の場合は、修復されたことを意味します)。 更新 ( 変更されたデバイスの脆弱性の場合)。可能な変更は、CVSS スコア、悪用可能性レベル、重大度レベル、DiskPaths、RegistryPaths、RecommendedSecurityUpdate) です。 |
| VulnerabilitySeverityLevel | String | CVSS スコアに基づいてセキュリティの脆弱性に割り当てられた重大度レベル。 |
4. 製品コード以外のソフトウェア インベントリ評価をエクスポートする
共通プラットフォーム列挙 (CPE) と各デバイスの詳細を持たない、インストールされているすべてのソフトウェアを返します。
4.1 メソッド
| Method | データ型 | 説明 |
|---|---|---|
| 製品コード以外のソフトウェア インベントリ評価 のエクスポート (JSON 応答) | デバイスコレクション別の製品コード以外のソフトウェア インベントリ。 参照: 4.2 プロパティ (JSON 応答) | DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion のすべての一意の組み合わせのエントリを持つテーブルを返します。 API は、組織内のすべてのデータを JSON 応答としてプルします。 この方法は、10 万個未満のデバイスのある小規模な組織に最適です。 応答はページ分割されるため、応答のフィールドを @odata.nextLink 使用して次の結果をフェッチできます。 |
| 製品コード以外のソフトウェア インベントリ評価 をエクスポートする (ファイル経由) | デバイス ファイル別の製品コード 以外のソフトウェア インベントリ。 参照: 4.3 プロパティ (ファイル経由) | DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion のすべての一意の組み合わせのエントリを持つテーブルを返します。 この API ソリューションを使用すると、より大量のデータをより迅速かつ確実にプルできます。 そのため、100 K を超えるデバイスを持つ大規模な組織におすすめです。 この API は、組織内のすべてのデータをダウンロード ファイルとしてプルします。 応答には、Azure Storage からすべてのデータをダウンロードするための URL が含まれています。 この API を使用すると、次のように Azure Storage からデータをダウンロードできます。
|
4.2 プロパティ (JSON 応答)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| DeviceId | string | サービス内のデバイスの一意の識別子。 |
| DeviceName | string | デバイスの完全修飾ドメイン名 (FQDN)。 |
| OSPlatform | string | デバイスで実行されているオペレーティング システムのプラットフォーム。 これらは、Windows 10やWindows 11など、同じファミリ内のバリエーションを持つ特定のオペレーティング システムです。 詳細については 、「サポートされているオペレーティング システム、プラットフォーム、機能 」を参照してください。 |
| RbacGroupName | string | ロールベースのアクセス制御 (RBAC) グループ。 このデバイスが RBAC グループに割り当てられていない場合、値は "未割り当て" になります。organizationに RBAC グループが含まれていない場合、値は "None" になります。 |
| RbacGroupId | string | ロールベースのアクセス制御 (RBAC) グループ ID。 |
| SoftwareLastSeenTimestamp | string | このソフトウェアがデバイスで最後に見られた時刻。 |
| SoftwareName | string | ソフトウェア製品の名前。 |
| SoftwareVendor | string | ソフトウェア ベンダーの名前。 |
| SoftwareVersion | 文字列 | ソフトウェア製品のバージョン番号。 |
4.3 プロパティ (ファイル経由)
| プロパティ (ID) | データ型 | 説明 |
|---|---|---|
| ファイルをエクスポートする | array[string] | 組織の現在のスナップショットを保持しているファイルのダウンロード URL のリスト。 |
| GeneratedTime | String | エクスポートが生成された時刻。 |
関連項目
- デバイスごとのセキュリティで保護された構成評価をエクスポートする
- デバイスごとのソフトウェア インベントリ評価のエクスポート
- デバイスごとのソフトウェア脆弱性評価のエクスポート
- デバイスごとに非 cpe ソフトウェア インベントリ評価をエクスポートする
その他の関連
ヒント
さらに多くの情報を得るには、 Tech Community 内の Microsoft Security コミュニティ (Microsoft Defender for Endpoint Tech Community) にご参加ください。