ScheduledAlertRuleTemplate interface
Represents scheduled alert rule template.
- Extends
Properties
| alert |
The alert details override settings |
| alert |
the number of alert rules that were created by this template |
| created |
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. |
| custom |
Dictionary of string key-value pairs of columns to be attached to the alert |
| description | The description of the alert rule template. |
| display |
The display name for alert rule template. |
| entity |
Array of the entity mappings of the alert rule |
| event |
The event grouping settings. |
| kind | Polymorphic discriminator, which specifies the different types this object can be |
| last |
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. |
| query |
The frequency (in ISO 8601 duration format) for this alert rule to run. |
| query |
The period (in ISO 8601 duration format) that this alert rule looks at. |
| required |
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 |
| trigger |
The operation against the threshold that triggers alert rule. |
| trigger |
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. |
| system |
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?: AlertDetailsOverrideProperty Value
alertRulesCreatedByTemplateCount
the number of alert rules that were created by this template
alertRulesCreatedByTemplateCount?: numberProperty 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?: DateProperty 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?: stringProperty Value
string
displayName
The display name for alert rule template.
displayName?: stringProperty Value
string
entityMappings
Array of the entity mappings of the alert rule
entityMappings?: EntityMapping[]Property Value
eventGroupingSettings
The event grouping settings.
eventGroupingSettings?: EventGroupingSettingsProperty Value
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?: DateProperty Value
Date
query
The query that creates alerts for this rule.
query?: stringProperty Value
string
queryFrequency
The frequency (in ISO 8601 duration format) for this alert rule to run.
queryFrequency?: stringProperty Value
string
queryPeriod
The period (in ISO 8601 duration format) that this alert rule looks at.
queryPeriod?: stringProperty Value
string
requiredDataConnectors
The required data connectors for this template
requiredDataConnectors?: AlertRuleTemplateDataSource[]Property Value
severity
The severity for alerts created by this alert rule.
severity?: stringProperty Value
string
status
The alert rule template status.
status?: stringProperty 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?: TriggerOperatorProperty Value
triggerThreshold
The threshold triggers this alert rule.
triggerThreshold?: numberProperty Value
number
version
The version of this template - in format <a.b.c>, where all are numbers. For example <1.0.2>.
version?: stringProperty 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?: stringProperty 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?: stringProperty 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?: SystemDataProperty Value
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?: stringProperty Value
string
Inherited From AlertRuleTemplate.type
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for