Udostępnij przez

Eksportowanie metod i właściwości interfejsu API szczegółów kondycji oprogramowania antywirusowego urządzenia

  • Dotyczy: Microsoft Defender for Endpoint Plan 2, Microsoft Defender for Business

Ważna

Niektóre informacje zawarte w tym artykule odnoszą się do wersji wstępnej produktu, który może zostać znacznie zmodyfikowany do czasu wydania wersji komercyjnej. Firma Microsoft nie udziela żadnych gwarancji, wyrażonych ani dorozumianych, w odniesieniu do informacji podanych tutaj.

Opis interfejsu API eksportowania szczegółów kondycji programu antywirusowego urządzenia

Pobiera listę szczegółów kondycji urządzenia antywirusowego Microsoft Defender. Ten interfejs API ma różne wywołania interfejsu API (metody), aby uzyskać różne typy danych. Ponieważ ilość danych może być duża, można pobrać je na dwa sposoby:

  • JSON Interfejs API ściąga wszystkie dane w organizacji jako odpowiedzi JSON. Ta metoda jest najlepsza w przypadku małych organizacji z urządzeniami o rozmiarze mniejszym niż 100 K. Odpowiedź jest podzielona na strony, więc możesz użyć pola @odata.nextLink z odpowiedzi, aby pobrać następne wyniki.

  • Pliki To rozwiązanie interfejsu API umożliwia szybsze i bardziej niezawodne ściąganie większych ilości danych oraz jest zalecane w przypadku dużych organizacji, które mają ponad 100 000 urządzeń. Ten interfejs API pobiera wszystkie dane w organizacji jako pliki do pobrania. Odpowiedź zawiera adresy URL umożliwiające pobranie wszystkich danych z usługi Azure Storage. Ten interfejs API umożliwia pobranie wszystkich danych z usługi Azure Storage w następujący sposób:

    1. Wywołaj interfejs API, aby uzyskać listę adresów URL pobierania ze wszystkimi danymi organizacji.

    2. Pobierz wszystkie pliki przy użyciu adresów URL pobierania i przetwórz dane zgodnie z tym, co chcesz.

Dane zbierane przy użyciu JSON response plików lub przy użyciu plików są migawką bieżącego stanu. Te dane nie zawierają danych historycznych. Aby zbierać dane historyczne, należy zapisać dane we własnym magazynie danych.

Aby uzyskać informacje na temat korzystania z narzędzia do raportowania zgodności urządzeń i oprogramowania antywirusowego w portalu Microsoft Defender, zobacz: Kondycja urządzenia i raport antywirusowy w Ochrona punktu końcowego w usłudze Microsoft Defender.

Wymagania wstępne

1.1. Eksportowanie metod interfejsu API szczegółów programu antywirusowego urządzenia

Metoda Typ danych Opis
(Odpowiedź JSON) Microsoft Defender kondycję programu antywirusowego na kolekcję urządzeń. Zobacz: 1.2 Eksportowanie właściwości interfejsu API szczegółów programu antywirusowego urządzenia (odpowiedź JSON) Zwraca tabelę z wpisem dla każdej unikatowej kombinacji identyfikatora DeviceId, ConfigurationId.

Interfejs API ściąga wszystkie dane w organizacji jako odpowiedzi JSON. Ta metoda jest najlepsza w przypadku małych organizacji z urządzeniami o rozmiarze mniejszym niż 100 K. Odpowiedź jest podzielona na strony, więc możesz użyć @odata.nextLink pola z odpowiedzi, aby pobrać następne wyniki.
(za pośrednictwem plików) Microsoft Defender kondycję programu antywirusowego na kolekcję urządzeń. Zobacz: 1.3 Eksportowanie właściwości interfejsu API szczegółów kondycji programu antywirusowego urządzenia (za pośrednictwem plików) Zwraca tabelę z wpisem dla każdej unikatowej kombinacji identyfikatora DeviceId, ConfigurationId.

To rozwiązanie interfejsu API umożliwia szybsze i bardziej niezawodne ściąganie większych ilości danych. Dlatego jest to zalecane w przypadku dużych organizacji z ponad 100-K urządzeń. Ten interfejs API pobiera wszystkie dane w organizacji jako pliki do pobrania. Odpowiedź zawiera adresy URL umożliwiające pobranie wszystkich danych z usługi Azure Storage. Ten interfejs API umożliwia pobranie wszystkich danych z usługi Azure Storage w następujący sposób:
  1. Wywołaj interfejs API, aby uzyskać listę adresów URL pobierania ze wszystkimi danymi organizacji.
  2. Pobierz wszystkie pliki przy użyciu adresów URL pobierania i przetwórz dane zgodnie z tym, co chcesz.

1.2 Ograniczenia

  • Maksymalny rozmiar strony: 200 000
  • Ograniczenia szybkości dla tego interfejsu API: 30 wywołań na minutę i 1000 wywołań na godzinę

1.3 Eksportowanie właściwości interfejsu API szczegółów kondycji programu antywirusowego urządzenia (odpowiedź JSON)

  • Właściwości zdefiniowane w poniższej tabeli są wyświetlane alfabetycznie według identyfikatora właściwości. W przypadku korzystania z tego interfejsu API wynikowe dane wyjściowe nie muszą być zwracane w tej samej kolejności wymienionej w tej tabeli.
  • Należy pamiętać, że rbacgroupname i Id nie są obsługiwane operatory filtrów.
  • W odpowiedzi może zostać zwróconych kilka kolumn. Te kolumny mogą być tymczasowe i mogą zostać usunięte; używaj tylko udokumentowanych kolumn.
