Referência da API de gestão de aplicações para consolas de gestão no local

Artigo
07/15/2024

Este artigo lista as APIs REST de gestão de aplicações suportadas para Microsoft Defender para consolas de gestão no local do IoT.

aplicações (Gerir aplicações de sensores OT)

Utilize esta API para gerir as aplicações do sensor OT a partir de uma consola de gestão no local.

URI: /external/v1/appliances ou /external/v2/appliances

GET

Sem parâmetros de consulta

Tipo: JSON

Uma matriz JSON de objetos da aplicação que representam aplicações de sensores.

Nome	Tipo	Anulável / Não nulo	Lista de valores
id	Número inteiro longo	Não nulo	O ID do sensor
nome	String	Não nulo	O nome do sensor
interfaceAddress	String	Não nulo	O URL da consola do sensor
estado	Matriz JSON	Não nulo	Uma matriz JSON que descreve o estado de ligação do sensor. Para obter mais informações, veja Campos XsenseState.
versão	String	Não nulo	A versão de software atualmente instalada no sensor.
alertCount	Número inteiro longo	Não nulo	O número total de alertas atualmente ativos no sensor.
deviceCount	Número inteiro longo	Não nulo	O número de dispositivos atualmente detetados pelo sensor.
unhandledAlertsCount	long	Não nulo	O número atual de alertas não processados no sensor.
isActivated	Booleano	Não nulo	Uma das seguintes opções: `Activated` ou `Unactivated`
dataIntelligenceVersion	String	Não nulo	A versão dos dados de informações sobre ameaças atualmente instalada no sensor
upgradeStatus	Matriz JSON	Não nulo	Uma matriz JSON que descreve o estado de atualização do sensor. Para obter mais informações, veja Campos UpgradeStatusBean.
upgradeFinishTime	Longo	Pode ser nulo	A hora em que a última atualização de software foi concluída, no seguinte formato: `YYYY-MM-DD`
hasLog	Booleano	Não nulo	Define se existe um registo de atualização para o sensor.
zoneId	Número inteiro longo	Pode ser nulo	O ID da zona do sensor.
isInLearningMode	Booleano	Não nulo	Define se o sensor está atualmente no modo de aprendizagem.

Campos XsenseState

Nome	Tipo	Anulável / Não nulo	Lista de valores
id	Número inteiro longo	Não nulo	Um ID interno incrementado automaticamente na base de dados da consola de gestão no local.
xsenseId	Número inteiro longo	Não nulo	O ID do sensor.
connectionState	Uma matriz JSON de valores datetime	Não nulo	Um dos seguintes: `SYNCED`, , `OUT_OF_SYNC`, `TIME_DIFF_OFFSETDISCONNECTED`
cmSyncedUntil	DateTime	Não nulo	O carimbo de data/hora dos dados mais recentes enviados do sensor.
sensorSyncedUntil	DateTime	Não nulo	O carimbo de data/hora da última atualização da consola de gestão no local para o sensor.
sensorLastMessage	DateTime	Não nulo	O carimbo de data/hora da última atualização do sensor.

Campos UpgradeStatusBean

Nome	Tipo	Anulável / Não nulo	Lista de valores
startTime	DateTime	Não nulo	A hora em que o último processo de atualização foi iniciado.
percentagem	Número inteiro entre 0 e 100	Não nulo	A percentagem de conclusão do último processo de atualização.
fase	String	Não nulo	Uma das seguintes estátuas: - `UPLOADING`: Carregar Pacote - `PREPARE_TO_INSTALL`: A preparar a instalação - `STOPPING_PROCESSES` Parar Processos - `BACKING_UP_DATA`: Fazer cópia de segurança de dados - `TAKING_SNAPSHOT`: Tirar Instantâneo - `UPDATING_CONFIGURATION`: A atualizar a configuração - `UPDATING_DEPENDENCIES`: Atualizar Dependências - `UPDATING_LIBRARIES`: Atualizar Bibliotecas - `PATCHING_DATABASES`: Aplicação de Patches a Bases de Dados - `STARTING_PROCESSES`: Iniciar Processos - `VALIDATING_SYSTEM_SANITY`: Validar a Sanidade do Sistema - `VALIDATION_SUCCEEDED_REBOOTING`: Validação Bem-sucedida - `SUCCESS`: Êxito - `FAILURE`: Falha - `UPGRADE_STARTED`: Atualização Iniciada - `STARTING_INSTALLATION`: Iniciar a Instalação - `INSTALLING_OPERATING_SYSTEM`: Instalar o SO

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

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'

Passos seguintes

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

Partilhar via