Exportera utvärdering av programvaruinventering per enhet

Gäller för:

Vill du uppleva Microsoft Defender för Endpoint? Registrera dig för en kostnadsfri utvärderingsversion.

Det här API:et returnerar alla data för installerad programvara som har en Common Platform Enumeration (CPE), per enhet.

Olika API-anrop hämtar olika typer av data. Eftersom mängden data kan vara stor finns det två sätt att hämta dem:

  • Exportera JSON-svar för utvärdering av programvaruinventering API:et hämtar alla data i din organisation som Json-svar. Den här metoden passar bäst för små organisationer med mindre än 100 K-enheter. Svaret är sidnumrerat, så du kan använda fältet @odata.nextLink från svaret för att hämta nästa resultat.

  • Exportera utvärdering av programvaruinventering via filer Med den här API-lösningen kan du hämta större mängder data snabbare och mer tillförlitligt. Därför rekommenderas det för stora organisationer med fler än 100 K-enheter. Det här API:et hämtar alla data i din organisation som nedladdningsfiler. Svaret innehåller URL:er för att ladda ned alla data från Azure Storage. Med det här API:et kan du ladda ned alla dina data från Azure Storage på följande sätt:

    • Anropa API:et för att hämta en lista över nedladdnings-URL:er med alla organisationsdata.
    • Ladda ned alla filer med hjälp av nedladdnings-URL:er och bearbeta data som du vill.

Data som samlas in (antingen med Json-svar eller via filer) är den aktuella ögonblicksbilden av det aktuella tillståndet. Den innehåller inte historiska data. För att samla in historiska data måste kunderna spara data i sina egna datalagringar.

Obs!

Om inget annat anges är alla exportutvärderingsmetoder som anges fullständig export och per enhet (kallas även per enhet).

1. Exportera utvärdering av programvaruinventering (JSON-svar)

Beskrivning av 1.1 API-metod

Det här API-svaret innehåller alla data för installerad programvara som har en Common Platform Enumeration (CPE), per enhet. Returnerar en tabell med en post för varje unik kombination av DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.

1.1.1 Begränsningar

  • Maximal sidstorlek är 200 000.
  • Frekvensbegränsningar för det här API:et är 30 anrop per minut och 1 000 anrop per timme.

1.2 Behörigheter

En av följande behörigheter krävs för att anropa det här API:et. Mer information om hur du väljer behörigheter finns i Använda Microsoft Defender för Endpoint-API:er.

Behörighetstyp Behörighet Visningsnamn för behörighet
Program Software.Read.All "Läs programvaruinformation om hot- och sårbarhetshantering"
Delegerat (arbets- eller skolkonto) Software.Read "Läs programvaruinformation om hot- och sårbarhetshantering"

1.3 URL

GET /api/machines/SoftwareInventoryByMachine

1.4 Parametrar

  • pageSize (standard = 50 000): Antal resultat som svar.
  • $top: Antal resultat som ska returneras (returneras @odata.nextLink inte och hämtar därför inte alla data)

1.5 Egenskaper

Obs!

  • Varje post är cirka 0,5 KB data. Du bör ta hänsyn till detta när du väljer rätt pageSize-parameter åt dig.
  • Egenskaperna som definieras i följande tabell visas i alfabetisk ordning efter egenskaps-ID. När du kör det här API:et returneras inte nödvändigtvis de resulterande utdata i samma ordning som anges i den här tabellen.
  • Vissa ytterligare kolumner kan returneras i svaret. Dessa kolumner är tillfälliga och kan tas bort. Använd endast de dokumenterade kolumnerna.


