Dokumentacja interfejsu API usługi Defender for IoT

Artykuł
12/18/2023

W tej sekcji opisano publiczne interfejsy API obsługiwane przez usługę Microsoft Defender dla IoT. Interfejsy API usługi Defender for IoT podlegają licencji interfejsu API firmy Microsoft i postanowień użytkowania.

Użyj interfejsów API usługi Defender dla IoT, aby uzyskać dostęp do danych wykrytych przez czujniki i lokalne konsole zarządzania oraz wykonywać akcje przy użyciu tych danych.

Połączenia interfejsu API są zabezpieczone za pośrednictwem protokołu SSL.

Generowanie tokenu dostępu interfejsu API

Wiele interfejsów API usługi Defender dla IoT wymaga tokenu dostępu. Tokeny dostępu nie są wymagane dla interfejsów API uwierzytelniania.

Aby wygenerować token:

W oknie System Ustawienia wybierz pozycję Integracje Tokeny> dostępu.
Wybierz pozycję Generuj token.
W polu Opis opisz nowy token i wybierz pozycję Generuj.
Zostanie wyświetlony token dostępu. Skopiuj go, ponieważ nie zostanie on ponownie wyświetlony.
Wybierz Zakończ.
- Utworzone tokeny są wyświetlane w oknie dialogowym Tokeny dostępu. Wartość Używane wskazuje czas ostatniego odebrania wywołania zewnętrznego z tym tokenem.
- N/A w polu Używane wskazuje, że połączenie między czujnikiem a połączonym serwerem nie działa.

Po wygenerowaniu tokenu dodaj nagłówek HTTP o nazwie Autoryzacja do żądania i ustaw jego wartość na wygenerowany token.

Dokumentacja wersji interfejsu API czujnika

Wersja	Obsługiwane interfejsy API
Brak wersji	Zarządzanie uwierzytelnianiem i hasłami: - set_password (zmień hasło) - set_password_by_admin (aktualizowanie hasła użytkownika przez administratora) - validation (Validate user credentials) (Weryfikowanie poświadczeń użytkownika)
Nowość w wersji 1	Spis: - połączenia (pobieranie informacji o połączeniu urządzenia) - cves (Pobieranie informacji o CVEs) - urządzenia (pobieranie informacji o urządzeniu) Alerty: - alerty (pobieranie informacji o alertach) - events (Pobieranie zdarzeń osi czasu) Luki w zabezpieczeniach: - operacyjne (pobieranie luk w zabezpieczeniach operacyjnych) - urządzenia (pobieranie informacji o lukach w zabezpieczeniach urządzenia) - środki zaradcze (pobieranie kroków ograniczania ryzyka) - zabezpieczenia (pobieranie luk w zabezpieczeniach)
Nowość w wersji 2	Alerty: — Aktualizacje do alertów (pobieranie informacji o alertach)

Dokumentacja wersji lokalnego interfejsu API konsoli zarządzania

Wersja	Interfejsy API
Brak wersji	Zarządzanie uwierzytelnianiem i hasłami: - set_password (Zmień hasło) - set_password_by_admin (aktualizacja hasła użytkownika przez administratora systemu) - walidacja (uwierzytelnianie poświadczeń użytkownika)
Nowość w wersji 1	Witryn - urządzenia (zarządzanie urządzeniami czujników OT) Spis: - urządzenia (pobierz wszystkie informacje o urządzeniu) Alerty: - alerty (pobieranie informacji o alertach) - maintenanceWindow (Tworzenie wykluczeń alertów)
Nowość w wersji 2	Alerty: — Aktualizacje do alertów (pobieranie informacji o alertach) - pcap (Żądanie alertu PCAP)
Nowość w wersji 3	Interfejsy API integracji: - połączenia (pobieranie połączeń urządzeń) - device (Pobieranie szczegółów dla urządzenia) - devicecves (Pobieranie cves urządzenia) - urządzenia (tworzenie i aktualizowanie urządzeń) - deleteddevices (Pobieranie usuniętych urządzeń) - czujniki (pobierz czujniki)

Uwaga

Interfejsy API integracji są przeznaczone do ciągłego uruchamiania i tworzenia stale uruchomionego strumienia danych, takiego jak wykonywanie zapytań o nowe dane z ostatnich pięciu minut. Interfejsy API integracji zwracają dane ze znacznikiem czasu.

Aby po prostu wykonywać zapytania dotyczące danych, użyj zwykłych, niezwiązanych z integracją interfejsów API, aby użyć lokalnej konsoli zarządzania do wykonywania zapytań dotyczących wszystkich urządzeń lub dla określonego czujnika w celu wykonywania zapytań dotyczących urządzeń tylko z tego czujnika.

Czas epoki

We wszystkich wartościach znacznika czasu usługi Defender dla IoT czas epoki jest równy 1/1/1970.

Następne kroki

Aby uzyskać więcej informacji, zobacz:

Udostępnij za pośrednictwem