AlertInner Class

public final class AlertInner
extends ProxyResource

Security alert.

Method Summary

Modifier and Type Method and Description
String alertDisplayName()

Get the alertDisplayName property: The display name of the alert.

String alertType()

Get the alertType property: Unique identifier for the detection logic (all alert instances from the same detection logic will have the same alertType).

String alertUri()

Get the alertUri property: A direct link to the alert page in Azure Portal.

String compromisedEntity()

Get the compromisedEntity property: The display name of the resource most related to this alert.

String correlationKey()

Get the correlationKey property: Key for corelating related alerts.

String description()

Get the description property: Description of the suspicious activity that was detected.

OffsetDateTime endTimeUtc()

Get the endTimeUtc property: The UTC time of the last event or activity included in the alert in ISO8601 format.

List<AlertEntity> entities()

Get the entities property: A list of entities related to the alert.

List<Map<String,String>> extendedLinks()

Get the extendedLinks property: Links related to the alert.

Map<String,String> extendedProperties()

Get the extendedProperties property: Custom properties for the alert.

static AlertInner fromJson(JsonReader jsonReader)

Reads an instance of AlertInner from the JsonReader.

String id()

Get the id property: Fully qualified resource Id for the resource.

Intent intent()

Get the intent property: The kill chain related intent behind the alert.

Boolean isIncident()

Get the isIncident property: This field determines whether the alert is an incident (a compound grouping of several alerts) or a single alert.

String name()

Get the name property: The name of the resource.

OffsetDateTime processingEndTimeUtc()

Get the processingEndTimeUtc property: The UTC processing end time of the alert in ISO8601 format.

String productComponentName()

Get the productComponentName property: The name of Azure Security Center pricing tier which powering this alert.

String productName()

Get the productName property: The name of the product which published this alert (Microsoft Sentinel, Microsoft Defender for Identity, Microsoft Defender for Endpoint, Microsoft Defender for Office, Microsoft Defender for Cloud Apps, and so on).

List<String> remediationSteps()

Get the remediationSteps property: Manual action items to take to remediate the alert.

List<ResourceIdentifier> resourceIdentifiers()

Get the resourceIdentifiers property: The resource identifiers that can be used to direct the alert to the right product exposure group (tenant, workspace, subscription etc.).

AlertSeverity severity()

Get the severity property: The risk level of the threat that was detected.

OffsetDateTime startTimeUtc()

Get the startTimeUtc property: The UTC time of the first event or activity included in the alert in ISO8601 format.

AlertStatus status()

Get the status property: The life cycle status of the alert.

List<String> subTechniques()

Get the subTechniques property: Kill chain related sub-techniques behind the alert.

AlertPropertiesSupportingEvidence supportingEvidence()

Get the supportingEvidence property: Changing set of properties depending on the supportingEvidence type.

String systemAlertId()

Get the systemAlertId property: Unique identifier for the alert.

SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

List<String> techniques()

Get the techniques property: kill chain related techniques behind the alert.

OffsetDateTime timeGeneratedUtc()

Get the timeGeneratedUtc property: The UTC time the alert was generated in ISO8601 format.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

String vendorName()

Get the vendorName property: The name of the vendor that raises the alert.

String version()

Get the version property: Schema version.

Methods inherited from ProxyResource

Methods inherited from java.lang.Object

Method Details

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: Unique identifier for the detection logic (all alert instances from the same detection logic will have the same alertType).

Returns:

the alertType value.

alertUri

public String alertUri()

Get the alertUri property: A direct link to the alert page in Azure Portal.

Returns:

the alertUri value.

compromisedEntity

public String compromisedEntity()

Get the compromisedEntity property: The display name of the resource most related to this alert.

Returns:

the compromisedEntity value.

correlationKey

public String correlationKey()

Get the correlationKey property: Key for corelating related alerts. Alerts with the same correlation key considered to be related.

Returns:

the correlationKey value.

description

public String description()

Get the description property: Description of the suspicious activity that was detected.

Returns:

the description value.

endTimeUtc

