Package com.azure.resourcemanager.securityinsights.models

Class SecurityAlert

  • public final class SecurityAlert
extends EntityInner
    Represents a security alert entity.

    • Constructor Detail

      • SecurityAlert

        public SecurityAlert()

    • Method Detail

      • alertDisplayName

        public String alertDisplayName()
        Get the alertDisplayName property: The display name of the alert.
        Returns:
        the alertDisplayName value.

      • alertType

        public String alertType()
        Get the alertType property: The type name of the alert.
        Returns:
        the alertType value.

      • compromisedEntity

        public String compromisedEntity()
        Get the compromisedEntity property: Display name of the main entity being reported on.
        Returns:
        the compromisedEntity value.

      • confidenceLevel

        public ConfidenceLevel confidenceLevel()
        Get the confidenceLevel property: The confidence level of this alert.
        Returns:
        the confidenceLevel value.

      • confidenceScore

        public Double confidenceScore()
        Get the confidenceScore property: The confidence score of the alert.
        Returns:
        the confidenceScore value.

      • confidenceScoreStatus

        public ConfidenceScoreStatus confidenceScoreStatus()
        Get the confidenceScoreStatus property: The confidence score calculation status, i.e. indicating if score calculation is pending for this alert, not applicable or final.
        Returns:
        the confidenceScoreStatus value.

      • description

        public String description()
        Get the description property: Alert description.
        Returns:
        the description value.

      • endTimeUtc

        public OffsetDateTime endTimeUtc()
        Get the endTimeUtc property: The impact end time of the alert (the time of the last event contributing to the alert).
        Returns:
        the endTimeUtc value.

      • intent

        public KillChainIntent intent()
        Get the intent property: Holds the alert intent stage(s) mapping for this alert.
        Returns:
        the intent value.

      • providerAlertId

        public String providerAlertId()
        Get the providerAlertId property: The identifier of the alert inside the product which generated the alert.
        Returns:
        the providerAlertId value.

      • processingEndTime

        public OffsetDateTime processingEndTime()
        Get the processingEndTime property: The time the alert was made available for consumption.
        Returns:
        the processingEndTime value.

      • productComponentName

        public String productComponentName()
        Get the productComponentName property: The name of a component inside the product which generated the alert.
        Returns:
        the productComponentName value.

      • productName

        public String productName()
        Get the productName property: The name of the product which published this alert.
        Returns:
        the productName value.

      • productVersion

        public String productVersion()
        Get the productVersion property: The version of the product generating the alert.
        Returns:
        the productVersion value.

      • remediationSteps

        public List<String> remediationSteps()
        Get the remediationSteps property: Manual action items to take to remediate the alert.
        Returns:
        the remediationSteps value.

      • severity

        public AlertSeverity severity()
        Get the severity property: The severity of the alert.
        Returns:
        the severity value.

      • withSeverity

        public SecurityAlert withSeverity​(AlertSeverity severity)
        Set the severity property: The severity of the alert.
        Parameters:
        severity - the severity value to set.
        Returns:
        the SecurityAlert object itself.

      • startTimeUtc

        public OffsetDateTime startTimeUtc()
        Get the startTimeUtc property: The impact start time of the alert (the time of the first event contributing to the alert).
        Returns:
        the startTimeUtc value.

      • status

        public AlertStatus status()
        Get the status property: The lifecycle status of the alert.
        Returns:
        the status value.

      • systemAlertId

        public String systemAlertId()
        Get the systemAlertId property: Holds the product identifier of the alert for the product.
        Returns:
        the systemAlertId value.

      • tactics

        public List<AttackTactic> tactics()
        Get the tactics property: The tactics of the alert.
        Returns:
        the tactics value.

      • timeGenerated

        public OffsetDateTime timeGenerated()
        Get the timeGenerated property: The time the alert was generated.
        Returns:
        the timeGenerated value.

      • vendorName

        public String vendorName()
        Get the vendorName property: The name of the vendor that raise the alert.
        Returns:
        the vendorName value.

      • alertLink

        public String alertLink()
        Get the alertLink property: The uri link of the alert.
        Returns:
        the alertLink value.

      • resourceIdentifiers

        public List<Object> resourceIdentifiers()
        Get the resourceIdentifiers property: The list of resource identifiers of the alert.
        Returns:
        the resourceIdentifiers value.

      • additionalData

        public Map<String,​Object> additionalData()
        Get the additionalData property: A bag of custom fields that should be part of the entity and will be presented to the user.
        Returns:
        the additionalData value.

      • friendlyName

        public String friendlyName()
        Get the friendlyName property: The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.
        Returns:
        the friendlyName value.