ScheduledAlertRuleProperties interface

Package:

@azure/arm-securityinsight

Scheduled alert rule base property bag.

Extends

ScheduledAlertRuleCommonProperties

Properties

alertRuleTemplateName	The Name of the alert rule template used to create this rule.
description	The description of the alert rule.
displayName	The display name for alerts created by this alert rule.
enabled	Determines whether this alert rule is enabled or disabled.
incidentConfiguration	The settings of the incidents that created from alerts triggered by this analytics rule
lastModifiedUtc	The last time that this alert rule has been modified. NOTE: This property will not be serialized. It can only be populated by the server.
suppressionDuration	The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
suppressionEnabled	Determines whether the suppression for this alert rule is enabled or disabled.
tactics	The tactics of the alert rule
techniques	The techniques of the alert rule
templateVersion	The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>

Inherited Properties

alertDetailsOverride	The alert details override settings
customDetails	Dictionary of string key-value pairs of columns to be attached to the alert
entityMappings	Array of the entity mappings of the alert rule
eventGroupingSettings	The event grouping settings.
query	The query that creates alerts for this rule.
queryFrequency	The frequency (in ISO 8601 duration format) for this alert rule to run.
queryPeriod	The period (in ISO 8601 duration format) that this alert rule looks at.
severity	The severity for alerts created by this alert rule.
triggerOperator	The operation against the threshold that triggers alert rule.
triggerThreshold	The threshold triggers this alert rule.

Property Details

alertRuleTemplateName

The Name of the alert rule template used to create this rule.

alertRuleTemplateName?: string

Property Value

string

description

The description of the alert rule.

description?: string

Property Value

string

displayName

The display name for alerts created by this alert rule.

displayName: string

Property Value

string

enabled

Determines whether this alert rule is enabled or disabled.

enabled: boolean

Property Value

boolean

incidentConfiguration

The settings of the incidents that created from alerts triggered by this analytics rule

incidentConfiguration?: IncidentConfiguration

Property Value

IncidentConfiguration

lastModifiedUtc

The last time that this alert rule has been modified. NOTE: This property will not be serialized. It can only be populated by the server.

lastModifiedUtc?: Date

Property Value

Date

suppressionDuration

The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.

suppressionDuration: string

Property Value

string

suppressionEnabled

Determines whether the suppression for this alert rule is enabled or disabled.

suppressionEnabled: boolean

Property Value

boolean

tactics

The tactics of the alert rule

tactics?: string[]

Property Value

string[]

techniques

The techniques of the alert rule

techniques?: string[]

Property Value

string[]

templateVersion

The version of the alert rule template used to create this rule - in format <a.b.c>, where all are numbers, for example 0 <1.0.2>

templateVersion?: string

Property Value

string

Inherited Property Details

alertDetailsOverride

The alert details override settings

alertDetailsOverride?: AlertDetailsOverride

Property Value

AlertDetailsOverride

Inherited From ScheduledAlertRuleCommonProperties.alertDetailsOverride

customDetails

Dictionary of string key-value pairs of columns to be attached to the alert

customDetails?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From ScheduledAlertRuleCommonProperties.customDetails

entityMappings

Array of the entity mappings of the alert rule

entityMappings?: EntityMapping[]

Property Value

EntityMapping[]

Inherited From ScheduledAlertRuleCommonProperties.entityMappings

eventGroupingSettings

The event grouping settings.

eventGroupingSettings?: EventGroupingSettings

Property Value

EventGroupingSettings

Inherited From ScheduledAlertRuleCommonProperties.eventGroupingSettings

query

The query that creates alerts for this rule.

query?: string

Property Value

string

Inherited From ScheduledAlertRuleCommonProperties.query

queryFrequency

The frequency (in ISO 8601 duration format) for this alert rule to run.

queryFrequency?: string

Property Value

string

Inherited From ScheduledAlertRuleCommonProperties.queryFrequency

queryPeriod

The period (in ISO 8601 duration format) that this alert rule looks at.

queryPeriod?: string

Property Value

string

Inherited From ScheduledAlertRuleCommonProperties.queryPeriod

severity

The severity for alerts created by this alert rule.

severity?: string

Property Value

string

Inherited From ScheduledAlertRuleCommonProperties.severity

triggerOperator

The operation against the threshold that triggers alert rule.

triggerOperator?: TriggerOperator

Property Value

TriggerOperator

Inherited From ScheduledAlertRuleCommonProperties.triggerOperator

triggerThreshold

The threshold triggers this alert rule.

triggerThreshold?: number

Property Value

number

Inherited From ScheduledAlertRuleCommonProperties.triggerThreshold