Export posouzení inventáře softwaru na zařízení

Platí pro:

Chcete vyzkoušet Defender pro Endpoint? Zaregistrujte se a získejte bezplatnou zkušební verzi,

Toto rozhraní API vrací všechna data pro nainstalovaný software, který má common platform enumeration (CPE) na základě jednotlivých zařízení.

Různá volání rozhraní API získávají různé typy dat. Vzhledem k tomu, že množství dat může být velké, můžete je načíst dvěma způsoby:

  • Export odpovědi JSON pro posouzení inventáře softwaru Rozhraní API natáhne všechna data ve vaší organizaci jako odpovědi JSON. Tato metoda je nejvhodnější pro malé organizace s méně než 100 tisíci zařízeními. Odpověď je stránkovaná, takže k načtení dalších výsledků můžete použít pole @odata.nextLink z odpovědi.

  • Export posouzení inventáře softwaru prostřednictvím souborů Toto řešení rozhraní API umožňuje rychlejší a spolehlivější načítání větších objemů dat. Proto se doporučuje pro velké organizace s více než 100K zařízeními. Toto rozhraní API natahuje všechna data ve vaší organizaci jako soubory ke stažení. Odpověď obsahuje adresy URL pro stažení všech dat ze služby Azure Storage. Toto rozhraní API umožňuje stáhnout všechna data ze služby Azure Storage následujícím způsobem:

    • Voláním rozhraní API získáte seznam adres URL ke stažení se všemi daty vaší organizace.
    • Stáhněte si všechny soubory pomocí adres URL pro stahování a zpracovávat data podle potřeby.

Data, která se shromažďují (pomocí odpovědi JSON nebo prostřednictvím souborů), jsou aktuálním snímkem aktuálního stavu. Neobsahuje historická data. Aby zákazníci mohli shromažďovat historická data, musí je ukládat do svých vlastních datových úložišť.

Poznámka

Pokud není uvedeno jinak, všechny uvedené metody posouzení exportu jsou plně exportované a podle zařízení (označované také jako pro jednotlivé zařízení).

1. Export posouzení inventáře softwaru (odpověď JSON)

1.1 Popis metody rozhraní API

Tato odpověď rozhraní API obsahuje všechna data nainstalovaného softwaru, který má common platform enumeration (CPE) pro každé zařízení. Vrátí tabulku se záznamem pro každou jedinečnou kombinaci DeviceId, SoftwareVendor, SoftwareName a SoftwareVersion.

1.1.1 Omezení

  • Maximální velikost stránky je 200 000.
  • Omezení rychlosti pro toto rozhraní API jsou 30 volání za minutu a 1 000 volání za hodinu.

1.2 Oprávnění

K volání tohoto rozhraní API se vyžaduje jedno z následujících oprávnění. Další informace, včetně postupu výběru oprávnění, najdete v tématu Použití rozhraní MICROSOFT DEFENDER FOR ENDPOINT API.

Typ oprávnění Oprávnění Zobrazovaný název oprávnění
Application Software.Read.All Přečtěte si informace o softwaru pro správu hrozeb a ohrožení zabezpečení.
Delegovaný (pracovní nebo školní účet) Software.Read Přečtěte si informace o softwaru pro správu hrozeb a ohrožení zabezpečení.

Adresa URL verze 1.3

GET /api/machines/SoftwareInventoryByMachine

1.4 Parametry

  • pageSize (výchozí hodnota = 50 000): Počet výsledků v odpovědi.
  • $top: Počet výsledků, které se mají vrátit (nevrátí @odata.nextLink , a proto nenačtou všechna data)

1.5 Vlastnosti

Poznámka

  • Každý záznam má přibližně 0,5 kB dat. Měli byste to vzít v úvahu při výběru správného parametru pageSize pro vás.
  • Vlastnosti definované v následující tabulce jsou uvedeny abecedně podle ID vlastnosti. Při spuštění tohoto rozhraní API se výsledný výstup nemusí vrátit ve stejném pořadí uvedeném v této tabulce.
  • V odpovědi se můžou vrátit některé další sloupce. Tyto sloupce jsou dočasné a můžou být odebrány. Použijte pouze zdokumentované sloupce.


Vlastnost (ID) Datový typ Popis Příklad vrácené hodnoty
Deviceid Řetězec Jedinečný identifikátor zařízení ve službě 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
DeviceName Řetězec Plně kvalifikovaný název domény (FQDN) zařízení johnlaptop.europe.contoso.com
Cesty disku Pole[řetězec] Důkaz o tom, že je produkt nainstalovaný na zařízení. ["C:\Program Files (x86)\Microsoft\Silverlight\Application\silverlight.exe"]
EndOfSupportDate Řetězec Datum ukončení podpory tohoto softwaru. 2020-12-30
EndOfSupportStatus Řetězec Stav ukončení podpory Může obsahovat tyto možné hodnoty: Žádné, Verze EOS, Nadcházející verze EOS, Software EOS, Nadcházející software EOS. Chystaný EOS
NumberOfWeaknesses Int Počet slabých stránek tohoto softwaru na tomto zařízení 3
OSPlatforma Řetězec Platforma operačního systému spuštěného na zařízení Jedná se o konkrétní operační systémy s variacemi v rámci stejné rodiny, jako jsou Windows 10 a Windows 11. Podrobnosti najdete v tématu Microsoft Defender Správa zranitelností podporovaných operačních systémů a platforem. Windows10 a Windows 11
RbacGroupName Řetězec Skupina řízení přístupu na základě role (RBAC). Pokud toto zařízení není přiřazené k žádné skupině RBAC, bude mít hodnotu Nepřiřazeno. Pokud organizace neobsahuje žádné skupiny RBAC, hodnota bude Žádná. Servery
RegistryPaths Pole[řetězec] Důkazy registru o tom, že je produkt nainstalovaný v zařízení. ["HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Microsoft Silverlight"]
SoftwareFirstSeenTimestamp Řetězec První výskyt tohoto softwaru na zařízení. 2019-04-07 02:06:47
Název softwaru Řetězec Název softwarového produktu Silverlight
SoftwareVendor Řetězec Název dodavatele softwaru. Microsoft
Verze softwaru Řetězec Číslo verze softwarového produktu. 81.0.4044.138

