デバイスごとに製品コード以外のソフトウェア インベントリ評価をエクスポートする

  • [アーティクル]

適用対象:

Microsoft Defender ATP を試してみたいですか? 無料試用版にサインアップしてください。

この API は、 Common Platform Enum(CPE) を持たないインストール済みソフトウェアのすべてのデータを、デバイスごとに返します。 この API によって返される情報と、CPE を持つソフトウェアのエクスポート ソフトウェア インベントリ評価 API によって返される情報は、organization全体にインストールされているソフトウェアとインストールされているデバイスを完全に把握できます。

注:

CPE を使用しないソフトウェア製品は、脆弱性管理ではサポートされていません。 これらはソフトウェア インベントリ ページに表示されますが、CVE は脆弱性管理によってソフトウェアを識別するために使用されるため、脆弱性、脆弱性、悪用、公開されたデバイスの数、弱点などの情報は使用できません。 詳細については、「 ソフトウェア インベントリ」を参照してください。

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. 製品コード以外のソフトウェア インベントリ評価をエクスポートする (JSON 応答)

1.1 API メソッドの説明

この API 応答には、デバイスごとに 共通プラットフォーム列挙 (CPE) がないインストール済みソフトウェアのすべてのデータが含まれています。 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion のすべての一意の組み合わせのエントリを持つテーブルを返します。

制限事項

  • 最大ページ サイズは 200,000 です。
  • この API のレート制限は、1 分あたり 30 呼び出しと 1 時間あたり 1000 呼び出しです。

1.2 アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法など、詳細については、「Microsoft Defender for Endpoint API を使用する」を参照してください。

アクセス許可の種類 アクセス許可 アクセス許可の表示名
アプリケーション Software.Read.All '脅威と脆弱性管理ソフトウェア情報の読み取り'
委任 (職場または学校のアカウント) Software.Read '脅威と脆弱性管理ソフトウェア情報の読み取り'

1.3 URL

GET /api/machines/SoftwareInventoryNoProductCodeByMachine

1.4 パラメーター

  • pageSize (既定値 = 50,000): 応答の結果の数。
  • $top: 返す結果の数 (返されない @odata.nextLink ので、すべてのデータをプルしない)

1.5 プロパティ

注:

  • 各レコードのデータは約 0.5 KB です。 正しい pageSize パラメーターを選択するときは、これを考慮する必要があります。
  • 次のテーブルで定義されているプロパティは、プロパティ ID でアルファベット順にリスト表示されます。 この API を実行する場合、結果の出力は必ずしもこのテーブルにリストされているのと同じ順序で返されるとは限りません。
  • 応答で追加の列が返される場合があります。 これらの列は一時的なものであり、削除される可能性があります。ドキュメント化された列のみを使用してください。

プロパティ (ID) データ型 説明
DeviceId 文字列 サービス内のデバイスの一意の識別子。
DeviceName string デバイスの完全修飾ドメイン名 (FQDN)。
OSPlatform string デバイスで実行されているオペレーティング システムのプラットフォーム。 これらは、Windows 10やWindows 11など、同じファミリ内のバリエーションを持つ特定のオペレーティング システムです。 詳細については 、「サポートされているオペレーティング システム、プラットフォーム、機能 」を参照してください。
RbacGroupName 文字列 ロールベースのアクセス制御 (RBAC) グループ。 このデバイスが RBAC グループに割り当てられていない場合、値は "未割り当て" になります。organizationに RBAC グループが含まれていない場合、値は "None" になります。
RbacGroupId string ロールベースのアクセス制御 (RBAC) グループ ID。
SoftwareLastSeenTimestamp string このソフトウェアがデバイスで最後に見られた時刻。
SoftwareName string ソフトウェア製品の名前。
SoftwareVendor string ソフトウェア ベンダーの名前。
SoftwareVersion string ソフトウェア製品のバージョン番号。

1.6 例

1.6.1 要求の例

https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryNoProductCodeByMachine?pageSize=3  &sinceTime=2021-05-19

