ScheduledAlertRuleTemplate interface

Package:

@azure/arm-securityinsight

Represents scheduled alert rule template.

Extends

AlertRuleTemplate

Properties

alertDetailsOverride	The alert details override settings
alertRulesCreatedByTemplateCount	the number of alert rules that were created by this template
createdDateUTC	The time that this alert rule template has been added. NOTE: This property will not be serialized. It can only be populated by the server.
customDetails	Dictionary of string key-value pairs of columns to be attached to the alert
description	The description of the alert rule template.
displayName	The display name for alert rule template.
entityMappings	Array of the entity mappings of the alert rule
eventGroupingSettings	The event grouping settings.
kind	Polymorphic discriminator, which specifies the different types this object can be
lastUpdatedDateUTC	The time that this alert rule template was last updated. NOTE: This property will not be serialized. It can only be populated by the server.
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.
requiredDataConnectors	The required data connectors for this template
severity	The severity for alerts created by this alert rule.
status	The alert rule template status.
tactics	The tactics of the alert rule template
techniques	The techniques of the alert rule
triggerOperator	The operation against the threshold that triggers alert rule.
triggerThreshold	The threshold triggers this alert rule.
version	The version of this template - in format <a.b.c>, where all are numbers. For example <1.0.2>.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

alertDetailsOverride

The alert details override settings

alertDetailsOverride?: AlertDetailsOverride

Property Value

AlertDetailsOverride

alertRulesCreatedByTemplateCount

the number of alert rules that were created by this template

alertRulesCreatedByTemplateCount?: number

Property Value

number

createdDateUTC

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

createdDateUTC?: Date

Property Value

Date

customDetails

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

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

Property Value

{[propertyName: string]: string}

description

The description of the alert rule template.

description?: string

Property Value

string

displayName

The display name for alert rule template.

displayName?: string

Property Value

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

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "Scheduled"

Property Value

"Scheduled"

lastUpdatedDateUTC

The time that this alert rule template was last updated. NOTE: This property will not be serialized. It can only be populated by the server.

lastUpdatedDateUTC?: Date

Property Value

Date

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

requiredDataConnectors

The required data connectors for this template

requiredDataConnectors?: AlertRuleTemplateDataSource[]

Property Value

AlertRuleTemplateDataSource[]

severity

The severity for alerts created by this alert rule.

severity?: string

Property Value

string

status

The alert rule template status.

status?: string

Property Value

string

tactics

The tactics of the alert rule template

tactics?: string[]

Property Value

string[]

techniques

The techniques of the alert rule

techniques?: 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

version

The version of this template - in format <a.b.c>, where all are numbers. For example <1.0.2>.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From AlertRuleTemplate.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From AlertRuleTemplate.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From AlertRuleTemplate.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From AlertRuleTemplate.type