Microsoft.AlertsManagement (preview:2025-05-01)

2025/05/21 • 1 new methods

PreviewAlertRule (new)
Description :  Retrieves the results of a simulated historical execution of an alert rule
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/previewAlertRule
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The alert rule to preview. ,
Required: True ,
}
{
location:
{
Description: The location of the rule resource. ,
Required: True ,
}
string ,
properties:
{
Required: True ,
}
{
lookbackPeriod:
{
Description: Specifies the lookback of the preview in ISO 8601 duration format. ,
Format: duration ,
Required: True ,
}
string ,
scheduledQueryRuleProperties:
{
Description: The properties of the alert rule to preview. ,
Required: False ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: True ,
}
string ,
kind:
{
Description: Indicates the type of scheduled query rule. The default is LogAlert. ,
Enum:
{
LogAlert: No description available. ,
EventLogAlert: No description available. ,
LogToMetric: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The rule properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the scheduled query rule. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the alert rule ,
Required: False ,
}
string ,
severity:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
enabled:
{
Description: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false ,
Required: True ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this scheduled query rule is scoped to. ,
Required: True ,
}
[
string ,
]
,
evaluationFrequency:
{
Description: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert. ,
Format: duration ,
Required: False ,
}
string ,
windowSize:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
overrideQueryTimeRange:
{
Description: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. ,
Format: duration ,
Required: False ,
}
string ,
targetResourceTypes:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
criteria:
{
Description: The rule criteria that defines the conditions of the scheduled query rule. ,
Required: True ,
}
{
allOf:
{
Description: A list of conditions to evaluate against the specified scopes ,
Required: False ,
}
[
{
criterionType:
{
Description: Specifies the type of threshold criteria ,
Enum:
{
StaticThresholdCriterion: No description available. ,
DynamicThresholdCriterion: No description available. ,
}
,
Required: False ,
}
enum ,
query:
{
Description: KQL log query alert ,
Required: False ,
}
string ,
timeAggregation:
{
Description: Aggregation type. Relevant and required only for rules of the kind LogAlert. ,
Enum:
{
Count: No description available. ,
Average: No description available. ,
Minimum: No description available. ,
Maximum: No description available. ,
Total: No description available. ,
}
,
Required: False ,
}
enum ,
metricMeasureColumn:
{
Description: The column containing the metric measure number. Relevant only for rules of the kind LogAlert. ,
Required: False ,
}
string ,
resourceIdColumn:
{
Description: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert. ,
Required: False ,
}
string ,
dimensions:
{
Description: List of Dimensions conditions ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: True ,
}
string ,
operator:
{
Description: Operator for dimension values ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: List of dimension values ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
operator:
{
Description: The criteria operator. Relevant and required only for rules of the kind LogAlert. ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterOrLessThan: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: the criteria threshold value that activates the alert. Relevant and required only for static threshold rules of the kind LogAlert. ,
Format: double ,
Required: False ,
}
number ,
alertSensitivity:
{
Description: The extent of deviation required to trigger an alert. Allowed values are 'Low', 'Medium' and 'High'. This will affect how tight the threshold is to the metric series pattern. Relevant and required only for dynamic threshold rules of the kind LogAlert. ,
Required: False ,
}
string ,
ignoreDataBefore:
{
Description: Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format). Relevant only for dynamic threshold rules of the kind LogAlert. ,
Format: date-time ,
Required: False ,
}
string ,
failingPeriods:
{
Description: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert. ,
Required: False ,
}
{
numberOfEvaluationPeriods:
{
Description: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1 ,
Format: int64 ,
Required: False ,
}
integer ,
minFailingPeriodsToAlert:
{
Description: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
metricName:
{
Description: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. ,
Required: False ,
}
string ,
}
,
]
,
}
,
muteActionsDuration:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
autoMitigate:
{
Description: 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. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert. ,
Required: False ,
}
{
autoResolved:
{
Description: The flag that indicates whether or not to auto resolve a fired alert. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
rulePreviewResults:
{
Description: An array of rule preview results. ,
Required: False ,
}
[
{
dimensionCombination:
{
Description: The list of dimensions for the evaluation. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: True ,
}
string ,
value:
{
Description: Value of the dimension ,
Required: True ,
}
string ,
}
,
]
,
evaluations:
{
Description: An array of evaluations. ,
Required: False ,
}
[
{
evaluationTime:
{
Description: The time when the evaluation was performed. ,
Format: date-time ,
Required: False ,
}
string ,
alertState:
{
Description: The state of the alert after the evaluation. ,
Enum:
{
NoAlert: No description available. ,
Fired: No description available. ,
Firing: No description available. ,
Resolving: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
evaluatedPeriods:
{
Description: An array of evaluated periods. ,
Required: False ,
}
[
{
timestamp:
{
Description: The timestamp of the evaluated period. ,
Format: date-time ,
Required: False ,
}
string ,
highThreshold:
{
Description: The high threshold value for the evaluation period. ,
Format: double ,
Required: False ,
}
number ,
lowThreshold:
{
Description: The low threshold value for the evaluation period. ,
Format: double ,
Required: False ,
}
number ,
metricValue:
{
Description: The metric value for the evaluation period. ,
Format: double ,
Required: False ,
}
number ,
thresholdMet:
{
Description: Indicates whether the threshold was met during the evaluation period. ,
Required: False ,
}
boolean ,
}
,
]
,
thresholdMet:
{
Description: Indicates whether the threshold was met for this evaluation. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}