public OffsetDateTime endTimeUtc()

Get the endTimeUtc property: The UTC time of the last event or activity included in the alert in ISO8601 format.

Returns:

the endTimeUtc value.

entities

public List<AlertEntity> entities()

Get the entities property: A list of entities related to the alert.

Returns:

the entities value.

extendedLinks

public List<Map<String,String>> extendedLinks()

Get the extendedLinks property: Links related to the alert.

Returns:

the extendedLinks value.

extendedProperties

public Map<String,String> extendedProperties()

Get the extendedProperties property: Custom properties for the alert.

Returns:

the extendedProperties value.

fromJson

public static AlertInner fromJson(JsonReader jsonReader)

Reads an instance of AlertInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AlertInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

AlertInner.id()

Returns:

the id value.

intent

public Intent intent()

Get the intent property: The kill chain related intent behind the alert. For list of supported values, and explanations of Azure Security Center's supported kill chain intents.

Returns:

the intent value.

isIncident

public Boolean isIncident()

Get the isIncident property: This field determines whether the alert is an incident (a compound grouping of several alerts) or a single alert.

Returns:

the isIncident value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

AlertInner.name()

Returns:

the name value.

processingEndTimeUtc

public OffsetDateTime processingEndTimeUtc()

Get the processingEndTimeUtc property: The UTC processing end time of the alert in ISO8601 format.

Returns:

the processingEndTimeUtc value.

productComponentName

public String productComponentName()

Get the productComponentName property: The name of Azure Security Center pricing tier which powering this alert. Learn more: https://docs.microsoft.com/en-us/azure/security-center/security-center-pricing.

Returns:

the productComponentName value.

productName

public String productName()

Get the productName property: The name of the product which published this alert (Microsoft Sentinel, Microsoft Defender for Identity, Microsoft Defender for Endpoint, Microsoft Defender for Office, Microsoft Defender for Cloud Apps, and so on).

Returns:

the productName value.

remediationSteps

public List<String> remediationSteps()

Get the remediationSteps property: Manual action items to take to remediate the alert.

Returns:

the remediationSteps value.

resourceIdentifiers

public List<ResourceIdentifier> resourceIdentifiers()

Get the resourceIdentifiers property: The resource identifiers that can be used to direct the alert to the right product exposure group (tenant, workspace, subscription etc.). There can be multiple identifiers of different type per alert.

Returns:

the resourceIdentifiers value.

severity

public AlertSeverity severity()

Get the severity property: The risk level of the threat that was detected. Learn more: https://docs.microsoft.com/en-us/azure/security-center/security-center-alerts-overview\#how-are-alerts-classified.

Returns:

the severity value.

startTimeUtc

public OffsetDateTime startTimeUtc()

Get the startTimeUtc property: The UTC time of the first event or activity included in the alert in ISO8601 format.

Returns:

the startTimeUtc value.

status

public AlertStatus status()

Get the status property: The life cycle status of the alert.

Returns:

the status value.

subTechniques

public List<String> subTechniques()

Get the subTechniques property: Kill chain related sub-techniques behind the alert.

Returns:

the subTechniques value.

supportingEvidence

public AlertPropertiesSupportingEvidence supportingEvidence()

Get the supportingEvidence property: Changing set of properties depending on the supportingEvidence type.

Returns:

the supportingEvidence value.

systemAlertId

public String systemAlertId()

Get the systemAlertId property: Unique identifier for the alert.

Returns:

the systemAlertId value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

techniques

public List<String> techniques()

Get the techniques property: kill chain related techniques behind the alert.

Returns:

the techniques value.

timeGeneratedUtc

public OffsetDateTime timeGeneratedUtc()

Get the timeGeneratedUtc property: The UTC time the alert was generated in ISO8601 format.

Returns:

the timeGeneratedUtc value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AlertInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

AlertInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

vendorName

public String vendorName()

Get the vendorName property: The name of the vendor that raises the alert.

Returns:

the vendorName value.

version

public String version()

Get the version property: Schema version.

Returns:

the version value.

Applies to