ScheduledAlertRuleTemplate Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents scheduled alert rule template.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ScheduledAlertRuleTemplateTypeConverter))]
public class ScheduledAlertRuleTemplate : Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IScheduledAlertRuleTemplate, Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ScheduledAlertRuleTemplateTypeConverter))>]
type ScheduledAlertRuleTemplate = class
interface IScheduledAlertRuleTemplate
interface IJsonSerializable
interface IAlertRuleTemplate
interface IResource
interface IValidates
Public Class ScheduledAlertRuleTemplate
Implements IScheduledAlertRuleTemplate, IValidates
- Inheritance
-
ScheduledAlertRuleTemplate
- Attributes
- Implements
Constructors
ScheduledAlertRuleTemplate() |
Creates an new ScheduledAlertRuleTemplate 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 |
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 |
EventGroupingSettingAggregationKind |
The event grouping aggregation kinds |
Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
Kind |
The kind of the alert rule |
LastUpdatedDateUtc |
The last time that this alert rule template has been updated. |
Name |
The name of the resource |
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. |
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 |
TriggerOperator |
The operation against the threshold that triggers alert rule. |
TriggerThreshold |
The threshold triggers this alert rule. |
Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Version |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of ScheduledAlertRuleTemplate. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of ScheduledAlertRuleTemplate. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IScheduledAlertRuleTemplate. |
FromJsonString(String) |
Creates a new instance of ScheduledAlertRuleTemplate, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of ScheduledAlertRuleTemplate into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |