ScheduledAlertRuleCommonProperties interface
Scheduled alert rule template property bag.
Properties
| alert |
The alert details override settings |
| custom |
Dictionary of string key-value pairs of columns to be attached to the alert |
| entity |
Array of the entity mappings of the alert rule |
| event |
The event grouping settings. |
| query | The query that creates alerts for this rule. |
| query |
The frequency (in ISO 8601 duration format) for this alert rule to run. |
| query |
The period (in ISO 8601 duration format) that this alert rule looks at. |
| sentinel |
Array of the sentinel entity mappings of the alert rule |
| severity | The severity for alerts created by this alert rule. |
| trigger |
The operation against the threshold that triggers alert rule. |
| trigger |
The threshold triggers this alert rule. |
Property Details
alertDetailsOverride
The alert details override settings
alertDetailsOverride?: AlertDetailsOverrideProperty Value
customDetails
Dictionary of string key-value pairs of columns to be attached to the alert
customDetails?: Record<string, string>Property Value
Record<string, string>
entityMappings
Array of the entity mappings of the alert rule
entityMappings?: EntityMapping[]Property Value
eventGroupingSettings
The event grouping settings.
eventGroupingSettings?: EventGroupingSettingsProperty Value
query
The query that creates alerts for this rule.
query?: stringProperty Value
string
queryFrequency
The frequency (in ISO 8601 duration format) for this alert rule to run.
queryFrequency?: stringProperty Value
string
queryPeriod
The period (in ISO 8601 duration format) that this alert rule looks at.
queryPeriod?: stringProperty Value
string
sentinelEntitiesMappings
Array of the sentinel entity mappings of the alert rule
sentinelEntitiesMappings?: SentinelEntityMapping[]Property Value
severity
The severity for alerts created by this alert rule.
severity?: stringProperty Value
string
triggerOperator
The operation against the threshold that triggers alert rule.
triggerOperator?: TriggerOperatorProperty Value
triggerThreshold
The threshold triggers this alert rule.
triggerThreshold?: numberProperty Value
number
