Delen via

Inventaris van hardware- en firmware-evaluatie per apparaat exporteren

  • Artikel

Van toepassing op:

Wilt u Microsoft Defender Vulnerability Management ervaren? Meer informatie over hoe u zich kunt registreren voor de openbare proefversie van Microsoft Defender Vulnerability Management.

Er zijn verschillende API-aanroepen om verschillende typen gegevens op te halen. Over het algemeen bevat elke API-aanroep de vereiste gegevens voor apparaten in uw organisatie.

  • JSON-antwoord De API haalt alle gegevens in uw organisatie op als JSON-antwoorden. Deze methode is het beste voor kleine organisaties met minder dan 100 K-apparaten. Het antwoord is gepagineerd, zodat u het veld @odata.nextLink uit het antwoord kunt gebruiken om de volgende resultaten op te halen.

  • via bestanden Met deze API-oplossing kunt u grotere hoeveelheden gegevens sneller en betrouwbaarder ophalen. Het wordt daarom aanbevolen voor grote organisaties, met meer dan 100 K-apparaten. Deze API haalt alle gegevens in uw organisatie op als downloadbestanden. Het antwoord bevat URL's voor het downloaden van alle gegevens uit Azure Storage. U kunt als volgt gegevens downloaden uit Azure Storage:

    • Roep de API aan om een lijst met download-URL's met alle gegevens van uw organisatie op te halen.
    • Download alle bestanden met behulp van de download-URL's en verwerk de gegevens zoals u wilt.

Gegevens die worden verzameld met behulp van 'JSON-antwoord of via bestanden' zijn de huidige momentopname van de huidige status. Deze bevat geen historische gegevens. Om historische gegevens te verzamelen, moeten klanten de gegevens opslaan in hun eigen gegevensopslag.

Opmerking

Tenzij anders aangegeven, zijn alle vermelde exporthardware- en firmware-evaluatiemethoden volledig geëxporteerd en per apparaat (ook wel per apparaat genoemd)

1. Hardware- en firmware-evaluatie exporteren (JSON-antwoord)

Beschrijving van API-methode 1.1

Retourneert alle hardware- en firmware-evaluaties voor alle apparaten, per apparaat. Het retourneert een tabel met een afzonderlijke vermelding voor elke unieke combinatie van deviceId en componentType.

1.1.1 Beperkingen

  • Het maximale paginaformaat is 200.000.
  • Frequentiebeperkingen voor deze API zijn 30 aanroepen per minuut en 1000 aanroepen per uur.

1.2 Machtigingen

Een van de volgende machtigingen is vereist om deze API aan te roepen. Zie Use Microsoft Defender voor Eindpunt API's (Api's voor Microsoft Defender voor Eindpunt gebruiken) voor meer informatie, waaronder het kiezen van machtigingen.

Machtigingstype Machtiging Weergavenaam van machtiging
Toepassing Software.Read.All 'Informatie over software voor bedreigings- en beveiligingsproblemenbeheer lezen'
Gedelegeerd (werk- of schoolaccount) Software.Read 'Informatie over software voor bedreigings- en beveiligingsproblemenbeheer lezen'

1.3 URL

GET api/machines/HardwareFirmwareInventoryByMachine

1.4 Parameters

  • pageSize (standaard = 50.000): aantal resultaten in antwoord.
  • $top: het aantal resultaten dat moet worden geretourneerd (retourneert niet @odata.nextLink en dus niet alle gegevens worden opgehaald).

1.5 Eigenschappen (JSON-antwoord)

Opmerking

Elke record bevat ongeveer 1 kB aan gegevens. U moet hiermee rekening houden bij het kiezen van de juiste parameter pageSize.

Er kunnen enkele extra kolommen worden geretourneerd in het antwoord. Deze kolommen zijn tijdelijk en kunnen worden verwijderd. Gebruik alleen de gedocumenteerde kolommen.

De eigenschappen die in de volgende tabel zijn gedefinieerd, worden alfabetisch weergegeven op eigenschaps-id. Wanneer u deze API uitvoert, wordt de resulterende uitvoer niet noodzakelijkerwijs geretourneerd in dezelfde volgorde die in deze tabel wordt vermeld.

