Metody a vlastnosti rozhraní API pro export podrobností o stavu antivirového softwaru zařízení
Platí pro:
- Microsoft Defender for Endpoint
- Plán 2 pro Microsoft Defender pro koncový bod
- Microsoft Defender XDR
Chcete vyzkoušet Defender pro Endpoint? Zaregistrujte se a získejte bezplatnou zkušební verzi,
Poznámka
Pokud jste zákazníkem státní správy USA, použijte identifikátory URI uvedené v programu Microsoft Defender for Endpoint pro zákazníky státní správy USA.
Tip
Pro lepší výkon můžete použít server blíže k vašemu geografickému umístění:
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
Důležité
Některé informace v tomto článku se týkají předvydaného produktu, který může být před komerčním vydáním podstatně změněn. Společnost Microsoft neposkytuje na zde uvedené informace žádné záruky, vyjádřené ani předpokládané.
Popis rozhraní API pro export podrobností o stavu antivirového softwaru zařízení
Načte seznam podrobností o stavu zařízení Antivirové ochrany v programu Microsoft Defender. Toto rozhraní API má různá volání (metody) rozhraní API pro získání různých typů dat. Vzhledem k tomu, že množství dat může být velké, můžete je načíst dvěma způsoby:
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. 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 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šť.
Důležité
Aby se Windows Server 2012 R2 a Windows Server 2016 zobrazily v sestavách stavu zařízení, musí být tato zařízení nasazená pomocí moderního balíčku sjednoceného řešení. Další informace najdete v tématu Nové funkce v moderním sjednocené řešení pro Windows Server 2012 R2 a 2016.
Informace o používání nástroje pro generování sestav stavu zařízení a antivirového softwaru na portálu Microsoft Defender najdete v tématu Sestava stavu zařízení a antivirové ochrany v Microsoft Defenderu for Endpoint.
1.1 Export metod rozhraní API s podrobnostmi o stavu antivirového softwaru
| Metoda | Datový typ | Popis |
|---|---|---|
| (odpověď JSON) | Stav antivirové ochrany v programu Microsoft Defender na kolekci zařízení. Viz : 1.2 Export vlastností rozhraní API s podrobnostmi o stavu antivirového softwaru zařízení (odpověď JSON). | Vrátí tabulku s položkou pro každou jedinečnou kombinaci DeviceId a ConfigurationId. 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 můžete použít @odata.nextLink pole z odpovědi k načtení dalších výsledků. |
| (prostřednictvím souborů) | Stav antivirové ochrany v programu Microsoft Defender na kolekci zařízení. Viz : 1.3 Export podrobností o stavu antivirového softwaru zařízení ve vlastnostech rozhraní API (prostřednictvím souborů). | Vrátí tabulku s položkou pro každou jedinečnou kombinaci DeviceId a ConfigurationId. 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:
|
1.2 Omezení
- Maximální velikost stránky: 200 000
- Omezení rychlosti pro toto rozhraní API: 30 volání za minutu a 1 000 volání za hodinu
1.3 Export vlastností rozhraní API s podrobnostmi o stavu antivirového softwaru zařízení (odpověď JSON)
Poznámka
- 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.
- Mějte na paměti, že rbacgroupname a ID nejsou podporované operátory filtru.
- V odpovědi se můžou vrátit některé další sloupce. Tyto sloupce mohou být dočasné a mohou být odebrány; použít pouze zdokumentované sloupce.
| Vlastnost (ID) | Datový typ | Popis | Příklad vrácené hodnoty |
|---|---|---|---|
| avEngineUpdateTime | DateTimeOffset | Datum a čas poslední aktualizace av modulu na zařízení | "2022-08-04T12:44:02Z" |
| avEngineVersion | String | Verze antivirového modulu | "1.1.19400.3" |
| avIsEngineUpToDate | String | Aktuální stav AV motoru | "True", "False", "Unknown" |
| avIsPlatformUpToDate | String | Aktuální stav av platformy | "True", "False", "Unknown" |
| avIsSignatureUpToDate | String | Aktuální stav podpisu AV | "True", "False", "Unknown" |
| avMode | String | Antivirový režim. | Každý režim bude celočíselná hodnota řetězcového typu od 0 do 5. Pokud chcete zjistit význam jeho hodnoty, podívejte se na následující mapování:
|
| avPlatformUpdateTime | DateTimeOffset | Datum a čas poslední aktualizace av platformy na zařízení | "2022-08-04T12:44:02Z" |
| avPlatformVersion | String | Verze antivirové platformy | "4.18.2203.5" |
| avSignaturePublishTime | DateTimeOffset | Datum a čas vydání buildu AV security intelligence | "2022-08-04T12:44:02Z" |
| avSignatureUpdateTime | DateTimeOffset | Datum a čas poslední aktualizace bezpečnostních funkcí av na zařízení | "2022-08-04T12:44:02Z" |
| avSignatureVersion | String | Antivirová verze bezpečnostních informací | "1.371.1323.0" |
| computerDnsName | String | Název DNS | "SampleDns" |
| dataRefreshTimestamp | DateTimeOffset | Datetime when data is refreshed for this report | "2022-08-04T12:44:02Z" |
| fullScanError | String | Kódy chyb při úplné kontrole | "0x80508023" |
| fullScanResult | String | Úplný výsledek kontroly tohoto zařízení | "Dokončeno" "Zrušeno" "Neúspěšné" |
| fullScanTime | DateTimeOffset | Datum a čas po dokončení úplné kontroly | "2022-08-04T12:44:02Z" |
| id | String | Identifikátor GUID počítače | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
| lastSeenTime | DateTimeOffset | Datum a čas posledního výskytu tohoto počítače | "2022-08-04T12:44:02Z" |
| id počítače | String | Identifikátor GUID počítače | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
| osKind | String | Druh operačního systému | "windows", "mac", "linux" |
| osPlatform | String | Název hlavní verze operačního systému | Windows 10, macOs |
| osVersion | String | Verze operačního systému | 10.0.18363.1440, 12.4.0.0 |
| quickScanError | String | Kódy chyb z rychlé kontroly | "0x80508023" |
| quickScanResult | String | Výsledek rychlé kontroly tohoto zařízení | "Dokončeno" "Zrušeno" "Neúspěšné" |
| quickScanTime | DateTimeOffset | Datum a čas po dokončení rychlé kontroly | "2022-08-04T12:44:02Z" |
| rbacGroupId | Dlouhý | ID skupiny zařízení, do kterého tento počítač patří | 712 |
| rbacGroupName | String | Název skupiny zařízení, do které tento počítač patří | "SampleGroup" |
1.4 Export vlastností rozhraní API s podrobnostmi o stavu antivirového softwaru zařízení (prostřednictvím souborů)
Důležité
Informace v této části se týkají předem vydaných produktů, které mohou být před komerčním vydáním podstatně změněny. Společnost Microsoft neposkytuje v souvislosti se zde uvedenými informacemi žádné výslovné ani předpokládané záruky.
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 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.
- 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 správného parametru pageSize pro vás.
- 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 |
|---|---|---|---|
| Export souborů | array[string] | Seznam adres URL ke stažení pro soubory, 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 | String | Čas vygenerování exportu | 2022-05-20T08:00:00Z |
Poznámka
V každém exportu souborů lze najít vlastnost DeviceGatheredInfo obsahující data o antivirových informacích. Každý z jeho atributů vám může poskytnout informace o stavu zařízení a jeho stavu.
Viz také
Export sestavy stavu antivirové ochrany zařízení
Sestavy stavu zařízení a dodržování předpisů
Tip
Chcete se dozvědět více? Spojte se s komunitou zabezpečení Microsoftu v naší technické komunitě: Technická komunita Microsoft Defenderu for Endpoint.