Referenz zur Defender for IoT-API

  • Artikel

In diesem Abschnitt werden die öffentlichen APIs beschrieben, die von Microsoft Defender for IoT unterstützt werden. Defender für IoT-APIs unterliegen der Microsoft-API-Lizenz und den Nutzungsbedingungen.

Verwenden Sie Defender for IoT-APIs für den Zugriff auf Daten, die von Sensoren und lokalen Verwaltungskonsolen erkannt wurden, und die Ausführung von Aktionen mit diesen Daten.

API-Verbindungen werden durch SSL geschützt.

Generieren eines API-Zugriffstokens

Viele Defender for IoT-APIs erfordern ein Zugriffstoken. Zugriffstoken sind für Authentifizierungs-APIs nicht erforderlich.

So generieren Sie ein Token:

  1. Wählen Sie im Fenster Systemeinstellungen die Option Integrationen>Zugriffstoken aus.

  2. Wählen Sie Generate token (Token generieren) aus.

  3. Beschreiben Sie unter Beschreibung, wofür das neue Token vorgesehen ist, und wählen Sie Generieren aus.

  4. Das Zugriffstoken wird angezeigt. Kopieren Sie das Token, da es nicht noch einmal angezeigt wird.

  5. Wählen Sie Fertig stellen aus.

    • Die von Ihnen erstellten Token werden im Dialogfeld Zugriffstoken angezeigt. Verwendet gibt den letzten Zeitpunkt an, zu dem ein externer Aufruf mit diesem Token empfangen wurde.

    • N/V im Feld Verwendet gibt an, dass die Verbindung zwischen dem Sensor und dem verbundenen Server nicht funktioniert.

Fügen Sie nach dem Generieren des Tokens Ihrer Anforderung einen HTTP-Header mit dem Titel Autorisierung hinzu, und legen Sie den Wert auf das von Ihnen generierte Token fest.

Referenz zur Sensor-API-Version

Version Unterstützte APIs
Keine Version Authentifizierung und Kennwortverwaltung:
- set_password (Ihr Kennwort ändern)
- set_password_by_admin (Ein Benutzerkennwort durch den Administrator aktualisieren)
- validation (Benutzeranmeldeinformationen überprüfen)
Neu in Version 1 Bestand:
- connections (Geräteverbindungsinformationen abrufen)
- cves (Informationen zu CVEs abrufen)
- devices (Geräteinformationen abrufen)

Warnungen:
- alerts (Warnungsinformationen abrufen)
- events (Zeitachsenereignisse abrufen)

Sicherheitsrisiken:
- operational (Sicherheitsrisiken bei Betrieb abrufen)
- devices (Informationen zu Gerätesicherheitsrisiken abrufen)
- mitigation (Schritte zur Risikominderung abrufen)
- security (Sicherheitsrisiken abrufen)
Neu in Version 2 Warnungen:
– Aktualisierungen zu alerts (Warnungsinformationen abrufen)

Referenz zur Version der lokalen Verwaltungskonsolen-API

Version APIs
Keine Version Authentifizierung und Kennwortverwaltung:
- set_password (Kennwort ändern)
- set_password_by_admin (Aktualisierung des Benutzerkennworts durch den Systemadministrator)
- validation (Benutzeranmeldeinformationen authentifizieren)
Neu in Version 1 Sites
- appliances (OT-Sensor-Appliances verwalten)
Bestand:
- devices (Alle Geräteinformationen abrufen)

Warnungen:
- alerts (Warnungsinformationen abrufen)
- maintenanceWindow (Warnungsausschlüsse erstellen)
Neu in Version 2 Warnungen:
– Aktualisierungen zu alerts (Warnungsinformationen abrufen)
- pcap (Warnungs-PCAP anfordern)
Neu in Version 3 Integrations-APIs:
- connections (Geräteverbindungen abrufen)
- device (Details für ein Gerät abrufen)
- devicecves (Geräte-CVEs abrufen)
- devices (Geräte erstellen und aktualisieren)
- deleteddevices (Gelöschte Geräte abrufen)
- sensors (Sensoren abrufen)

Hinweis

Integrations-APIs sollen kontinuierlich ausgeführt werden und einen ständig ausgeführten Datenstrom erstellen, z. B. zum Abfragen neuer Daten aus den letzten fünf Minuten. Integrations-APIs geben Daten mit einem Zeitstempel zurück.

Wenn Sie Daten einfach abfragen möchten, verwenden Sie stattdessen die regulären, nicht integrierten APIs für entweder eine lokale Verwaltungskonsole zum Abfragen aller Geräte oder für einen bestimmten Sensor zum Abfragen von Geräten nur von diesem Sensor.

Epochenzeit

In allen Defender for IoT-Zeitstempelwerten ist der Wert für Epochenzeit gleich 01/01/1970.

Nächste Schritte

Weitere Informationen finden Sie unter