Eigenschap (id) Gegevenstype: Beschrijving
deviceId Tekenreeks Unieke id voor het apparaat in de service.
rbacGroupId Int De groeps-id op basis van op rollen gebaseerd toegangsbeheer (RBAC). Als het apparaat niet is toegewezen aan een RBAC-groep, is de waarde 'Niet toegewezen'. Als de organisatie geen RBAC-groepen bevat, is de waarde 'Geen'.
rbacGroupName Tekenreeks De RBAC-groep (op rollen gebaseerd toegangsbeheer). Als het apparaat niet is toegewezen aan een RBAC-groep, is de waarde 'Niet toegewezen'. Als de organisatie geen RBAC-groepen bevat, is de waarde 'Geen'.
deviceName Tekenreeks Fully Qualified Domain Name (FQDN) van het apparaat.
componentType Tekenreeks Type hardware- of firmwareonderdeel.
Fabrikant Tekenreeks Fabrikant van een specifiek hardware- of firmwareonderdeel.
componentName Tekenreeks Naam van een specifiek hardware- of firmwareonderdeel.
componentVersion Tekenreeks Versie van een specifiek hardware- of firmwareonderdeel.
additionalFields Tekenreeks Aanvullende informatie over de onderdelen in JSON-matrixindeling.

1.6 Voorbeeld

1.6.1 Voorbeeld van aanvraag

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

1.6.2 Voorbeeld van antwoord

      {
        "@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. Hardware- en firmware-evaluatie exporteren (via bestanden)

Beschrijving van API-methode 2.1

Retourneert alle hardware- en firmware-evaluaties voor alle apparaten, per apparaat. Het retourneert een tabel met een afzonderlijke vermelding voor elke unieke combinatie van DeviceId, ComponentType en ComponentName.

2.1.1 Beperkingen

  • Tariefbeperkingen voor deze API zijn 5 aanroepen per minuut en 20 aanroepen per uur.

2.2 Machtigingen

Een van de volgende machtigingen is vereist om deze API aan te roepen. Zie Use Microsoft Defender voor Eindpunt API's (Api's voor Microsoft Defender voor Eindpunt gebruiken) voor meer informatie, waaronder het kiezen van machtigingen.

Machtigingstype Machtiging Weergavenaam van machtiging
Toepassing Software.Read.All 'Informatie over software voor bedreigings- en beveiligingsproblemenbeheer lezen'
Gedelegeerd (werk- of schoolaccount) Software.Read 'Informatie over software voor bedreigings- en beveiligingsproblemenbeheer lezen'

2.3 URL

GET /api/machines/HardwareFirmwareInventoryExport

2.4 Parameters

  • sasValidHours: het aantal uren dat de download-URL's geldig zijn (maximaal 24 uur).

2.5 Eigenschappen (JSON-antwoord)

Opmerking

De bestanden zijn gzip gecomprimeerd & in Json-indeling met meerdere regels.

De download-URL's zijn slechts 3 uur geldig; anders kunt u de parameter gebruiken.

Als u de downloadsnelheden wilt maximaliseren, moet u ervoor zorgen dat u de gegevens downloadt uit dezelfde Azure-regio waarin uw gegevens zich bevinden.

Elke record bevat ongeveer 1 kB aan gegevens. Houd hier rekening mee wanneer u de parameter pageSize kiest die voor u geschikt is.

Er kunnen enkele extra kolommen worden geretourneerd in het antwoord. Deze kolommen zijn tijdelijk en kunnen worden verwijderd. Gebruik alleen de gedocumenteerde kolommen.

Eigenschap (id) Gegevenstype: Beschrijving
Bestanden exporteren Tekenreeks[matrix] Een lijst met download-URL's voor bestanden met de huidige momentopname van de organisatie.
GeneratedTime Datetime Het tijdstip waarop de export is gegenereerd.

2.6 Voorbeeld

2.6.1 Voorbeeld van aanvraag

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

2.6.2 Voorbeeld van antwoord

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

   }