Share via


SecurityInsightsAlert Class

Definition

Represents a security alert entity.

public class SecurityInsightsAlert : Azure.ResourceManager.SecurityInsights.Models.SecurityInsightsEntity
public class SecurityInsightsAlert : Azure.ResourceManager.SecurityInsights.Models.SecurityInsightsEntity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.SecurityInsights.Models.SecurityInsightsAlert>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.SecurityInsights.Models.SecurityInsightsAlert>
type SecurityInsightsAlert = class
    inherit SecurityInsightsEntity
type SecurityInsightsAlert = class
    inherit SecurityInsightsEntity
    interface IJsonModel<SecurityInsightsAlert>
    interface IPersistableModel<SecurityInsightsAlert>
Public Class SecurityInsightsAlert
Inherits SecurityInsightsEntity
Public Class SecurityInsightsAlert
Inherits SecurityInsightsEntity
Implements IJsonModel(Of SecurityInsightsAlert), IPersistableModel(Of SecurityInsightsAlert)
Inheritance
Implements

Constructors

SecurityInsightsAlert()

Initializes a new instance of SecurityInsightsAlert.

Properties

AdditionalData

A bag of custom fields that should be part of the entity and will be presented to the user.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

AlertDisplayName

The display name of the alert.

AlertGeneratedOn

The time the alert was generated.

AlertLink

The uri link of the alert.

AlertType

The type name of the alert.

CompromisedEntity

Display name of the main entity being reported on.

ConfidenceLevel

The confidence level of this alert.

ConfidenceReasons

The confidence reasons.

ConfidenceScore

The confidence score of the alert.

ConfidenceScoreStatus

The confidence score calculation status, i.e. indicating if score calculation is pending for this alert, not applicable or final.

Description

Alert description.

EndOn

The impact end time of the alert (the time of the last event contributing to the alert).

FriendlyName

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.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Intent

Holds the alert intent stage(s) mapping for this alert.

Name

The name of the resource.

(Inherited from ResourceData)
ProcessingEndOn

The time the alert was made available for consumption.

ProductComponentName

The name of a component inside the product which generated the alert.

ProductName

The name of the product which published this alert.

ProductVersion

The version of the product generating the alert.

ProviderAlertId

The identifier of the alert inside the product which generated the alert.

RemediationSteps

Manual action items to take to remediate the alert.

ResourceIdentifiers

The list of resource identifiers of the alert.

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
Severity

The severity of the alert.

StartOn

The impact start time of the alert (the time of the first event contributing to the alert).

Status

The lifecycle status of the alert.

SystemAlertId

Holds the product identifier of the alert for the product.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tactics

The tactics of the alert.

VendorName

The name of the vendor that raise the alert.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<SecurityInsightsAlert>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SecurityInsightsAlert>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<SecurityInsightsEntity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from SecurityInsightsEntity)
IJsonModel<SecurityInsightsEntity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from SecurityInsightsEntity)
IPersistableModel<SecurityInsightsAlert>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SecurityInsightsAlert>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SecurityInsightsAlert>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<SecurityInsightsEntity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from SecurityInsightsEntity)
IPersistableModel<SecurityInsightsEntity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from SecurityInsightsEntity)
IPersistableModel<SecurityInsightsEntity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from SecurityInsightsEntity)

Applies to