1.6.2 応答の例

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetNonCpeSoftware)",
    "value": [
        {
           "deviceId": "1234512345123451234512345",
            "rbacGroupId": 11,
            "rbacGroupName": "London",
            "deviceName": "Device1",
            "osPlatform": "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "vs_communitymsi",
            "softwareVersion": "11.11.31111.1",
            "softwareLastSeenTimestamp": "2021-01-30 11:31:12.271"
        },
        {
            "deviceId": "232323232323232322323232323",
            "rbacGroupId": 23,
            "rbacGroupName": "Tokyo",
            "deviceName": "Device23",
            "osPlatform": "Windows10",
            "softwareVendor": "intel",
            "softwareName": "intel®_software_installer",
            "softwareVersion": "22.20.2.2",
            "softwareLastSeenTimestamp": "2022-05-30 15:35:12.271"
        },
        {
            "deviceId": "6565656565",
            "rbacGroupId": 65,
            "rbacGroupName": "Center",
            "deviceName": "Device56",
            "osPlatform": "Windows10",
            "softwareVendor": "Lob Apps",
            "softwareName": "Headtrax",
            "softwareVersion": "60.273.3",
            "softwareLastSeenTimestamp": "2022-05-05 15:35:12.271"
        },
    ],
        "@odata.nextLink": "https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryNoProductCodeByMachine?pagesize=3%20%20&sincetime=2021-05-19&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMi0wNS0zMC8xMTAxLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}

2. 製品コード以外のソフトウェア インベントリ評価をエクスポートする (ファイル経由)

2.1 API メソッドの説明

この API 応答には、デバイスごとに 共通プラットフォーム列挙 (CPE) がないインストール済みソフトウェアのすべてのデータが含まれています。 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion のすべての一意の組み合わせのエントリを持つテーブルを返します。

2.1.1 制限事項

この API のレート制限は、1 分あたり 5 回の呼び出しと 1 時間あたり 20 回の呼び出しです。

2.2 権限

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法など、詳細については、「Microsoft Defender for Endpoint API を使用する」を参照してください。

アクセス許可の種類 アクセス許可 アクセス許可の表示名
アプリケーション Software.Read.All '脅威と脆弱性管理ソフトウェア情報の読み取り'
委任 (職場または学校のアカウント) Software.Read '脅威と脆弱性管理ソフトウェア情報の読み取り'

2.3 URL

GET /api/machines/SoftwareInventoryNonCpeExport

パラメーター

  • sasValidHours: ダウンロード URL が有効になる時間数 (最大 24 時間)

2.5 プロパティ

注:

  • ファイルは複数行の JSON 形式で gzip 圧縮 & されます。
  • ダウンロード URL は 3 時間のみ有効です。 それ以外の場合は、 パラメーターを使用できます。
  • データの最大ダウンロード速度を確保するために、データが存在するのと同じ Azure リージョンからダウンロードしていることを確認できます。

プロパティ (ID) データ型 説明 戻り値の例
ファイルをエクスポートする array[string] organizationの現在のスナップショットを保持しているファイルのダウンロード URL の一覧 "[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime string エクスポートが生成された時刻。 2021-05-20T08:00:00Z

2.6 例

2.6.1 要求の例

GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryNonCpeExport

2.6.2 応答の例

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00337-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=aHnmuOKlIvpR0PsdamYfmCCDZ1nhpuXBzK2%2FkJ9xTpg%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00338-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=0fQg%2Ft469x26KvPLmvctLl0g6DC38CNM3lXYi9dnFfo%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00339-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=P6HGHoLXXipMauBpLueoQVrwHL7qmvLoCjcij6ERx8o%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00340-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=VnpVct%2F8vdiIFTf2xXP9DF7ngWv1Zqew30q2jBPVghg%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00341-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=GY0zxMfEmr9v9fZBWYyKEtT2k%2F0ELQIlOP0ct%2B6SdGU%3D",
    ],
    "generatedTime": "2022-05-30T11:01:00Z"
}

関連項目

その他の関連

ヒント

さらに多くの情報を得るには、 Tech Community 内の Microsoft Security コミュニティ (Microsoft Defender for Endpoint Tech Community) にご参加ください。