1.6 Příklady

1.6.1 Příklad požadavku

GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pageSize=5  &sinceTime=2021-05-19T18%3A35%3A49.924Z

1.6.2 Příklad odpovědi

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Collection(contoso.windowsDefenderATP.api.AssetSoftware)",
    "value": [
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "windows_10" "Windows_11",
            "softwareVersion": "10.0.17763.1637",
            "numberOfWeaknesses": 58,
            "diskPaths": [],
            "registryPaths": [],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "Upcoming EOS Version",
            "endOfSupportDate": "2021-05-11T00:00:00+00:00"
        },
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": ".net_framework",
            "softwareVersion": "4.0.0.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "SOFTWARE\\Microsoft\\NET Framework Setup\\NDP\\v4.0\\Client\\Install"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eed80d086e79bdfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "system_center_2012_endpoint_protection",
            "softwareVersion": "4.7.214.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Microsoft Security Client"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f68765ddaf71234bde6bd733d6a9c59ad4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178aedfa25e8be9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "configuration_manager",
            "softwareVersion": "5.0.8634.1000",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{B7D3A842-E826-4542-B39B-1D883264B279}"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f38765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2de2f5ea3142726e63f16a.DomainPII_21eeb80d086e79bdfa178eadfa25e8be9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "system_center_2012_endpoint_protection",
            "softwareVersion": "4.10.209.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Microsoft Security Client"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        }
    ],
    "@odata.nextLink": "https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pagesize=5&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMS0wMS0yNS8wMjAwLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}

Poznámka

Informace vrácené tímto rozhraním API spolu s informacemi vrácenými rozhraním API pro posouzení inventáře softwaru pro export jiného kódu produktu pro software, který nemá CPE, poskytují úplný přehled o softwaru nainstalovaném ve vaší organizaci a o zařízeních, na kterých je nainstalovaný.

2. Export posouzení inventáře softwaru (prostřednictvím souborů)

2.1 Popis metody rozhraní API

Tato odpověď rozhraní API obsahuje všechna data nainstalovaného softwaru na zařízení. Vrátí tabulku se záznamem pro každou jedinečnou kombinaci DeviceId, SoftwareVendor, SoftwareName a SoftwareVersion.

2.1.1 Omezení

Omezení rychlosti pro toto rozhraní API jsou 5 volání za minutu a 20 volání za hodinu.

2.2 Oprávnění

K volání tohoto rozhraní API se vyžaduje jedno z následujících oprávnění. Další informace, včetně postupu výběru oprávnění, najdete v tématu Použití rozhraní MICROSOFT DEFENDER FOR ENDPOINT API.

Typ oprávnění Oprávnění Zobrazovaný název oprávnění
Application Software.Read.All Přečtěte si informace o softwaru pro správu hrozeb a ohrožení zabezpečení.
Delegovaný (pracovní nebo školní účet) Software.Read Přečtěte si informace o softwaru pro správu hrozeb a ohrožení zabezpečení.

Adresa URL verze 2.3

GET /api/machines/SoftwareInventoryExport

Parametry

  • sasValidHours: Počet hodin, po které budou adresy URL pro stahování platné (maximálně 24 hodin)

2.5 Vlastnosti

Poznámka

  • Soubory jsou komprimované gzip & ve víceřádkovém formátu JSON.
  • Adresy URL ke stažení jsou platné pouze 3 hodiny. V opačném případě můžete použít parametr .
  • Pokud chcete zajistit maximální rychlost stahování dat, můžete se ujistit, že stahujete ze stejné oblasti Azure, ve které se nacházejí vaše data.


Vlastnost (ID) Datový typ Popis Příklad vrácené hodnoty
Export souborů array[string] Seznam adres URL pro stahování souborů, které uchovávají aktuální snímek organizace "[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime Řetězec Čas vygenerování exportu 2021-05-20T08:00:00Z

2.6 Příklady

2.6.1 Příklad požadavku

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

2.6.2 Příklad odpovědi

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00393-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c001.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=..."
    ],
    "generatedTime": "2021-01-11T11:01:00Z"
}

Viz také

Další související

Tip

Chcete se dozvědět více? Engage s komunitou Microsoft Security v naší technické komunitě: Microsoft Defender for Endpoint Tech Community.