デバイスウイルス対策の正常性の詳細 API のメソッドとプロパティをエクスポートする
適用対象:
Microsoft Defender ATP を試してみたいですか? 無料試用版にサインアップしてください。
注:
米国政府機関のお客様は、 Microsoft Defender for Endpoint for US Government のお客様に記載されている URI を使用してください。
ヒント
パフォーマンスを向上させるために、地理的な場所に近いサーバーを使用できます。
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
重要
この記事の一部の情報は、市販される前に大幅に変更される可能性があるプレリリース製品に関するものです。 Microsoft は、ここで提供されるいかなる情報に関して、明示または黙示を問わず、いかなる保証も行いません。
デバイス ウイルス対策の正常性の詳細 API の説明をエクスポートする
Microsoft Defender ウイルス対策デバイスの正常性の詳細のリストを取得します。 この API には、さまざまな種類のデータを取得するための異なる API 呼び出し (メソッド) があります。 データの量は大きくなる可能性があるため、取得する方法は 2 つあります。
JSON 応答 API は、組織内のすべてのデータを JSON 応答としてプルします。 この方法は、 100 K 未満のデバイスを持つ小規模な組織に最適です。 応答はページ分割されるため、応答の@odata.nextLink フィールドを使用して、次の結果をフェッチできます。
ファイル経由 この API ソリューションを使用すると、大量のデータをより迅速かつ確実にプルできます。 そのため、100 K を超えるデバイスを持つ大規模な組織におすすめです。 この API は、組織内のすべてのデータをダウンロード ファイルとしてプルします。 応答には、Azure Storage からすべてのデータをダウンロードするための URL が含まれています。 この API を使用すると、次のように Azure Storage からすべてのデータをダウンロードできます:
- すべての組織データを含むダウンロード URL の一覧を取得するには、API を呼び出します。
- ダウンロード URL を使用してすべてのファイルをダウンロードし、データを好きなように処理します。
"JSON 応答 または ファイル経由" を使用して収集されるデータは、現在の状態の現在のスナップショットです。 履歴データは含まれません。 履歴データを収集するには、お客様が独自のデータ ストレージにデータを保存する必要があります。
重要
Windows Server 2012 R2 と Windows Server 2016 をデバイス正常性レポートに表示するには、最新の統合ソリューション パッケージを使用してこれらのデバイスをオンボードする必要があります。 詳細については、「Windows Server 2012 R2 と 2016 の最新の統合ソリューションの新機能」を参照してください。
Microsoft Defender ポータルで デバイスの正常性とウイルス対策コンプライアンス レポート ツールを使用する方法については、「Microsoft Defender for Endpoint でのデバイスの正常性とウイルス対策レポート」を参照してください。
1.1 デバイスウイルス対策正常性の詳細 API メソッドをエクスポートする
| Method | データ型 | 説明 |
|---|---|---|
| (JSON 応答) | デバイス コレクションあたりの Microsoft Defender ウイルス対策の正常性。 参照: 1.2 デバイス ウイルス対策正常性の詳細 API プロパティのエクスポート (JSON 応答) | DeviceId、ConfigurationId のすべての一意の組み合わせのエントリを含むテーブルを返します。 API は、組織内のすべてのデータを JSON 応答としてプルします。 この方法は、10 万個未満のデバイスのある小規模な組織に最適です。 応答はページ分割されているため、応答の @odata.nextLink フィールドを使用して次の結果を取得できます。 |
| (ファイル経由) | デバイス コレクションあたりの Microsoft Defender ウイルス対策の正常性。 参照: 1.3 デバイスウイルス対策正常性の詳細 API プロパティのエクスポート (ファイル経由) | DeviceId、ConfigurationId のすべての一意の組み合わせのエントリを含むテーブルを返します。 この API ソリューションを使用すると、より大量のデータをより迅速かつ確実にプルできます。 そのため、100 K を超えるデバイスを持つ大規模な組織におすすめです。 この API は、組織内のすべてのデータをダウンロード ファイルとしてプルします。 応答には、Azure Storage からすべてのデータをダウンロードするための URL が含まれています。 この API を使用すると、次のように Azure Storage からすべてのデータをダウンロードできます:
|
1.2 制限事項
- 最大ページ サイズ: 200,000
- この API のレート制限: 1 分あたり 30 呼び出し、1 時間あたり 1,000 呼び出し
1.3 デバイスウイルス対策の正常性の詳細 API プロパティのエクスポート (JSON 応答)
注:
- 次のテーブルで定義されているプロパティは、プロパティ ID でアルファベット順にリスト表示されます。 この API を実行する場合、結果の出力は必ずしもこのテーブルにリストされているのと同じ順序で返されるとは限りません。
- rbacgroupname と Id は、フィルター演算子としてサポートされていないことに注意してください。
- 応答で追加の列が返される場合があります。 これらの列は一時的な場合があり、削除される場合があります。は、文書化された列のみを使用します。
| プロパティ (ID) | データ型 | 説明 | 戻り値の例 |
|---|---|---|---|
| avEngineUpdateTime | DateTimeOffset | デバイスで AV エンジンが最後に更新された日付/時刻 | "2022-08-04T12:44:02Z" |
| avEngineVersion | String | ウイルス対策エンジンのバージョン | "1.1.19400.3" |
| avIsEngineUpToDate | String | AV エンジンの最新の状態 | "True"、"False"、"Unknown" |
| avIsPlatformUpToDate | String | AV プラットフォームの最新の状態 | "True"、"False"、"Unknown" |
| avIsSignatureUpToDate | String | AV 署名の最新の状態 | "True"、"False"、"Unknown" |
| avMode | String | ウイルス対策モード。 | 各モードは、0 から 5 までの範囲の文字列型の整数値になります。 値の意味を確認するには、次のマッピングを参照してください。
|
| avPlatformUpdateTime | DateTimeOffset | デバイスで AV プラットフォームが最後に更新された日付/時刻 | "2022-08-04T12:44:02Z" |
| avPlatformVersion | String | ウイルス対策プラットフォームのバージョン | "4.18.2203.5" |
| avSignaturePublishTime | DateTimeOffset | AV セキュリティ インテリジェンス ビルドがリリースされた日付/時刻 | "2022-08-04T12:44:02Z" |
| avSignatureUpdateTime | DateTimeOffset | デバイスで AV セキュリティ インテリジェンスが最後に更新された日付/時刻 | "2022-08-04T12:44:02Z" |
| avSignatureVersion | String | ウイルス対策セキュリティ インテリジェンスのバージョン | "1.371.1323.0" |
| computerDnsName | String | DNS 名 | "SampleDns" |
| dataRefreshTimestamp | DateTimeOffset | このレポートのデータが更新される日付/時刻 | "2022-08-04T12:44:02Z" |
| fullScanError | String | フル スキャンのエラー コード | "0x80508023" |
| fullScanResult | String | このデバイスのフル スキャン結果 | "完了" "Canceled" "Failed" |
| fullScanTime | DateTimeOffset | 完全スキャンが完了した日付/時刻 | "2022-08-04T12:44:02Z" |
| id | String | マシン GUID | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
| lastSeenTime | DateTimeOffset | このマシンの最終表示日付/時刻 | "2022-08-04T12:44:02Z" |
| MachineId | String | マシン GUID | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
| osKind | String | オペレーティング システムの種類 | "windows"、"mac"、"linux" |
| osPlatform | String | オペレーティング システムのメジャー バージョン名 | Windows 10、macO |
| osVersion | String | オペレーティング システムのバージョン | 10.0.18363.1440, 12.4.0.0 |
| quickScanError | String | クイック スキャンのエラー コード | "0x80508023" |
| quickScanResult | String | このデバイスのクイック スキャン結果 | "完了" "Canceled" "Failed" |
| quickScanTime | DateTimeOffset | クイック スキャンが完了した日付/時刻 | "2022-08-04T12:44:02Z" |
| rbacGroupId | Long | このマシンが属するデバイス グループ ID | 712 |
| rbacGroupName | String | このマシンが属するデバイス グループの名前 | "SampleGroup" |
1.4 デバイスウイルス対策の正常性の詳細 API プロパティをエクスポートする (ファイル経由)
重要
このセクションの情報は、市販される前に大幅に変更される可能性があるリリース済み製品に関連しています。 Microsoft は、ここに記載された情報に関して、明示または黙示を問わず、いかなる保証も行いません。
注:
- ファイルは、複数行の JSON 形式の gzip 圧縮されています。
- ダウンロード URL は 3 時間だけ有効です。それ以外の場合は、パラメーターを使用できます。
- データの最大ダウンロード速度を確保するために、データが存在するのと同じ Azure リージョンからダウンロードしていることを確認できます。
- 各レコードは約 1 KB のデータです。 正しい pageSize パラメーターを選択するときは、これを考慮する必要があります。
- 応答で追加の列が返される場合があります。 これらの列は一時的なものであり、削除される可能性があります。ドキュメント化された列のみを使用してください。
| プロパティ (ID) | データ型 | 説明 | 戻り値の例 |
|---|---|---|---|
| ファイルをエクスポートする | array[string] | 組織の現在のスナップショットを保持しているファイルのダウンロード URL のリスト。 | ["https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"] |
| GeneratedTime | String | エクスポートが生成された時刻。 | 2022-05-20T08:00:00Z |
注:
各エクスポート ファイルには、ウイルス対策情報に関するデータを含むプロパティ "DeviceGatheredInfo" があります。 各属性は、デバイスの正常性とその状態に関する情報を提供できます。
関連項目
ヒント
さらに多くの情報を得るには、 Tech Community 内の Microsoft Security コミュニティ (Microsoft Defender for Endpoint Tech Community) にご参加ください。