SecurityAlert Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview

Assembly:: Az.SecurityInsights.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a security alert entity.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.SecurityAlertTypeConverter))]
public class SecurityAlert : Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ISecurityAlert, Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.SecurityAlertTypeConverter))>]
type SecurityAlert = class
    interface ISecurityAlert
    interface IJsonSerializable
    interface IEntity
    interface IResource
    interface IValidates

Public Class SecurityAlert
Implements ISecurityAlert, IValidates

Inheritance: Object
SecurityAlert

Attributes: TypeConverterAttribute

Implements: IEntity ISecurityAlert IResource IJsonSerializable IValidates

Constructors

SecurityAlert()

Creates an new SecurityAlert instance.

Properties

AdditionalData	A bag of custom fields that should be part of the entity and will be presented to the user.
AlertDisplayName	The display name of the alert.
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.
ConfidenceReason	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.
EndTimeUtc	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}
Intent	Holds the alert intent stage(s) mapping for this alert.
Kind	The kind of the entity.
Name	The name of the resource
ProcessingEndTime	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.
RemediationStep	Manual action items to take to remediate the alert.
ResourceIdentifier	The list of resource identifiers of the alert.
Severity	The severity of the alert
StartTimeUtc	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.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tactic	The tactics of the alert
TimeGenerated	The time the alert was generated.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VendorName	The name of the vendor that raise the alert.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of SecurityAlert.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of SecurityAlert.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ISecurityAlert.
FromJsonString(String)	Creates a new instance of SecurityAlert, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of SecurityAlert into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to

Share via