Utilisez cette API pour effectuer une action spécifiée sur une alerte spécifique détectée par Defender pour IoT.
Par exemple, vous pouvez utiliser cette API pour créer une règle de transfert qui transfère des données à QRadar. Pour plus d’informations, consultez Intégrer Qradar avec Microsoft Defender pour IoT.
Gère les fenêtres de maintenance, sous lesquelles les alertes ne seront pas envoyées. Utilisez cette API pour définir et mettre à jour les heures d’arrêt et de démarrage, les appareils ou sous-réseaux qui doivent être exclus lors du déclenchement d’alertes ou les moteurs Defender pour IoT qui doivent être exclus.
Par exemple, au cours d’une fenêtre de maintenance, vous souhaiterez peut-être arrêter l’envoi de toutes les alertes, à l’exception des alertes de programmes malveillants sur les appareils critiques.
Les fenêtres de maintenance définies avec l’API maintenanceWindow apparaissent dans la fenêtre Exclusions d’alerte de la console de gestion locale comme règle d’exclusion en lecture seule, nommée avec la syntaxe suivante : Maintenance-{token name}-{ticket ID}
Important
Cette API est prise en charge uniquement à des fins de maintenance pour une durée limitée, et n’est pas destinée à être utilisée à la place des règles d’exclusion d’alerte. Utilisez cette API pour les opérations de maintenance temporaires et ponctuelles uniquement.
Chaîne. Définit l’ID du ticket de maintenance dans les systèmes de l’utilisateur. Assurez-vous que l’ID de ticket n’est pas lié à une fenêtre ouverte existante.
2987345p98234
Obligatoire
ttl
Entier positif. Définit la durée de vie (TTL), qui correspond à la durée de la fenêtre de maintenance, en minutes. Une fois la période définie terminée, la fenêtre de maintenance est terminée et le système se comporte à nouveau normalement.
180
Obligatoire
engines
Tableau JSON de chaînes. Définit le moteur pour lequel supprimer les alertes pendant la fenêtre de maintenance. Valeurs possibles :
Tableau JSON de chaînes. Définit les capteurs pour lesquels supprimer les alertes pendant la fenêtre de maintenance. Vous pouvez obtenir ces ID de capteur à partir de l’API appliances (Gérer les appliances de capteur OT).
1,35,63
Facultatif
Sous-réseaux
Tableau JSON de chaînes. Définit les sous-réseaux pour lesquels supprimer les alertes pendant la fenêtre de maintenance. Définissez chaque sous-réseau dans une notation CIDR.
192.168.0.0/16,138.136.80.0/14,112.138.10.0/8
Facultatif
Code d’état
Message
Description
201 (Créé)
-
L’action s’est effectuée correctement.
400 (Requête incorrecte)
Pas de TicketId
La requête d’API n’a pas de valeur ticketId.
400 (Requête incorrecte)
Durée de vie non conforme
La requête d’API inclut une valeur TTL non positive ou non numérique.
400 (Requête incorrecte)
Impossible d’analyser la requête.
Problème d’analyse du corps, par exemple des paramètres incorrects ou des valeurs non valides.
400 (Requête incorrecte)
Une fenêtre de maintenance avec les mêmes paramètres existe déjà.
S’affiche lorsqu’une fenêtre de maintenance existe déjà avec les mêmes détails.
404 (Introuvable)
ID de capteur inconnu
L’un des capteurs répertoriés dans la requête n’existe pas.
409 (Conflit)
L’ID de ticket dispose déjà d’une fenêtre ouverte.
L’ID de ticket est lié à une autre fenêtre de maintenance ouverte.
Récupérez un journal de toutes les actions open (POST), close (DELETE) et update (PUT) effectuées à l’aide de cette API pour gérer les fenêtres de maintenance. T
Filtre les journaux à partir de la date prédéfinie. Le format est YYYY-MM-DD.
2022-08-10
Facultatif
toDate
Filtre les journaux jusqu’à la date prédéfinie. Le format est YYYY-MM-DD.
2022-08-10
Facultatif
ticketId
Filtre les journaux liés à un ID de ticket spécifique.
9a5fe99c-d914-4bda-9332-307384fe40bf
Facultatif
tokenName
Filtre les journaux liés à un jeton spécifique.
quarterly-sanity-window
Facultatif
Codes d’erreur :
Code
Message
Description
200
Ok
L’action s’est effectuée correctement.
204 :
Pas de contenu
Aucune donnée à afficher.
400
Demande incorrecte
Le format de date est incorrect.
500
Erreur interne du serveur
Autre erreur inattendue.
Type : JSON
Tableau d’objets JSON qui représentent les opérations de fenêtre de maintenance.
Structure de réponse :
Nom
Type
Autorise la valeur Null/N’accepte pas la valeur Null
Liste de valeurs
id
Entier long
N'accepte pas la valeur null
ID interne du journal actuel
dateTime
String
N'accepte pas la valeur null
Heure à laquelle l’activité s’est produite, par exemple : 2022-04-23T18:25:43.511Z
ticketId
String
N'accepte pas la valeur null
L’ID de la fenêtre de maintenance. Par exemple : 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName
String
N'accepte pas la valeur null
Nom du jeton de fenêtre de maintenance. Par exemple : quarterly-sanity-window
engines
Tableau de chaînes
Nullable
Moteurs sur lesquels la fenêtre de maintenance s’applique, comme indiqué lors de la création de la fenêtre de maintenance : Protocol Violation, Policy Violation, Malware, Anomaly ou Operational
sensorIds
Tableau de chaînes
Nullable
Capteurs sur lesquels la fenêtre de maintenance s’applique, comme indiqué lors de la création de la fenêtre de maintenance.
Sous-réseaux
Tableau de chaînes
Nullable
Sous-réseaux sur lesquels la fenêtre de maintenance s’applique, comme indiqué lors de la création de la fenêtre de maintenance.
ttl
Numérique
Nullable
Durée de vie (TTL) de la fenêtre de maintenance, telle qu’elle est fournie lors de la création ou de la mise à jour de la fenêtre de maintenance.
operationType
String
N'accepte pas la valeur null
Peut prendre l’une des valeurs suivantes : OPEN, UPDATE et CLOSE
Permet la mise à jour de la durée de la fenêtre de maintenance après le démarrage du processus de maintenance en modifiant le paramètre ttl. La nouvelle définition de durée remplace l’ancienne.
Cette méthode est utile lorsque vous souhaitez définir une durée plus longue que la durée actuellement configurée. Par exemple, si vous avez défini à l’origine 180 minutes, que 90 minutes sont passées et que vous souhaitez ajouter 30 minutes supplémentaires, mettez à jour ttl à la 120 minute pour réinitialiser la durée.