你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

QueryBasedAlertRuleProperties Class

Definition

Query based alert rule base property bag.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.QueryBasedAlertRulePropertiesTypeConverter))]
public class QueryBasedAlertRuleProperties : Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IQueryBasedAlertRuleProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.QueryBasedAlertRulePropertiesTypeConverter))>]
type QueryBasedAlertRuleProperties = class
    interface IQueryBasedAlertRuleProperties
    interface IJsonSerializable
Public Class QueryBasedAlertRuleProperties
Implements IQueryBasedAlertRuleProperties
Inheritance
QueryBasedAlertRuleProperties
Attributes
Implements

Constructors

QueryBasedAlertRuleProperties()

Creates an new QueryBasedAlertRuleProperties 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

AlertRuleTemplateName

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

CustomDetail

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

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.

EntityMapping

Array of the entity mappings of the alert rule

GroupingConfigurationEnabled

Grouping enabled

GroupingConfigurationGroupByAlertDetail

A list of alert details to group by (when matchingMethod is Selected)

GroupingConfigurationGroupByCustomDetail

A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.

GroupingConfigurationGroupByEntity

A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.

GroupingConfigurationLookbackDuration

Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)

GroupingConfigurationMatchingMethod

Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.

GroupingConfigurationReopenClosedIncident

Re-open closed matching incidents

IncidentConfigurationCreateIncident

Create incidents from alerts triggered by this analytics rule

LastModifiedUtc

The last time that this alert rule has been modified.

Query

The query that creates alerts for this rule.

Severity

The severity for alerts created by this alert rule.

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.

Tactic

The tactics of the alert rule

TemplateVersion

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of QueryBasedAlertRuleProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of QueryBasedAlertRuleProperties.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of QueryBasedAlertRuleProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to