ScheduledAlertRuleCommonProperties interface

Package:

@azure/arm-securityinsight

Scheduled alert rule template property bag.

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

alertDetailsOverride

The alert details override settings

alertDetailsOverride?: AlertDetailsOverride

Property Value

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}

entityMappings

Array of the entity mappings of the alert rule

entityMappings?: EntityMapping[]

Property Value

EntityMapping[]

eventGroupingSettings

The event grouping settings.

eventGroupingSettings?: EventGroupingSettings

Property Value

EventGroupingSettings

query

The query that creates alerts for this rule.

query?: string

Property Value

string

queryFrequency

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

queryFrequency?: string

Property Value

string

queryPeriod

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

queryPeriod?: string

Property Value

string

severity

The severity for alerts created by this alert rule.

severity?: string

Property Value

string

triggerOperator

The operation against the threshold that triggers alert rule.

triggerOperator?: TriggerOperator

Property Value

TriggerOperator

triggerThreshold

The threshold triggers this alert rule.

triggerThreshold?: number

Property Value

number