Share via


Exportera inventering av maskinvaru- och inbyggd programvara per enhet

Gäller för:

Vill du uppleva Microsoft Defender – hantering av säkerhetsrisker? Läs mer om hur du kan registrera dig för Microsoft Defender – hantering av säkerhetsrisker utvärderingsversion av den offentliga förhandsversionen.

Det finns olika API-anrop för att hämta olika typer av data. I allmänhet innehåller varje API-anrop nödvändiga data för enheter i din organisation.

  • JSON-svar 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.

  • 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. Du kan ladda ned 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 med antingen "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 exportmetoder för maskinvara och inbyggd programvara i listan fullständiga exporter och per enhet (kallas även per enhet)

1. Exportera utvärdering av maskinvara och inbyggd programvara (JSON-svar)

Beskrivning av 1.1 API-metod

Returnerar alla utvärderingar av maskinvara och inbyggd programvara för alla enheter per enhet. Den returnerar en tabell med en separat post för varje unik kombination av deviceId och componentType.

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/HardwareFirmwareInventoryByMachine

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 (JSON-svar)

Obs!

Varje post är cirka 1 KB data. Du bör ta hänsyn till detta när du väljer rätt pageSize-parameter.

Vissa ytterligare kolumner kan returneras i svaret. Dessa kolumner är tillfälliga och kan tas bort. Använd endast de dokumenterade kolumnerna.

Egenskaperna som definieras i följande tabell visas alfabetiskt 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.

Egenskap (ID) Datatyp Beskrivning
Deviceid Sträng Unik identifierare för enheten i tjänsten.
rbacGroupId Int Grupp-ID för rollbaserad åtkomstkontroll (RBAC). Om 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".
rbacGroupName Sträng Den rollbaserade åtkomstkontrollgruppen (RBAC). Om 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".
deviceName Sträng Fullständigt kvalificerat domännamn (FQDN) för enheten.
componentType Sträng Typ av komponent för maskinvara eller inbyggd programvara.
Tillverkare Sträng Tillverkare av en specifik komponent för maskinvara eller inbyggd programvara.
componentName Sträng Namnet på en specifik komponent för maskinvara eller inbyggd programvara.
componentVersion Sträng Version av en specifik komponent för maskinvara eller inbyggd programvara.
additionalFields Sträng Ytterligare information om komponenterna i JSON-matrisformat.

1.6 Exempel

1.6.1 Exempel på begäran

GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryByMachine

1.6.2 Svarsexempel

      {
        "@odata.context": "https://api-df.securitycenter.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetHardwareFirmware)",
        "value":[
        {
            "deviceId": "49126b9e4a5473b5229c73799e9e55c48668101b",
            "rbacGroupId": 39,
            "rbacGroupName": "testO6343398Gq31",
            "deviceName": "testmachine5",
            "componentType": "Hardware",
            "manufacturer": "razer",
            "componentName": "blade_15_advanced_model_(mid_2021)_-_rz09-0409",
            "componentVersion": "7.04",
            "additionalFields": "{\"SystemSKU\":\"RZ09-0409CE53\",\"BaseBoardManufacturer\":\"Razer\",\"BaseBoardProduct\":\"CH570\",\"BaseBoardVersion\":\"4\",\"DeviceFamily\":\"Workstation\"}"
          }  
        ]  
      },
    

2. Exportera utvärdering av maskinvara och inbyggd programvara (via filer)

Beskrivning av 2.1 API-metod

Returnerar alla utvärderingar av maskinvara och inbyggd programvara för alla enheter per enhet. Den returnerar en tabell med en separat post för varje unik kombination av DeviceId, ComponentType och ComponentName.

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/HardwareFirmwareInventoryExport

2.4 Parametrar

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

2.5 Egenskaper (JSON-svar)

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 att maximera nedladdningshastigheten kontrollerar du att du laddar ned data från samma Azure-region där dina data finns.

Varje post är cirka 1 KB data. Du bör ta hänsyn till detta när du väljer den pageSize-parameter som fungerar för dig.

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
Exportera filer String[array] En lista över nedladdnings-URL:er för filer som innehåller den aktuella ögonblicksbilden av organisationen.
GeneratedTime Datetime Tiden då exporten genererades.

2.6 Exempel

2.6.1 Exempel på begäran

GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryExport

2.6.2 Svarsexempel

    {
        "@odata.context":"https://api-df.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=d7c7c745-195f-4223-9c7a-99fb420fd000/_RbacGroupId=39/part-00999-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=muN8Sq6rVN6bFMtR0u3S5Wzh3D9qNPgN5vpU7lWvULg%3D",
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=d7c7c745-195f-4223-9c7a-99fb420fd000/_RbacGroupId=9/part-00968-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=%2BA0%2B4qOOBCS5E4UenJPbMdLM%2FkbXHnz%2F1pvfSOCq%2F2s%3D",
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=d7c7c745-195f-4223-9c7a-99fb420fd000/_RbacGroupId=9/part-00969-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=sZUgYMwSr5zk6BZvS%2BoYIWlHJWk2oJ7YjiC8R26S1X4%3D"
    ],
    "generatedTime": "2022-07-11T11:01:00Z"

   }