Export inventáře posouzení hardwaru a firmwaru na zařízení

Článek
04/27/2024

Platí pro:

Chcete si Microsoft Defender Správa zranitelností prožít? Přečtěte si další informace o tom, jak se můžete zaregistrovat ke zkušební verzi Microsoft Defender Správa zranitelností Public Preview.

Existují různá volání rozhraní API pro získání různých typů dat. Obecně platí, že každé volání rozhraní API obsahuje požadovaná data pro zařízení ve vaší organizaci.

Odpověď JSON 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.
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. Data ze služby Azure Storage si můžete stáhnout 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 shromážděná 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í hardwaru a firmwaru exportu jsou plně exportované a podle zařízení (také označované jako podle zařízení).

1. Export posouzení hardwaru a firmwaru (odpověď JSON)

1.1 Popis metody rozhraní API

Vrátí všechna posouzení hardwaru a firmwaru pro všechna zařízení na základě jednotlivých zařízení. Vrátí tabulku se samostatnou položkou pro každou jedinečnou kombinaci deviceId a componentType.

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

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čte všechna data).

1.5 Vlastnosti (odpověď JSON)

Poznámka

Každý záznam má přibližně 1 kB dat. Měli byste to vzít v úvahu při výběru správného parametru pageSize.

V odpovědi se můžou vrátit některé další sloupce. Tyto sloupce jsou dočasné a můžou se odebrat. Používejte pouze zdokumentované sloupce.

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.

Vlastnost (ID)	Datový typ	Popis
Deviceid	String	Jedinečný identifikátor zařízení ve službě
rbacGroupId	Int	ID skupiny řízení přístupu na základě role (RBAC). Pokud 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á.
rbacGroupName	String	Skupina řízení přístupu na základě role (RBAC). Pokud 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á.
deviceName	String	Plně kvalifikovaný název domény (FQDN) zařízení
componentType	String	Typ součásti hardwaru nebo firmwaru
Výrobce	String	Výrobce konkrétní součásti hardwaru nebo firmwaru
componentName	String	Název konkrétní součásti hardwaru nebo firmwaru
componentVersion	String	Verze konkrétní součásti hardwaru nebo firmwaru
additionalFields	String	Další informace o komponentách ve formátu pole JSON

1.6 Příklad

1.6.1 Příklad požadavku

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

1.6.2 Příklad odpovědi

      {
        "@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. Export posouzení hardwaru a firmwaru (prostřednictvím souborů)

2.1 Popis metody rozhraní API

Vrátí všechna posouzení hardwaru a firmwaru pro všechna zařízení na základě jednotlivých zařízení. Vrátí tabulku se samostatnou položkou pro každou jedinečnou kombinaci DeviceId, ComponentType a ComponentName.

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í

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

2.4 Parametry

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

2.5 Vlastnosti (odpověď JSON)

Poznámka

Soubory jsou komprimované gzip & ve víceřádkovém formátu JSON.

Adresy URL pro stahování jsou platné pouze 3 hodiny. v opačném případě můžete použít parametr .

Pokud chcete dosáhnout maximální rychlosti stahování, ujistěte se, že stahujete data ze stejné oblasti Azure, ve které se vaše data nacházejí.

Každý záznam má velikost přibližně 1 kB dat. Měli byste to vzít v úvahu při výběru parametru pageSize, který vám vyhovuje.

V odpovědi se můžou vrátit některé další sloupce. Tyto sloupce jsou dočasné a můžou se odebrat. Používejte pouze zdokumentované sloupce.

Vlastnost (ID)	Datový typ	Popis
Export souborů	String[array]	Seznam adres URL ke stažení pro soubory, které uchovávají aktuální snímek organizace.
GeneratedTime	Datetime	Čas vygenerování exportu

2.6 Příklad

2.6.1 Příklad požadavku

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

2.6.2 Příklad odpovědi

    {
        "@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=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_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=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_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=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_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"

   }

Sdílet prostřednictvím

Export inventáře posouzení hardwaru a firmwaru na zařízení

1. Export posouzení hardwaru a firmwaru (odpověď JSON)

1.1 Popis metody rozhraní API

1.1.1 Omezení

1.2 Oprávnění

Adresa URL verze 1.3

1.4 Parametry

1.5 Vlastnosti (odpověď JSON)

1.6 Příklad

1.6.1 Příklad požadavku

1.6.2 Příklad odpovědi

2. Export posouzení hardwaru a firmwaru (prostřednictvím souborů)

2.1 Popis metody rozhraní API

2.1.1 Omezení

2.2 Oprávnění

Adresa URL verze 2.3

2.4 Parametry

2.5 Vlastnosti (odpověď JSON)

2.6 Příklad

2.6.1 Příklad požadavku

2.6.2 Příklad odpovědi

Váš názor

Váš názor

Další materiály