Egenskap (ID) Datatyp Beskrivning Exempel på ett returnerat värde
Deviceid sträng Unik identifierare för enheten i tjänsten. 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
DeviceName sträng Fullständigt kvalificerat domännamn (FQDN) för enheten. johnlaptop.europe.contoso.com
DiskPaths Array[string] Disk bevisar att produkten är installerad på enheten. ["C:\Program Files (x86)\Microsoft\Silverlight\Application\silverlight.exe"]
EndOfSupportDate sträng Det datum då stödet för den här programvaran upphör. 2020-12-30
EndOfSupportStatus sträng Supportstatusen upphör. Kan innehålla följande möjliga värden: None, EOS Version, Upcoming EOS Version, EOS Software, Upcoming EOS Software. Kommande EOS
NumberOfWeaknesses int Antal svagheter i den här programvaran på den här enheten 3
OSPlatform sträng Plattform för operativsystemet som körs på enheten. Dessa är specifika operativsystem med variationer inom samma familj, till exempel Windows 10 och Windows 11. Mer information finns i Microsoft Defender – hantering av säkerhetsrisker operativsystem och plattformar som stöds. Windows10 och Windows 11
RbacGroupName sträng Den rollbaserade åtkomstkontrollgruppen (RBAC). Om den här enheten inte har tilldelats någon RBAC-grupp blir värdet "Ej tilldelad". Om organisationen inte innehåller några RBAC-grupper blir värdet "Ingen". Servrar
RegistryPaths Array[string] Registerbevis på att produkten är installerad på enheten. ["HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Microsoft Silverlight"]
SoftwareFirstSeenTimestamp sträng Första gången den här programvaran visades på enheten. 2019-04-07 02:06:47
SoftwareName sträng Namnet på programvaruprodukten. Silverlight
SoftwareVendor sträng Namnet på programvaruleverantören. Microsoft
SoftwareVersion sträng Versionsnummer för programvaruprodukten. 81.0.4044.138

1.6 Exempel

1.6.1 Exempel på begäran

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

1.6.2 Svarsexempel

{
    "@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"
}

Obs!

Informationen som returneras av det här API:et, tillsammans med informationen som returneras av API:et Export non product code software inventory assessment , för programvara som inte har en CPE, ger dig fullständig insyn i programvaran som är installerad i organisationen och de enheter som den är installerad på.

2. Exportera utvärdering av programvaruinventering (via filer)

Beskrivning av 2.1 API-metod

Det här API-svaret innehåller alla data för installerad programvara per enhet. Returnerar en tabell med en post för varje unik kombination av DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.

2.1.1 Begränsningar

Hastighetsbegränsningar för det här API:et är 5 anrop per minut och 20 anrop per timme.

2.2 Behörigheter

En av följande behörigheter krävs för att anropa det här API:et. Mer information om hur du väljer behörigheter finns i Använda Microsoft Defender för Endpoint-API:er.

Behörighetstyp Behörighet Visningsnamn för behörighet
Program Software.Read.All "Läs programvaruinformation om hot- och sårbarhetshantering"
Delegerat (arbets- eller skolkonto) Software.Read "Läs programvaruinformation om hot- och sårbarhetshantering"

2.3 URL

GET /api/machines/SoftwareInventoryExport

Parametrar

  • sasValidHours: Antalet timmar som nedladdnings-URL:erna är giltiga i (högst 24 timmar)

2.5 Egenskaper

Obs!

  • Filerna är gzip-komprimerade & i JSON-format med flera ledningar.
  • Nedladdnings-URL:erna är endast giltiga i 3 timmar. Annars kan du använda parametern .
  • För maximal nedladdningshastighet för dina data kan du se till att du laddar ned från samma Azure-region som dina data finns i.


Egenskap (ID) Datatyp Beskrivning Exempel på ett returnerat värde
Exportera filer array[string] En lista över nedladdnings-URL:er för filer som innehåller den aktuella ögonblicksbilden av organisationen "[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime sträng Tiden då exporten genererades. 2021-05-20T08:00:00Z

2.6 Exempel

2.6.1 Exempel på begäran

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

2.6.2 Svarsexempel

{
    "@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"
}

Se även

Andra relaterade

Tips

Vill du veta mer? Engage med Microsofts säkerhetscommunity i vår Tech Community: Microsoft Defender för Endpoint Tech Community.