NrtAlertRule Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview

Assembly:

Az.SecurityInsights.private.dll

Represents NRT alert rule.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.NrtAlertRuleTypeConverter))]
public class NrtAlertRule : Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.INrtAlertRule, Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.NrtAlertRuleTypeConverter))>]
type NrtAlertRule = class
    interface INrtAlertRule
    interface IJsonSerializable
    interface IAlertRule
    interface IResourceWithEtag
    interface IResource
    interface IValidates

Public Class NrtAlertRule
Implements INrtAlertRule, IValidates

Inheritance

Object

NrtAlertRule

Attributes

TypeConverterAttribute

Implements

IResourceWithEtag IAlertRule INrtAlertRule IResource IJsonSerializable IValidates

Constructors

NrtAlertRule()

Creates an new NrtAlertRule 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
Etag	Etag of the azure resource
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
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IncidentConfigurationCreateIncident	Create incidents from alerts triggered by this analytics rule
Kind	The kind of the alert rule
LastModifiedUtc	The last time that this alert rule has been modified.
Name	The name of the resource
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.
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tactic	The tactics of the alert rule
TemplateVersion
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of NrtAlertRule.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of NrtAlertRule.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.INrtAlertRule.
FromJsonString(String)	Creates a new instance of NrtAlertRule, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of NrtAlertRule into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
Validate(IEventListener)	Validates that this object meets the validation criteria.