Referência da API de gerenciamento de dispositivos para consoles de gerenciamento locais

Artigo
08/11/2022

Este artigo lista as APIs REST de gerenciamento de dispositivos com suporte para consoles de gerenciamento locais do Microsoft Defender para IoT.

dispositivos (gerenciar dispositivos de sensor OT)

Use essa API para gerenciar seus dispositivos de sensor OT de um console de gerenciamento local.

de URI : ou

OBTER

de solicitação de
de resposta
de comando cURL

Sem parâmetros de consulta

Type: JSON

Uma matriz JSON de objetos de dispositivo que representam dispositivos de sensor.

Nome	Tipo	Anulável/ Não anulável	Lista de valores
de ID	Inteiro longo	Não anulável	A ID do sensor
nome	Corda	Não anulável	O nome do sensor
interfaceAddress	Corda	Não anulável	URL do console do sensor
de estado	Matriz JSON	Não anulável	Uma matriz JSON que descreve o status da conexão do sensor. Para obter mais informações, consulte campos XsenseState.
versão	Corda	Não anulável	A versão de software atualmente instalada no sensor.
alertCount	Inteiro longo	Não anulável	O número total de alertas atualmente ativos no sensor.
deviceCount	Inteiro longo	Não anulável	O número de dispositivos detectados no momento pelo sensor.
UnhandledAlertsCount	Longas	Não anulável	O número atual de alertas sem tratamento no sensor.
é Ativado	Booleano	Não anulável	Um dos seguintes: `Activated` ou `Unactivated`
dataIntelligenceVersion	Corda	Não anulável	A versão dos dados de inteligência contra ameaças atualmente instalados no sensor
upgradeStatus	Matriz JSON	Não anulável	Uma matriz JSON que descreve o status de atualização do sensor. Para obter mais informações, consulte campos UpgradeStatusBean.
upgradeFinishTime	Longas	Nullable	A hora em que a última atualização de software foi concluída, no seguinte formato: `YYYY-MM-DD`
hasLog	Booleano	Não anulável	Define se existe um log de atualização para o sensor.
zoneId	Inteiro longo	Nullable	A ID da zona do sensor.
isInLearningMode	Booleano	Não anulável	Define se o sensor está no modo de aprendizagem no momento.

Campos XsenseState

Nome	Tipo	Anulável/ Não anulável	Lista de valores
de ID	Inteiro longo	Não anulável	Uma ID interna incrementada automaticamente no banco de dados do console de gerenciamento local.
xsenseId	Inteiro longo	Não anulável	A ID do sensor.
connectionState	Uma matriz JSON de valores de datetime	Não anulável	Um dos seguintes: `SYNCED`, `OUT_OF_SYNC`, `TIME_DIFF_OFFSET`, `DISCONNECTED`
cmSyncedUntil	DateTime	Não anulável	O carimbo de data/hora dos dados mais recentes enviados do sensor.
sensorSyncedUntil	DateTime	Não anulável	O carimbo de data/hora da última atualização do console de gerenciamento local para o sensor.
sensorLastMessage	DateTime	Não anulável	O carimbo de data/hora da última atualização do sensor.

Campos UpgradeStatusBean

Nome	Tipo	Anulável/ Não anulável	Lista de valores
startTime	DateTime	Não anulável	A hora em que o último processo de atualização foi iniciado.
percentual de	Inteiro entre 0 e 100	Não anulável	O percentual de conclusão do último processo de atualização.
estágio	Corda	Não anulável	Uma das seguintes estátuas: - `UPLOADING`: Carregando o pacote - `PREPARE_TO_INSTALL`: Preparando-se para instalar - `STOPPING_PROCESSES` parando processos - `BACKING_UP_DATA`: Fazer backup de dados - `TAKING_SNAPSHOT`: Tirando instantâneo - `UPDATING_CONFIGURATION`: Atualizando a configuração - `UPDATING_DEPENDENCIES`: Atualizando dependências - `UPDATING_LIBRARIES`: Atualizando bibliotecas - `PATCHING_DATABASES`: aplicação de patch de bancos de dados - `STARTING_PROCESSES`: Iniciando processos - `VALIDATING_SYSTEM_SANITY`: Validando a sanidade do sistema - `VALIDATION_SUCCEEDED_REBOOTING`: validação bem-sucedida - `SUCCESS`: Sucesso - `FAILURE`: Falha - `UPGRADE_STARTED`: Atualização iniciada - `STARTING_INSTALLATION`: Iniciando a instalação - `INSTALLING_OPERATING_SYSTEM`: Instalando o sistema operacional

Exemplo de resposta

[
 {
    "dataIntelligenceVersion":"Dec 22, 2021",
    "name":"Microsoft Defender for IoT",
    "isActivated":true,
    "hasLog":false,
    "zoneId":null,
    "upgradeStatus":null,
    "deviceCount":22,
    "state":{
       "sensorLastMessage":1660217831000,
       "xsenseId":1,
       "sensorSyncedUntil":1660217741000,
       "connectionState":{
          "isConsideredConnected":true,
          "id":1,
          "description":"Connection is successful"
       },
       "cmSyncedUntil":1660217825000,
       "id":1
    },
    "version":"22.1.4.8-r-6372aad",
    "alertCount":9,
    "upgradeFinishTime":null,
    "uid":"a6218f1a-8ebf-4bb3-8613-c859b17eef01",
    "interfaceAddress":"https://173.70.549.76",
    "id":1,
    "unhandledAlertsCount":9
  }
]

Tipo: GET

da API :

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<>IP_ADDRESS>/external/v1/appliances'

exemplo:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/external/v1/appliances'

Próximas etapas

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

Compartilhar via