API-referens för lagerhantering för lokala hanteringskonsoler

I den här artikeln visas rest-API:er för lagerhantering som stöds för Microsoft Defender för lokala IoT-hanteringskonsoler

enheter (Hämta all enhetsinformation)

Det här API:et begär en lista över alla enheter som identifierats av Defender för IoT-sensorer som är anslutna till en lokal hanteringskonsol.

URI: /external/v1/devices

GET

Förfrågan

Frågeparametrar:

Name	Beskrivning	Exempel	Obligatoriskt/valfritt
Auktoriserad	Boolean. Filtrerar efter om enheten är auktoriserad eller inte.	/external/v1/devices?authorized=true /external/v1/devices?authorized=false	Valfritt
siteId	Kommaavgränsad lista över långa heltal. Filtrera enheter för angivna platser efter plats-ID.	/external/v1/devices?siteId=1,2	Valfritt
Zonid	Kommaavgränsad lista över långa heltal. Filtrera enheter för angivna zoner efter zon-ID.	/external/v1/devices?zoneId=5,6	Valfritt
sensorId	Kommaavgränsad lista över långa heltal. Filtrera enheter för angivna sensorer efter sensor-ID.	/external/v1/devices?sensorId=8	Valfritt

Tips

Om du inte har något plats-, zon- eller sensor-ID frågar du först alla enheter för att hämta dessa värden.

Response

Typ: JSON

Matris med JSON-objekt som representerar enheter.

Enhetsfält

Namn	Typ	Nullable/Not nullable	Lista över värden
id	Långt heltal	Inte nullbar	Enhets-ID i den lokala hanteringskonsolen
sensorId	Långt heltal	Inte nullbar	Enhets-ID på sensorn
Zonid	Långt heltal	Inte nullbar	Enhetens zon-ID
siteId	Långt heltal	Inte nullbar	Enhetens plats-ID
ipAddresses	JSON-matris med strängar	Kan ha värdet null	JSON-matris med IP-adresser. Varje enhet kan ha flera adresser om det gäller internetadresser eller en enhet med flera nätverkskort.
name	Sträng	Inte nullbar	Enhetens namn.
Typ	Sträng	Inte nullbar	Enhetstypen. Mer information finns i Värden som stödstype.
macAddresses	JSON-matris med strängar	Kan ha värdet null	JSON-matris med MAC-adresser. Enheter med flera nätverkskort kan ha flera adresser.
operatingSystem	Sträng	Kan ha värdet null	Enhetens operativsystem.
engineeringStation	Boolesk	Inte nullbar	True eller false
Scanner	Boolesk	Inte nullbar	True eller false
Auktoriserad	Boolesk	Inte nullbar	True eller false
Leverantör	Sträng	Kan ha värdet null	Enhetsleverantören.
Protokoll	JSON-matris	Kan ha värdet null	JSON-matris med protokollobjekt. Mer information finns i Protokollfält.
Firmware	JSON-matris	Kan ha värdet null	JSON-matris med objekt för inbyggd programvara. Mer information finns i Fält för inbyggd programvara.

Protokollfält

Namn	Typ	Nullbar/kan inte ha värdet null	Lista över värden
Namn	Sträng	Kan inte ha värdet null	Protokollnamnet
Adresser	JSON-matris med protokolladresser	Kan inte ha värdet null	Master, N/Aeller en numerisk representation av protokolladressen

Fält för inbyggd programvara

Namn	Typ	Nullbar/kan inte ha värdet null	Lista över värden
Seriell	Sträng	Kan inte ha värdet null	N/A, eller serienumret för inbyggd programvara
Modell	Sträng	Kan inte ha värdet null	N/A, eller modellen för inbyggd programvara
versionInbyggdProgramvara	Double	Kan inte ha värdet null	N/A, eller versionen av inbyggd programvara
additionalData	Sträng	Kan inte ha värdet null	N/A eller ytterligare, leverantörsspecifika data om inbyggd programvara
moduleAddress	Sträng	Kan inte ha värdet null	N/A, eller moduladressen för inbyggd programvara
Rack	Sträng	Kan inte ha värdet null	N/A, eller rack för inbyggd programvara
Slot	Sträng	Kan inte ha värdet null	N/A, eller facket för inbyggd programvara
Adress	Sträng	Kan inte ha värdet null	N/A, eller adressen för den inbyggda programvaran

Exempel på svar

[

    {

    "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

}

]

cURL-kommando

Typ: GET

API:er:

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

Exempel:

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

Nästa steg

Mer information finns i referensöversikten för Defender för IoT API.