Informations de référence sur l’API de gestion des appliances pour les consoles de gestion locales

Cet article répertorie les API REST de gestion des appliances prises en charge pour les consoles de gestion locales Microsoft Defender pour IoT.

appliances (Gérer les appliances de capteur OT)

Utilisez cette API pour gérer vos appliances de capteur OT à partir d’une console de gestion locale.

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

AVOIR

demande de

Aucun paramètre de requête

Réponse

type: JSON

Tableau JSON d’objets d’appliance qui représentent des appliances de capteur.

Nom	Type	Nullable / Non nullable	Liste des valeurs
id de	Entier long	Non nullable	ID du capteur
nom	Corde	Non nullable	Nom du capteur
interfaceAddress	Corde	Non nullable	URL de la console du capteur
d’état	Tableau JSON	Non nullable	Tableau JSON qui décrit l’état de connexion du capteur. Pour plus d’informations, consultez champs XsenseState.
version	Corde	Non nullable	Version logicielle actuellement installée sur le capteur.
alertCount	Entier long	Non nullable	Nombre total d’alertes actuellement actives sur le capteur.
deviceCount	Entier long	Non nullable	Nombre d’appareils actuellement détectés par le capteur.
non géréAlertsCount	long	Non nullable	Nombre actuel d’alertes non gérées sur le capteur.
isActivated	Booléen	Non nullable	L’une des options suivantes : Activated ou Unactivated
dataIntelligenceVersion	Corde	Non nullable	Version des données de renseignement sur les menaces actuellement installées sur le capteur
upgradeStatus	Tableau JSON	Non nullable	Tableau JSON qui décrit l’état de mise à jour du capteur. Pour plus d’informations, consultez champs UpgradeStatusBean.
upgradeFinishTime	Long	Nullable	Heure de la dernière mise à jour logicielle, au format suivant : YYYY-MM-DD
hasLog	Booléen	Non nullable	Définit si un journal de mise à niveau existe pour le capteur.
zoneId	Entier long	Nullable	ID de la zone du capteur.
isInLearningMode	Booléen	Non nullable	Définit si le capteur est actuellement en mode apprentissage.

Champs XsenseState

Nom	Type	Nullable / Non nullable	Liste des valeurs
id de	Entier long	Non nullable	ID interne incrémenté automatiquement sur la base de données de la console de gestion locale.
xsenseId	Entier long	Non nullable	ID du capteur.
connectionState	Tableau JSON de valeurs datetime	Non nullable	L’une des options suivantes : SYNCED, OUT_OF_SYNC, TIME_DIFF_OFFSET, DISCONNECTED
cmSyncedUntil	DateTime	Non nullable	Horodatage pour les données les plus récentes envoyées à partir du capteur.
sensorSyncedUntil	DateTime	Non nullable	Horodatage de la dernière mise à jour de la console de gestion locale vers le capteur.
sensorLastMessage	DateTime	Non nullable	Horodatage de la dernière mise à jour à partir du capteur.

Champs UpgradeStatusBean

Nom	Type	Nullable / Non nullable	Liste des valeurs
startTime	DateTime	Non nullable	Heure de démarrage du dernier processus de mise à jour.
pourcentage	Entier compris entre 0 et 100	Non nullable	Pourcentage d’achèvement du dernier processus de mise à jour.
étape	Corde	Non nullable	Une des statues suivantes : - UPLOADING: chargement du package - PREPARE_TO_INSTALL: préparation de l’installation - STOPPING_PROCESSES processus d’arrêt - BACKING_UP_DATA: Sauvegarde des données - TAKING_SNAPSHOT: Prise d’instantané - UPDATING_CONFIGURATION: mise à jour de la configuration - UPDATING_DEPENDENCIES: mise à jour des dépendances - UPDATING_LIBRARIES: mise à jour des bibliothèques - PATCHING_DATABASES: Mise à jour corrective des bases de données - STARTING_PROCESSES: démarrage des processus - VALIDATING_SYSTEM_SANITY: validation de la sanité du système - VALIDATION_SUCCEEDED_REBOOTING: Validation réussie - SUCCESS: Réussite - FAILURE: Échec - UPGRADE_STARTED: mise à niveau démarrée - STARTING_INSTALLATION: démarrage de l’installation - INSTALLING_OPERATING_SYSTEM: installation du système d’exploitation

Exemple de réponse

[
 {
    "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
  }
]

commande cURL

type: GET

API:

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

exemple :

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

Étapes suivantes

Pour plus d’informations, consultez la vue d’ensemble de la référence de l’API Defender pour IoT.