Referência da API de gerenciamento de inventário para consoles de gerenciamento locais

Este artigo lista as APIs REST de gerenciamento de inventário com suporte para consoles de gerenciamento local do Microsoft Defender para IoT.

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

Essa API solicita uma lista de todos os dispositivos detectados pelos sensores do Defender para IoT conectados a um console de gerenciamento local.

URI: /external/v1/devices

GET

Solicitação

Parâmetros de consulta:

Nome	Descrição	Exemplo	Obrigatório/Opcional
autorizado	Booliano. Filtra por 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 inteiros longos. Filtrar dispositivos para sites especificados por ID do site.	/external/v1/devices?siteId=1,2	Opcional
zoneId	Lista separada por vírgulas de inteiros longos. Filtrar dispositivos para zonas especificadas por ID do site.	/external/v1/devices?zoneId=5,6	Opcional
sensorId	Lista separada por vírgulas de inteiros longos. Filtrar dispositivos para sensores especificados por ID do sensor.	/external/v1/devices?sensorId=8	Opcional

Dica

Se você não tiver uma ID de site, de zona ou de sensor, primeiro faça uma consulta sobre todos os dispositivos para recuperar esses valores.

Resposta

Tipo: JSON

Matriz de objetos JSON que representam dispositivos.

Campos do dispositivo

Nome	Type	Anulável/Não anulável	Lista de valores
id	Long integer	Não permite valor nulo	ID do dispositivo no console de gerenciamento local
sensorId	Long integer	Não permite valor nulo	ID do dispositivo no sensor
zoneId	Long integer	Não permite valor nulo	ID da zona do dispositivo
siteId	Long integer	Não permite valor nulo	ID do site do dispositivo
ipAddresses	Matriz de cadeias de caracteres JSON	Nullable	Matriz JSON de endereços IP. Cada dispositivo pode ter vários endereços no caso de endereços da internet ou um dispositivo com várias NICs.
name	String	Não permite valor nulo	O nome do dispositivo.
tipo	String	Não permite valor nulo	O tipo de dispositivo. Para obter mais informações, confira Valores type com suporte.
macAddresses	Matriz de cadeias de caracteres JSON	Nullable	Uma matriz JSON de endereços MAC. Dispositivos com várias NICs podem ter vários endereços.
operatingSystem	String	Nullable	Sistema operacional do dispositivo.
engineeringStation	Boolean	Não permite valor nulo	True ou false
scanner	Boolean	Não permite valor nulo	True ou false
autorizado	Boolean	Não permite valor nulo	True ou false
vendor	String	Nullable	O fornecedor do dispositivo.
Protocolos	Matriz JSON	Nullable	Matriz JSON de objetos de protocolo. Para saber mais, confira Campos de protocolo.
firmware	Matriz JSON	Nullable	Matriz JSON de objetos de firmware. Para obter mais informações, confira Campos do firmware.

Campos de protocolo

Nome	Type	Anulável/Não anulável	Lista de valores
Nome	String	Não permite valor nulo	O nome do protocolo
Endereços	Matriz JSON de endereços de protocolo	Não permite valor nulo	Master, N/A ou uma representação numérica do endereço do protocolo

Campos de firmware

Nome	Type	Anulável/Não anulável	Lista de valores
serial	String	Não permite valor nulo	N/A, ou o número de série do firmware
modelo	String	Não permite valor nulo	N/A ou o modelo de firmware
firmwareVersion	Double	Não permite valor nulo	N/A ou a versão do firmware
additionalData	String	Não permite valor nulo	N/A ou dados de firmware adicionais e específicos ao fornecedor
moduleAddress	String	Não permite valor nulo	N/A ou o endereço do módulo de firmware
rack	String	Não permite valor nulo	N/A ou o rack de firmware
slot	String	Não permite valor nulo	N/A ou o slot de firmware
address	String	Não permite valor nulo	N/A ou 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 de 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'

Próximas etapas

Para obter mais informações, confira a Visão geral de referência da API do Defender para IoT.