Eksportowanie metod i właściwości interfejsu API szczegółów kondycji oprogramowania antywirusowego urządzenia
Dotyczy:
- Ochrona punktu końcowego w usłudze Microsoft Defender
- Ochrona punktu końcowego w usłudze Microsoft Defender (plan 2)
- Microsoft Defender XDR
Chcesz poznać usługę ochrony punktu końcowego w usłudze Microsoft Defender? Utwórz konto, aby skorzystać z bezpłatnej wersji próbnej.
Uwaga
Jeśli jesteś klientem rządowym USA, użyj identyfikatorów URI wymienionych w usłudze Microsoft Defender for Endpoint dla klientów rządowych USA.
Porada
Aby uzyskać lepszą wydajność, możesz użyć serwera bliżej lokalizacji geograficznej:
- 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
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:
Odpowiedź 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.
za pośrednictwem plików 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:
- Wywołaj interfejs API, aby uzyskać listę adresów URL pobierania ze wszystkimi danymi organizacji.
- Pobierz wszystkie pliki przy użyciu adresów URL pobierania i przetwórz dane zgodnie z tym, co chcesz.
Dane zbierane przy użyciu "odpowiedzi JSON lub za pośrednictwem plików" to bieżąca migawka bieżącego stanu. Nie zawiera danych historycznych. Aby zbierać dane historyczne, klienci muszą zapisywać dane we własnych magazynach danych.
Ważna
Aby systemy Windows Server 2012 R2 i Windows Server 2016 były wyświetlane w raportach dotyczących kondycji urządzeń, te urządzenia muszą zostać dołączone przy użyciu nowoczesnego ujednoliconego pakietu rozwiązań. Aby uzyskać więcej informacji, zobacz New functionality in the modern unified solution for Windows Server 2012 R2 and 2016 (Nowe funkcje w nowoczesnym ujednoliconym rozwiązaniu dla systemów Windows Server 2012 R2 i 2016).
Aby uzyskać informacje na temat korzystania z narzędzia do raportowania kondycji urządzenia i zgodności z programem antywirusowym w portalu usługi Microsoft Defender, zobacz: Kondycja urządzenia i raport antywirusowy w usłudze Microsoft Defender for Endpoint.
1.1. Eksportowanie metod interfejsu API szczegółów programu antywirusowego urządzenia
| Metoda | Typ danych | Opis |
|---|---|---|
| (Odpowiedź JSON) | Kondycja programu antywirusowego Microsoft Defender 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) | Kondycja programu antywirusowego Microsoft Defender 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.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)
Uwaga
- Właściwości zdefiniowane w poniższej tabeli są wyświetlane alfabetycznie według identyfikatora właściwości. Podczas uruchamiania 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 mogą zostać zwrócone dodatkowe kolumny. 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 AV na urządzeniu | "2022-08-04T12:44:02Z" |
| avEngineVersion | Ciąg | Wersja aparatu antywirusowego | "1.1.19400.3" |
| avIsEngineUpToDate | Ciąg | Aktualny stan aparatu AV | "True", "False", "Unknown" |
| avIsPlatformUpToDate | Ciąg | Aktualny stan platformy AV | "True", "False", "Unknown" |
| avIsSignatureUpToDate | Ciąg | Aktualny stan podpisu AV | "True", "False", "Unknown" |
| avMode | Ciąg | Tryb antywirusowy. | Każdy tryb będzie ciągiem wpisanym wartością całkowitą od 0 do 5. Zapoznaj się z poniższym mapowaniem, aby zobaczyć znaczenie jego wartości:
|
| avPlatformUpdateTime | DateTimeOffset | Data/godzina ostatniej aktualizacji platformy AV 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ń AV | "2022-08-04T12:44:02Z" |
| avSignatureUpdateTime | DateTimeOffset | Data/godzina ostatniej aktualizacji analizy zabezpieczeń AV 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 tego urządzenia | "Ukończono" "Anulowano" "Niepowodzenie" |
| 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", "mac", "linux" |
| osPlatform | Ciąg | Nazwa wersji głównej systemu operacyjnego | Windows 10, 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 | "Ukończono" "Anulowano" "Niepowodzenie" |
| 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że zostać znacząco zmodyfikowany przed jego komercyjną premierą. Firma Microsoft nie udziela żadnych gwarancji, wyraźnych ani dorozumianych, w odniesieniu do podanych tutaj informacji.
Uwaga
- Pliki są skompresowane gzip & w wielowierszowym formacie 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 świadczenia usługi Azure, w którym znajdują się twoje dane.
- Każdy rekord to około 1 KB danych. Należy wziąć to pod uwagę podczas wybierania prawidłowego parametru pageSize.
- W odpowiedzi mogą zostać zwrócone dodatkowe kolumny. Te kolumny są tymczasowe i mogą zostać usunięte. Użyj 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 |
Uwaga
W każdym z plików Eksportuj można znaleźć właściwość "DeviceGatheredInfo" zawierającą dane dotyczące informacji o oprogramowaniu antywirusowym. Każdy z jego atrybutów może dostarczyć informacji o kondycji urządzenia i jego stanie.
Zobacz też
Eksportowanie raportu kondycji programu antywirusowego urządzenia
Raportowanie kondycji i zgodności urządzeń
Porada
Chcesz dowiedzieć się więcej? Skontaktuj się ze społecznością zabezpieczeń firmy Microsoft w naszej społeczności technicznej: Microsoft Defender for Endpoint Tech Community.