Referência da API de gestão de inventário para consolas de gestão no local

Este artigo lista as APIs REST de gestão de inventário suportadas para Microsoft Defender para consolas de gestão no local do IoT

dispositivos (Obter todas as informações do dispositivo)

Esta API pede uma lista de todos os dispositivos detetados pelos sensores do Defender para IoT que estão ligados a uma consola de gestão no local.

URI: /external/v1/devices

GET

Pedir

Parâmetros de consulta:

Nome	Descrição	Exemplo	Obrigatório/Opcional
autorizado	Booleano. Filtra se o dispositivo está autorizado ou não.	/external/v1/devices?authorized=true /external/v1/devices?authorized=false	Opcional
siteId	Lista separada por vírgulas de números inteiros longos. Filtrar dispositivos para sites especificados por ID de site.	/external/v1/devices?siteId=1,2	Opcional
zoneId	Lista separada por vírgulas de números inteiros longos. Filtrar dispositivos para zonas especificadas por ID de zona.	/external/v1/devices?zoneId=5,6	Opcional
sensorId	Lista separada por vírgulas de números inteiros longos. Filtrar dispositivos para sensores especificados por ID de sensor.	/external/v1/devices?sensorId=8	Opcional

Dica

Se não tiver um ID de site, zona ou sensor, consulte primeiro todos os dispositivos para obter estes valores.

Response

Tipo: JSON

Matriz de objetos JSON que representam dispositivos.

Campos do dispositivo

Nome	Tipo	Anulável / Não nulo	Lista de valores
id	Número inteiro longo	Não nulo	ID do dispositivo na consola de gestão no local
sensorId	Número inteiro longo	Não nulo	ID do dispositivo no sensor
zoneId	Número inteiro longo	Não nulo	O ID de zona do dispositivo
siteId	Número inteiro longo	Não nulo	O ID do site do dispositivo
ipAddresses	Matriz JSON de cadeias	Pode ser nulo	Matriz JSON de endereços IP. Cada dispositivo pode ter vários endereços no caso de endereços internet ou de um dispositivo com várias NICs.
nome	String	Não nulo	O nome do dispositivo.
tipo	String	Não nulo	O tipo de dispositivo. Para obter mais informações, veja Valores suportadostype.
macAddresses	Matriz JSON de cadeias	Pode ser nulo	Matriz JSON de endereços MAC. Os dispositivos com várias NICs podem ter vários endereços.
operatingSystem	String	Pode ser nulo	O sistema operativo do dispositivo.
engineeringStation	Booleano	Não nulo	True ou false
scanner	Booleano	Não nulo	True ou false
autorizado	Booleano	Não nulo	True ou false
fornecedor	String	Pode ser nulo	O fornecedor do dispositivo.
Protocolos	Matriz JSON	Pode ser nulo	Matriz JSON de objetos de protocolo. Para obter mais informações, veja Campos de protocolo.
firmware	Matriz JSON	Pode ser nulo	Matriz JSON de objetos de firmware. Para obter mais informações, veja Campos de firmware.

Campos de protocolo

Nome	Tipo	Anulável / Não nulo	Lista de valores
Nome	String	Não nulo	O nome do protocolo
Endereços	Matriz JSON de endereços de protocolo	Não nulo	Master, N/Aou uma representação numérica do endereço de protocolo

Campos de firmware

Nome	Tipo	Anulável / Não nulo	Lista de valores
serial	String	Não nulo	N/Aou o número de série de firmware
modelo	String	Não nulo	N/Aou o modelo de firmware
firmwareVersion	Double (Duplo)	Não nulo	N/Aou a versão de firmware
additionalData	String	Não nulo	N/A ou dados de firmware adicionais específicos do fornecedor
moduleAddress	String	Não nulo	N/Aou o endereço do módulo de firmware
rack	String	Não nulo	N/Aou o rack de firmware
bloco	String	Não nulo	N/Aou o bloco de firmware
endereço	String	Não nulo	N/Aou o endereço de firmware

Exemplo de resposta

[

    {

    "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

}

]

Comando cURL

Tipo: GET

APIs:

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

Exemplo:

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

Passos seguintes

Para obter mais informações, veja Descrição geral da referência da API do Defender para IoT.