Share via


ScheduledAlertRuleTemplateProperties Class

Definition

Scheduled alert rule template properties

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ScheduledAlertRuleTemplatePropertiesTypeConverter))]
public class ScheduledAlertRuleTemplateProperties : Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IScheduledAlertRuleTemplateProperties, Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ScheduledAlertRuleTemplatePropertiesTypeConverter))>]
type ScheduledAlertRuleTemplateProperties = class
    interface IScheduledAlertRuleTemplateProperties
    interface IJsonSerializable
    interface IAlertRuleTemplatePropertiesBase
    interface IQueryBasedAlertRuleTemplateProperties
    interface IScheduledAlertRuleCommonProperties
    interface IValidates
Public Class ScheduledAlertRuleTemplateProperties
Implements IScheduledAlertRuleTemplateProperties, IValidates
Inheritance
ScheduledAlertRuleTemplateProperties
Attributes
Implements

Constructors

ScheduledAlertRuleTemplateProperties()

Creates an new ScheduledAlertRuleTemplateProperties instance.

Properties

AlertDetailOverrideAlertDescriptionFormat

the format containing columns name(s) to override the alert description

AlertDetailOverrideAlertDisplayNameFormat

the format containing columns name(s) to override the alert name

AlertDetailOverrideAlertSeverityColumnName

the column name to take the alert severity from

AlertDetailOverrideAlertTacticsColumnName

the column name to take the alert tactics from

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.

CustomDetail

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.

EntityMapping

Array of the entity mappings of the alert rule

EventGroupingSetting

The event grouping settings.

EventGroupingSettingAggregationKind

The event grouping aggregation kinds

LastUpdatedDateUtc

The last time that this alert rule template has been updated.

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.

RequiredDataConnector

The required data sources for this template

Severity

The severity for alerts created by this alert rule.

Status

The alert rule template status.

Tactic

The tactics of the alert rule

TriggerOperator

The operation against the threshold that triggers alert rule.

TriggerThreshold

The threshold triggers this alert rule.

Version

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ScheduledAlertRuleTemplateProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ScheduledAlertRuleTemplateProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IScheduledAlertRuleTemplateProperties.

FromJsonString(String)

Creates a new instance of ScheduledAlertRuleTemplateProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of ScheduledAlertRuleTemplateProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to