Właściwość (ID) Typ danych Opis Przykład zwracanej wartości
avEngineUpdateTime DateTimeOffset Data/godzina ostatniej aktualizacji aparatu antywirusowego na urządzeniu "2022-08-04T12:44:02Z"
avEngineVersion Ciąg Wersja aparatu antywirusowego 1.1.19400.3
avIsEngineUpToDate Ciąg Aktualny stan aparatu antywirusowego True, , Falselub Unknown
avIsPlatformUpToDate Ciąg Aktualny stan platformy antywirusowej True, , Falselub Unknown
avIsSignatureUpToDate Ciąg Aktualny stan sygnatury antywirusowej True, , Falselub Unknown
avMode Ciąg Tryb antywirusowy. Każdy tryb jest ciągiem wpisanym wartością całkowitą od 0 do 5.
'' = Other
0 = Active
1 = Passive
2 = Disabled
3 = Other
4 = EDRBlocked
5 = PassiveAudit
avPlatformUpdateTime DateTimeOffset Data/godzina ostatniej aktualizacji platformy antywirusowej na urządzeniu "2022-08-04T12:44:02Z"
avPlatformVersion Ciąg Wersja platformy antywirusowej 4.18.2203.5
avSignaturePublishTime DateTimeOffset Data/godzina wydania kompilacji analizy zabezpieczeń antywirusowych "2022-08-04T12:44:02Z"
avSignatureUpdateTime DateTimeOffset Data/godzina ostatniej aktualizacji analizy zabezpieczeń oprogramowania antywirusowego na urządzeniu "2022-08-04T12:44:02Z"
avSignatureVersion Ciąg Wersja analizy zabezpieczeń programu antywirusowego 1.371.1323.0
computerDnsName Ciąg Nazwa DNS SampleDns
dataRefreshTimestamp DateTimeOffset Data/godzina odświeżenia danych dla tego raportu 2022-08-04T12:44:02Z
fullScanError Ciąg Kody błędów z pełnego skanowania "0x80508023"
fullScanResult Ciąg Pełny wynik skanowania urządzenia Completed, , Canceledlub Failed
fullScanTime DateTimeOffset Data/godzina ukończenia pełnego skanowania 2022-08-04T12:44:02Z
id Ciąg Identyfikator GUID maszyny 30a8fa2826abf24d24379b23f8a44d471f00feab
lastSeenTime DateTimeOffset Ostatnio widziana data/godzina tej maszyny 2022-08-04T12:44:02Z
machineId Ciąg Identyfikator GUID maszyny 30a8fa2826abf24d24379b23f8a44d471f00feab
osKind Ciąg Rodzaj systemu operacyjnego windows, , maclub linux
osPlatform Ciąg Nazwa wersji głównej systemu operacyjnego Windows 10 lub macOS
osVersion Ciąg Wersja systemu operacyjnego 10.0.18363.1440, 12.4.0.0
quickScanError Ciąg Kody błędów z szybkiego skanowania 0x80508023
quickScanResult Ciąg Szybki wynik skanowania tego urządzenia Completed, , Canceledlub Failed
quickScanTime DateTimeOffset Data/godzina ukończenia szybkiego skanowania 2022-08-04T12:44:02Z
rbacGroupId Długi Identyfikator grupy urządzeń, do której należy ta maszyna 712
rbacGroupName Ciąg Nazwa grupy urządzeń, do której należy ta maszyna SampleGroup

1.4 Eksportowanie właściwości interfejsu API szczegółów kondycji programu antywirusowego urządzenia (za pośrednictwem plików)

Ważna

Informacje w tej sekcji dotyczą wstępnie wydanego produktu, który można znacząco zmodyfikować przed jego komercyjną premierą. Firma Microsoft nie udziela żadnych gwarancji, wyraźnych ani dorozumianych, w odniesieniu do podanych tutaj informacji.

W każdym z plików eksportu istnieje właściwość o nazwie DeviceGatheredInfo, która zawiera dane programu antywirusowego. Każdy z jego atrybutów może dostarczyć informacji o kondycji urządzenia i jego stanie.

  • Pliki są skompresowane gzip i w formacie wielowierszowym .json .
  • Adresy URL pobierania są ważne tylko przez 3 godziny; W przeciwnym razie można użyć parametru .
  • Aby uzyskać maksymalną szybkość pobierania danych, możesz upewnić się, że pobierasz dane z tego samego regionu Azure, w którym znajdują się dane.
  • Każdy rekord używa około 1 KB danych. Należy wziąć to pod uwagę podczas wybierania poprawnego pageSize parametru.
  • W odpowiedzi może zostać zwróconych więcej kolumn. Te kolumny są tymczasowe i mogą zostać usunięte, dlatego należy używać tylko udokumentowanych kolumn.
Właściwość (ID) Typ danych Opis Przykład zwracanej wartości
Eksportowanie plików array[string] Lista adresów URL pobierania plików przechowujących bieżącą migawkę organizacji. ["https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime Ciąg Czas wygenerowania eksportu. 2022-05-20T08:00:00Z
  • Last updated on