UUID (Waarschuwingen beheren op basis van de UUID)
Gebruik deze API om de opgegeven actie uit te voeren voor een specifieke waarschuwing die is gedetecteerd door Defender for IoT.
U kunt deze API bijvoorbeeld gebruiken om een doorstuurregel te maken waarmee gegevens worden doorgestuurd naar QRadar. Zie Qradar integreren met Microsoft Defender for IoTvoor meer informatie.
Matrix van JSON-objecten die apparaten vertegenwoordigen.
antwoordvelden:
Naam
Type
Vereist/optioneel
Beschrijving
inhoud/fout
Snaar
Vereist
Als de aanvraag is geslaagd, wordt de inhoudseigenschap weergegeven. Anders wordt de fouteigenschap weergegeven.
Mogelijke inhoudswaarden:
Statuscode
Bericht
Beschrijving
200
De aanvraag voor het bijwerken van waarschuwingen is voltooid.
De updateaanvraag is voltooid. Geen opmerkingen.
200
Waarschuwing is al verwerkt (handle).
De waarschuwing is al verwerkt toen een handleaanvraag voor de waarschuwing werd ontvangen. De waarschuwing blijft afgehandeld.
200
Waarschuwing is al verwerkt en geleerd (handleAndLearn).
De waarschuwing is al verwerkt en geleerd wanneer een aanvraag voor handleAndLearn- is ontvangen. De waarschuwing blijft in de verwerktAndLearn status.
200
Waarschuwing is al verwerkt (verwerkt). Handle and learn (handleAndLearn) is uitgevoerd op de waarschuwing.
De waarschuwing is al verwerkt toen een aanvraag voor handleAndLearn- werd ontvangen. De waarschuwing wordt handleAndLearn.
200
Waarschuwing is al verwerkt en geleerd (handleAndLearn). Aanvraag voor verwerking genegeerd.
De waarschuwing is al handleAndLearn toen een aanvraag voor het afhandelen van de waarschuwing werd ontvangen. De waarschuwing blijft handleAndLearn.
500
Ongeldige actie.
De verzonden actie is geen geldige actie die moet worden uitgevoerd voor de waarschuwing.
500
Er is een onverwachte fout opgetreden.
Er is een onverwachte fout opgetreden. Neem contact op met de technische ondersteuning om het probleem op te lossen.
500
Kan aanvraag niet uitvoeren omdat er geen waarschuwing is gevonden voor deze UUID.
De opgegeven waarschuwings-UUID is niet gevonden in het systeem.
Beheert onderhoudsvensters, waaronder waarschuwingen niet worden verzonden. Gebruik deze API om stop- en begintijden, apparaten of subnetten te definiëren en bij te werken die moeten worden uitgesloten bij het activeren van waarschuwingen of om Defender voor IoT-engines te definiëren en bij te werken die moeten worden uitgesloten.
Bijvoorbeeld, tijdens een onderhoudsvenster wilt u de bezorging van waarschuwingen van alle waarschuwingen stoppen, met uitzondering van malwarewaarschuwingen op kritieke apparaten.
De onderhoudsvensters die worden gedefinieerd met de maintenanceWindow-API worden weergegeven in het venster Waarschuwingsuitsluitingen van de on-premises beheerconsole als een regel voor alleen-lezen uitsluiting, met de volgende syntaxis: Maintenance-{token name}-{ticket ID}.
Belangrijk
Deze API wordt alleen ondersteund voor onderhoudsdoeleinden en voor een beperkte periode, en is niet bedoeld om te worden gebruikt in plaats van waarschuwingsuitsluitingsregels. Gebruik deze API alleen voor eenmalige, tijdelijke onderhoudsbewerkingen.
Snaar. Definieert de onderhoudsticket-id in de systemen van de gebruiker. Zorg ervoor dat de ticket-id niet is gekoppeld aan een bestaand geopend venster.
2987345p98234
Vereist
ttl-
Positief geheel getal. Definieert de TTL (time to live), de duur van het onderhoudsvenster, in minuten. Nadat de gedefinieerde periode is voltooid, is het onderhoudsvenster voorbij en gedraagt het systeem zich weer normaal.
180
Vereist
engines
JSON-matrix met tekenreeksen. Hiermee definieert u welke engine waarschuwingen moet onderdrukken tijdens het onderhoudsvenster. Mogelijke waarden:
JSON-matrix met tekenreeksen. Hiermee definieert u welke sensoren waarschuwingen moeten onderdrukken tijdens het onderhoudsvenster. U kunt deze sensor-id's ophalen uit de -apparaten (OT-sensorapparaten beheren) API.
1,35,63
Facultatief
subnetten
JSON-matrix met tekenreeksen. Hiermee definieert u de subnetten voor het onderdrukken van waarschuwingen tijdens het onderhoudsvenster. Definieer elk subnet in een CIDR-notatie.
192.168.0.0/16,138.136.80.0/14,112.138.10.0/8
Facultatief
Statuscode
Bericht
Beschrijving
201 (gemaakt)
-
De actie is voltooid.
400 (ongeldige aanvraag)
Geen TicketId
Er ontbreekt een api-aanvraag ticketId waarde.
400 (ongeldige aanvraag)
Ongeldige TTL
API-aanvraag bevat een niet-positieve of niet-numerieke TTL-waarde.
400 (ongeldige aanvraag)
Kan aanvraag niet parseren.
Probleem bij het parseren van de hoofdtekst, zoals onjuiste parameters of ongeldige waarden.
400 (ongeldige aanvraag)
Het onderhoudsvenster met dezelfde parameters bestaat al.
Wordt weergegeven wanneer er al een bestaand onderhoudsvenster bestaat met dezelfde details.
404 (niet gevonden)
Onbekende sensor-id
Een van de sensoren die in de aanvraag worden vermeld, bestaat niet.
409 (conflict)
Ticket-id heeft al een geopend venster.
De ticket-id is gekoppeld aan een ander geopend onderhoudsvenster.
Haal een logboek op van alle open (POST), sluiten (DELETE-) en (PUT-) acties die met deze API zijn uitgevoerd voor het verwerken van onderhoudsvensters. T
Hiermee filtert u de logboeken van de vooraf gedefinieerde datum en later. De indeling is YYYY-MM-DD.
2022-08-10
Facultatief
toDate-
Hiermee filtert u de logboeken tot de vooraf gedefinieerde datum. De indeling is YYYY-MM-DD.
2022-08-10
Facultatief
ticketId
Hiermee filtert u de logboeken met betrekking tot een specifieke ticket-id.
9a5fe99c-d914-4bda-9332-307384fe40bf
Facultatief
tokenName
Hiermee filtert u de logboeken met betrekking tot een specifieke tokennaam.
kwartaal-sanity-venster
Facultatief
foutcodes:
Code
Bericht
Beschrijving
200
OK
De actie is voltooid.
204:
Geen inhoud
Er zijn geen gegevens om weer te geven.
400
Ongeldige aanvraag
De datumnotatie is onjuist.
500
Interne serverfout
Een andere onverwachte fout.
Type: JSON
Matrix van JSON-objecten die onderhoudsvensterbewerkingen vertegenwoordigen.
antwoordstructuur:
Naam
Type
Nullable/Not nullable
Lijst met waarden
id
Lang geheel getal
Niet nullable
Een interne id voor het huidige logboek
dateTime-
Snaar
Niet nullable
De tijd waarop de activiteit heeft plaatsgevonden, bijvoorbeeld: 2022-04-23T18:25:43.511Z
ticketId
Snaar
Niet nullable
De id van het onderhoudsvenster. Bijvoorbeeld: 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName
Snaar
Niet nullable
De naam van het onderhoudsvenstertoken. Bijvoorbeeld: quarterly-sanity-window
engines
Matrix van tekenreeksen
Null-waarde
De motoren waarop het onderhoudsvenster van toepassing is, zoals opgegeven tijdens het maken van het onderhoudsvenster: Protocol Violation, Policy Violation, Malware, Anomalyof Operational
sensorIds
Matrix van tekenreeks
Null-waarde
De sensoren waarop het onderhoudsvenster van toepassing is, zoals opgegeven tijdens het maken van het onderhoudsvenster.
subnetten
Matrix van tekenreeks
Null-waarde
De subnetten waarop het onderhoudsvenster van toepassing is, zoals opgegeven tijdens het maken van het onderhoudsvenster.
ttl-
Numeriek
Null-waarde
De TTL (Time to Live) van het onderhoudsvenster, zoals opgegeven tijdens het maken of bijwerken van het onderhoudsvenster.
Hiermee kunt u de duur van het onderhoudsvenster bijwerken nadat u het onderhoudsproces hebt gestart door de parameter ttl te wijzigen. De nieuwe duurdefinitie overschrijft de vorige definitie.
Deze methode is handig als u een langere duur wilt instellen dan de momenteel geconfigureerde duur. Als u bijvoorbeeld 180 minuten hebt gedefinieerd, 90 minuten zijn verstreken en u nog eens 30 minuten wilt toevoegen, werkt u de ttl bij naar 120 minuut om het aantal duur opnieuw in te stellen.