Eksportowanie spisu oceny sprzętu i oprogramowania układowego na urządzenie
Dotyczy:
- Ochrona punktu końcowego w usłudze Microsoft Defender (plan 1)
- Ochrona punktu końcowego w usłudze Microsoft Defender (plan 2)
- Zarządzanie lukami w zabezpieczeniach w usłudze Microsoft Defender
- Microsoft Defender XDR
Chcesz doświadczyć Zarządzanie lukami w zabezpieczeniach w usłudze Microsoft Defender? Dowiedz się więcej o tym, jak można zarejestrować się w Zarządzanie lukami w zabezpieczeniach w usłudze Microsoft Defender publicznej wersji zapoznawczej.
Istnieją różne wywołania interfejsu API umożliwiające pobieranie różnych typów danych. Ogólnie rzecz biorąc, każde wywołanie interfejsu API zawiera wymagane dane dla urządzeń w organizacji.
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. Dane z usługi Azure Storage można pobrać 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.
Uwaga
O ile nie wskazano inaczej, wszystkie wymienione metody oceny sprzętu i oprogramowania układowego eksportu są eksportowane w całości i przez urządzenie (określane również jako na urządzeniu)
1. Eksportowanie oceny sprzętu i oprogramowania układowego (odpowiedź JSON)
Opis metody interfejsu API 1.1
Zwraca wszystkie oceny sprzętu i oprogramowania układowego dla wszystkich urządzeń na poszczególnych urządzeniach. Zwraca tabelę z oddzielnym wpisem dla każdej unikatowej kombinacji elementów deviceId i componentType.
1.1.1 Ograniczenia
- Maksymalny rozmiar strony to 200 000.
- Ograniczenia szybkości dla tego interfejsu API to 30 wywołań na minutę i 1000 wywołań na godzinę.
1.2 Uprawnienia
Do wywołania tego interfejsu API jest wymagane jedno z następujących uprawnień. Aby dowiedzieć się więcej, w tym jak wybrać uprawnienia, zobacz Używanie interfejsów API Ochrona punktu końcowego w usłudze Microsoft Defender, aby uzyskać szczegółowe informacje.
| Typ uprawnień | Uprawnienie | Nazwa wyświetlana uprawnień |
|---|---|---|
| Aplikacja | Software.Read.All | "Odczytywanie informacji o oprogramowaniu do zarządzania zagrożeniami i lukami w zabezpieczeniach" |
| Delegowane (konto służbowe) | Software.Read | "Odczytywanie informacji o oprogramowaniu do zarządzania zagrożeniami i lukami w zabezpieczeniach" |
Adres URL 1.3
GET api/machines/HardwareFirmwareInventoryByMachine
Parametry 1.4
- pageSize (wartość domyślna = 50 000): liczba wyników w odpowiedzi.
- $top: liczba wyników do zwrócenia (nie zwraca @odata.nextLink i dlatego nie ściąga wszystkich danych).
1.5 Właściwości (odpowiedź JSON)
Uwaga
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żywaj tylko udokumentowanych kolumn.
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.
| Właściwość (ID) | Typ danych | Opis |
|---|---|---|
| Deviceid | Ciąg | Unikatowy identyfikator urządzenia w usłudze. |
| rbacGroupId | Int | Identyfikator grupy kontroli dostępu opartej na rolach (RBAC). Jeśli urządzenie nie jest przypisane do żadnej grupy RBAC, wartość będzie mieć wartość "Nieprzypisane". Jeśli organizacja nie zawiera żadnych grup RBAC, wartość będzie mieć wartość "Brak". |
| rbacGroupName | Ciąg | Grupa kontroli dostępu opartej na rolach (RBAC). Jeśli urządzenie nie jest przypisane do żadnej grupy RBAC, wartość będzie mieć wartość "Nieprzypisane". Jeśli organizacja nie zawiera żadnych grup RBAC, wartość będzie mieć wartość "Brak". |
| deviceName | Ciąg | W pełni kwalifikowana nazwa domeny (FQDN) urządzenia. |
| Componenttype | Ciąg | Typ składnika sprzętu lub oprogramowania układowego. |
| Producent | Ciąg | Producent określonego składnika sprzętu lub oprogramowania układowego. |
| componentName | Ciąg | Nazwa określonego składnika sprzętu lub oprogramowania układowego. |
| componentVersion | Ciąg | Wersja określonego składnika sprzętu lub oprogramowania układowego. |
| dodatkowe pola | Ciąg | Dodatkowe informacje o składnikach w formacie tablicy JSON. |
Przykład 1.6
1.6.1 Przykład żądania
GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryByMachine
Przykład odpowiedzi 1.6.2
{
"@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. Eksportowanie oceny sprzętu i oprogramowania układowego (za pośrednictwem plików)
Opis metody interfejsu API w wersji 2.1
Zwraca wszystkie oceny sprzętu i oprogramowania układowego dla wszystkich urządzeń na poszczególnych urządzeniach. Zwraca tabelę z oddzielnym wpisem dla każdej unikatowej kombinacji elementów DeviceId, ComponentType i ComponentName.
Ograniczenia 2.1.1
- Ograniczenia szybkości dla tego interfejsu API to 5 wywołań na minutę i 20 wywołań na godzinę.
2.2 Uprawnienia
Do wywołania tego interfejsu API jest wymagane jedno z następujących uprawnień. Aby dowiedzieć się więcej, w tym jak wybrać uprawnienia, zobacz Używanie interfejsów API Ochrona punktu końcowego w usłudze Microsoft Defender, aby uzyskać szczegółowe informacje.
| Typ uprawnień | Uprawnienie | Nazwa wyświetlana uprawnień |
|---|---|---|
| Aplikacja | Software.Read.All | "Odczytywanie informacji o oprogramowaniu do zarządzania zagrożeniami i lukami w zabezpieczeniach" |
| Delegowane (konto służbowe) | Software.Read | "Odczytywanie informacji o oprogramowaniu do zarządzania zagrożeniami i lukami w zabezpieczeniach" |
Adres URL 2.3
GET /api/machines/HardwareFirmwareInventoryExport
Parametry 2.4
- sasValidHours: liczba godzin, przez które adresy URL pobierania będą ważne (maksymalnie 24 godziny).
2.5 Właściwości (odpowiedź JSON)
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 zmaksymalizować szybkość pobierania, upewnij 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 parametru pageSize, który działa dla Ciebie.
W odpowiedzi mogą zostać zwrócone dodatkowe kolumny. Te kolumny są tymczasowe i mogą zostać usunięte. Używaj tylko udokumentowanych kolumn.
| Właściwość (ID) | Typ danych | Opis |
|---|---|---|
| Eksportowanie plików | Ciąg[tablica] | Lista adresów URL pobierania plików przechowujących bieżącą migawkę organizacji. |
| GeneratedTime | Datetime | Czas wygenerowania eksportu. |
Przykład 2.6
2.6.1 Przykład żądania
GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryExport
Przykład odpowiedzi 2.6.2
{
"@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"
}
Opinia
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.
Prześlij i wyświetl opinię dla