IScheduledQueryRuleProperties Interface
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.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.ScheduledQueryRulePropertiesTypeConverter))]
public interface IScheduledQueryRuleProperties : Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Runtime.IJsonSerializable[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Monitor.ScheduledQueryRule.Models.Api20210801.ScheduledQueryRulePropertiesTypeConverter))>]
type IScheduledQueryRuleProperties = interface
interface IJsonSerializablePublic Interface IScheduledQueryRuleProperties
Implements IJsonSerializable- Derived
- Attributes
- Implements
Properties
| ActionCustomProperty |
The properties of an alert payload. |
| ActionGroup |
Action Group resource Ids to invoke when the alert fires. |
| AutoMitigate |
The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert. |
| CheckWorkspaceAlertsStorageConfigured |
The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert. |
| CreatedWithApiVersion |
The api-version used when creating this alert rule |
| CriterionAllOf |
A list of conditions to evaluate against the specified scopes |
| Description |
The description of the scheduled query rule. |
| DisplayName |
The display name of the alert rule |
| Enabled |
The flag which indicates whether this scheduled query rule is enabled. Value should be true or false |
| EvaluationFrequency |
How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert. |
| IsLegacyLogAnalyticsRule |
True if alert rule is legacy Log Analytic rule |
| IsWorkspaceAlertsStorageConfigured |
The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. |
| MuteActionsDuration |
Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert. |
| OverrideQueryTimeRange |
If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. |
| Scope |
The list of resource id's that this scheduled query rule is scoped to. |
| Severity |
Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert. |
| SkipQueryValidation |
The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert. |
| TargetResourceType |
List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert |
| WindowSize |
The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert. |
Methods
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |