Dokumentacja interfejsu API zarządzania spisem dla lokalnych konsol zarządzania

Artykuł
06/01/2023

W tym artykule wymieniono interfejsy API REST zarządzania zapasami obsługiwane przez Microsoft Defender dla lokalnych konsol zarządzania IoT

devices (Pobieranie wszystkich informacji o urządzeniu)

Ten interfejs API żąda listy wszystkich urządzeń wykrytych przez czujniki usługi Defender dla IoT, które są połączone z lokalną konsolą zarządzania.

Identyfikator URI: /external/v1/devices

GET

Parametry zapytania:

Nazwa	Opis	Przykład	Wymagane/opcjonalne
Autoryzowanych	Boolean. Filtruje według tego, czy urządzenie jest autoryzowane, czy nie.	`/external/v1/devices?authorized=true` `/external/v1/devices?authorized=false`	Opcjonalne
siteId	Rozdzielona przecinkami lista długich liczb całkowitych. Filtruj urządzenia dla określonych witryn według identyfikatora witryny.	`/external/v1/devices?siteId=1,2`	Opcjonalne
zoneId	Rozdzielona przecinkami lista długich liczb całkowitych. Filtruj urządzenia dla określonych stref według identyfikatora strefy.	`/external/v1/devices?zoneId=5,6`	Opcjonalne
sensorId	Rozdzielona przecinkami lista długich liczb całkowitych. Filtruj urządzenia dla określonych czujników według identyfikatora czujnika.	`/external/v1/devices?sensorId=8`	Opcjonalne

Porada

Jeśli nie masz identyfikatora lokacji, strefy lub czujnika, najpierw wykonaj zapytanie o wszystkie urządzenia, aby pobrać te wartości.

Typ: JSON

Tablica obiektów JSON reprezentujących urządzenia.

Pola urządzenia

Nazwa	Typ	Dopuszczanie wartości null/brak wartości null	Lista wartości
id	Długa liczba całkowita	Nie można pustoć	Identyfikator urządzenia w lokalnej konsoli zarządzania
sensorId	Długa liczba całkowita	Nie można pustoć	Identyfikator urządzenia w czujniku
zoneId	Długa liczba całkowita	Nie można pustoć	Identyfikator strefy urządzenia
siteId	Długa liczba całkowita	Nie można pustoć	Identyfikator witryny urządzenia
ipAddresses	Tablica ciągów w formacie JSON	Dopuszczający wartość null	Tablica JSON adresów IP. Każde urządzenie może mieć wiele adresów w przypadku adresów internetowych lub urządzenia z wieloma kartami sieciowymi.
name	Ciąg	Nie można pustoć	Nazwa urządzenia.
typ	Ciąg	Nie można pustoć	Typ urządzenia. Aby uzyskać więcej informacji, zobacz Obsługiwane `type` wartości.
macAddresses	Tablica ciągów w formacie JSON	Dopuszczający wartość null	Tablica adresów MAC w formacie JSON. Urządzenia z wieloma kartami sieciowymi mogą mieć wiele adresów.
Operatingsystem	Ciąg	Dopuszczający wartość null	System operacyjny urządzenia.
engineeringStation	Wartość logiczna	Nie można pustoć	`True` lub `false`
Skaner	Wartość logiczna	Nie można pustoć	`True` lub `false`
Autoryzowanych	Wartość logiczna	Nie można pustoć	`True` lub `false`
Dostawcy	Ciąg	Dopuszczający wartość null	Dostawca urządzenia.
Protokoły	Tablica JSON	Dopuszczający wartość null	Tablica JSON obiektów protokołu. Aby uzyskać więcej informacji, zobacz Pola protokołu.
Firmware	Tablica JSON	Dopuszczający wartość null	Tablica JSON obiektów oprogramowania układowego. Aby uzyskać więcej informacji, zobacz Pola oprogramowania układowego.

Pola protokołu

Nazwa	Typ	Nullable /Not nullable	Lista wartości
Nazwa	Ciąg	Nie można pustoć	Nazwa protokołu
Adresy	Tablica adresów protokołu JSON	Nie można pustoć	`Master`, `N/A`lub liczbowa reprezentacja adresu protokołu

Pola oprogramowania układowego

Nazwa	Typ	Nullable /Not nullable	Lista wartości
Seryjny	Ciąg	Nie można pustoć	`N/A`lub numer seryjny oprogramowania układowego
Modelu	Ciąg	Nie można pustoć	`N/A`lub model oprogramowania układowego
firmwareVersion	Double	Nie można pustoć	`N/A`lub wersja oprogramowania układowego
additionalData	Ciąg	Nie można pustoć	`N/A` lub dodatkowe dane oprogramowania układowego specyficzne dla dostawcy
moduleAddress	Ciąg	Nie można pustoć	`N/A`lub adres modułu oprogramowania układowego
Rack	Ciąg	Nie można pustoć	`N/A`lub stojak oprogramowania układowego
Gniazdo	Ciąg	Nie można pustoć	`N/A`lub gniazdo oprogramowania układowego
Adres	Ciąg	Nie można pustoć	`N/A`lub adres oprogramowania układowego

Przykład odpowiedzi

[

    {

    "sensorId": 7,

    "zoneId": 1,

    "siteId": 1,

    "vendor": null,

    "name": "10.4.14.102",

    "firmware": [

    {

        "slot": "N/A",

        "additionalData": "N/A",

        "moduleAddress": "Network: Local network (0), Node: 0, Unit: CPU (0x0)",

        "rack": "N/A",

        "address": "10.4.14.102",

        "model": "AAAAAAAAAA",

        "serial": "N/A",

        "firmwareVersion": "20.55"

    },

    {

        "slot": "N/A",

        "additionalData": "N/A",

        "moduleAddress": "Network: Local network (0), Node: 0, Unit: Unknown (0x3)",

        "rack": "N/A",

        "address": "10.4.14.102",

        "model": "AAAAAAAAAAAAAAAAAAAA",

        "serial": "N/A",

        "firmwareVersion": "20.55"

    },

    {

        "slot": "N/A",

        "additionalData": "N/A",

        "moduleAddress": "Network: Local network (0), Node: 3, Unit: CPU (0x0)",

        "rack": "N/A",

        "address": "10.4.14.102",

        "model": "AAAAAAAAAAAAAAAAAAAA",

        "serial": "N/A",

        "firmwareVersion": "20.55"

    },

    {

        "slot": "N/A",

        "additionalData": "N/A",

        "moduleAddress": "Network: 3, Node: 0, Unit: CPU (0x0)",

        "rack": "N/A",

        "address": "10.4.14.102",

        "model": "AAAAAAAAAAAAAAAAAAAA",

        "serial": "N/A",

        "firmwareVersion": "20.55"

    }

],

"id": 79,

"macAddresses": null,

"authorized": true,

"ipAddresses": [

    "10.4.14.102"

],

"engineeringStation": false,

"type": "PLC",

"operatingSystem": null,

"protocols": [

    {

        "addresses": [],

        "id": 62,

        "name": "Omron FINS"

    }

],

"scanner": false

}

]

Typ: GET

Interfejsy API:

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/external/v1/devices?siteId=&zoneId=&sensorId=&uthorized='

Przykład:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/devices?siteId=1&zoneId=2&sensorId=5&authorized=true'

Następne kroki

Aby uzyskać więcej informacji, zobacz Omówienie interfejsu API usługi Defender for IoT.

Udostępnij za pośrednictwem