Microsoft.Insights (preview:2025-01-01)

2025/03/03 • 6 new methods

ScheduledQueryRules_ListBySubscription (new)
Description :  Retrieve a scheduled query rule definitions in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Insights/scheduledQueryRules
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The values for the scheduled query rule resources. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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. ,
SimpleLogAlert: No description available. ,
LogToMetric: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
systemData:
{
Description: SystemData of ScheduledQueryRule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The rule properties of the resource. ,
Required: True ,
}
{
createdWithApiVersion:
{
Description: The api-version used when creating this alert rule ,
Required: False ,
}
string ,
isLegacyLogAnalyticsRule:
{
Description: True if alert rule is legacy Log Analytic rule ,
Required: False ,
}
boolean ,
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: 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 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 ,
minRecurrenceCount:
{
Description: The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
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 ,
actions:
{
Description: Actions to invoke when the alert fires. ,
Required: False ,
}
{
actionGroups:
{
Description: Action Group resource Ids to invoke when the alert fires. ,
Required: False ,
}
[
string ,
]
,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
isWorkspaceAlertsStorageConfigured:
{
Description: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. ,
Required: False ,
}
boolean ,
checkWorkspaceAlertsStorageConfigured:
{
Description: 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. ,
Required: False ,
}
boolean ,
skipQueryValidation:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoMitigate:
{
Description: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Provides the link to retrieve the next set of elements. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ScheduledQueryRules_ListByResourceGroup (new)
Description :  Retrieve scheduled query rule definitions in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The values for the scheduled query rule resources. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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. ,
SimpleLogAlert: No description available. ,
LogToMetric: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
systemData:
{
Description: SystemData of ScheduledQueryRule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The rule properties of the resource. ,
Required: True ,
}
{
createdWithApiVersion:
{
Description: The api-version used when creating this alert rule ,
Required: False ,
}
string ,
isLegacyLogAnalyticsRule:
{
Description: True if alert rule is legacy Log Analytic rule ,
Required: False ,
}
boolean ,
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: 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 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 ,
minRecurrenceCount:
{
Description: The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
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 ,
actions:
{
Description: Actions to invoke when the alert fires. ,
Required: False ,
}
{
actionGroups:
{
Description: Action Group resource Ids to invoke when the alert fires. ,
Required: False ,
}
[
string ,
]
,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
isWorkspaceAlertsStorageConfigured:
{
Description: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. ,
Required: False ,
}
boolean ,
checkWorkspaceAlertsStorageConfigured:
{
Description: 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. ,
Required: False ,
}
boolean ,
skipQueryValidation:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoMitigate:
{
Description: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Provides the link to retrieve the next set of elements. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ScheduledQueryRules_Get (new)
Description :  Retrieve an scheduled query rule definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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. ,
SimpleLogAlert: No description available. ,
LogToMetric: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
systemData:
{
Description: SystemData of ScheduledQueryRule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The rule properties of the resource. ,
Required: True ,
}
{
createdWithApiVersion:
{
Description: The api-version used when creating this alert rule ,
Required: False ,
}
string ,
isLegacyLogAnalyticsRule:
{
Description: True if alert rule is legacy Log Analytic rule ,
Required: False ,
}
boolean ,
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: 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 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 ,
minRecurrenceCount:
{
Description: The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
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 ,
actions:
{
Description: Actions to invoke when the alert fires. ,
Required: False ,
}
{
actionGroups:
{
Description: Action Group resource Ids to invoke when the alert fires. ,
Required: False ,
}
[
string ,
]
,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
isWorkspaceAlertsStorageConfigured:
{
Description: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. ,
Required: False ,
}
boolean ,
checkWorkspaceAlertsStorageConfigured:
{
Description: 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. ,
Required: False ,
}
boolean ,
skipQueryValidation:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoMitigate:
{
Description: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
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 (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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ScheduledQueryRules_CreateOrUpdate (new)
Description :  Creates or updates a scheduled query rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters of the rule to create or update. ,
Required: True ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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. ,
SimpleLogAlert: No description available. ,
LogToMetric: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
systemData:
{
Description: SystemData of ScheduledQueryRule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The rule properties of the resource. ,
Required: True ,
}
{
createdWithApiVersion:
{
Description: The api-version used when creating this alert rule ,
Required: False ,
}
string ,
isLegacyLogAnalyticsRule:
{
Description: True if alert rule is legacy Log Analytic rule ,
Required: False ,
}
boolean ,
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: 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 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 ,
minRecurrenceCount:
{
Description: The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
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 ,
actions:
{
Description: Actions to invoke when the alert fires. ,
Required: False ,
}
{
actionGroups:
{
Description: Action Group resource Ids to invoke when the alert fires. ,
Required: False ,
}
[
string ,
]
,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
isWorkspaceAlertsStorageConfigured:
{
Description: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. ,
Required: False ,
}
boolean ,
checkWorkspaceAlertsStorageConfigured:
{
Description: 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. ,
Required: False ,
}
boolean ,
skipQueryValidation:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoMitigate:
{
Description: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
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)

{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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. ,
SimpleLogAlert: No description available. ,
LogToMetric: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
systemData:
{
Description: SystemData of ScheduledQueryRule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The rule properties of the resource. ,
Required: True ,
}
{
createdWithApiVersion:
{
Description: The api-version used when creating this alert rule ,
Required: False ,
}
string ,
isLegacyLogAnalyticsRule:
{
Description: True if alert rule is legacy Log Analytic rule ,
Required: False ,
}
boolean ,
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: 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 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 ,
minRecurrenceCount:
{
Description: The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
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 ,
actions:
{
Description: Actions to invoke when the alert fires. ,
Required: False ,
}
{
actionGroups:
{
Description: Action Group resource Ids to invoke when the alert fires. ,
Required: False ,
}
[
string ,
]
,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
isWorkspaceAlertsStorageConfigured:
{
Description: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. ,
Required: False ,
}
boolean ,
checkWorkspaceAlertsStorageConfigured:
{
Description: 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. ,
Required: False ,
}
boolean ,
skipQueryValidation:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoMitigate:
{
Description: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
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 (201)

{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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. ,
SimpleLogAlert: No description available. ,
LogToMetric: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
systemData:
{
Description: SystemData of ScheduledQueryRule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The rule properties of the resource. ,
Required: True ,
}
{
createdWithApiVersion:
{
Description: The api-version used when creating this alert rule ,
Required: False ,
}
string ,
isLegacyLogAnalyticsRule:
{
Description: True if alert rule is legacy Log Analytic rule ,
Required: False ,
}
boolean ,
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: 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 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 ,
minRecurrenceCount:
{
Description: The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
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 ,
actions:
{
Description: Actions to invoke when the alert fires. ,
Required: False ,
}
{
actionGroups:
{
Description: Action Group resource Ids to invoke when the alert fires. ,
Required: False ,
}
[
string ,
]
,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
isWorkspaceAlertsStorageConfigured:
{
Description: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. ,
Required: False ,
}
boolean ,
checkWorkspaceAlertsStorageConfigured:
{
Description: 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. ,
Required: False ,
}
boolean ,
skipQueryValidation:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoMitigate:
{
Description: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
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 (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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ScheduledQueryRules_Update (new)
Description :  Update a scheduled query rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters of the rule to update. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: The scheduled query rule properties of the resource. ,
Required: False ,
}
{
createdWithApiVersion:
{
Description: The api-version used when creating this alert rule ,
Required: False ,
}
string ,
isLegacyLogAnalyticsRule:
{
Description: True if alert rule is legacy Log Analytic rule ,
Required: False ,
}
boolean ,
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: False ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this scheduled query rule is scoped to. ,
Required: False ,
}
[
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: False ,
}
{
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: 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 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 ,
minRecurrenceCount:
{
Description: The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
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 ,
actions:
{
Description: Actions to invoke when the alert fires. ,
Required: False ,
}
{
actionGroups:
{
Description: Action Group resource Ids to invoke when the alert fires. ,
Required: False ,
}
[
string ,
]
,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
isWorkspaceAlertsStorageConfigured:
{
Description: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. ,
Required: False ,
}
boolean ,
checkWorkspaceAlertsStorageConfigured:
{
Description: 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. ,
Required: False ,
}
boolean ,
skipQueryValidation:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoMitigate:
{
Description: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
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)

{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
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. ,
SimpleLogAlert: No description available. ,
LogToMetric: No description available. ,
}
,
Required: False ,
}
enum ,
etag:
{
Description: The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
systemData:
{
Description: SystemData of ScheduledQueryRule. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The rule properties of the resource. ,
Required: True ,
}
{
createdWithApiVersion:
{
Description: The api-version used when creating this alert rule ,
Required: False ,
}
string ,
isLegacyLogAnalyticsRule:
{
Description: True if alert rule is legacy Log Analytic rule ,
Required: False ,
}
boolean ,
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: 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 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 ,
minRecurrenceCount:
{
Description: The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
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 ,
actions:
{
Description: Actions to invoke when the alert fires. ,
Required: False ,
}
{
actionGroups:
{
Description: Action Group resource Ids to invoke when the alert fires. ,
Required: False ,
}
[
string ,
]
,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
isWorkspaceAlertsStorageConfigured:
{
Description: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. ,
Required: False ,
}
boolean ,
checkWorkspaceAlertsStorageConfigured:
{
Description: 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. ,
Required: False ,
}
boolean ,
skipQueryValidation:
{
Description: 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. ,
Required: False ,
}
boolean ,
autoMitigate:
{
Description: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Relevant only for rules of kinds LogAlert and SimpleLogAlert. ,
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 (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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ScheduledQueryRules_Delete (new)
Description :  Deletes a scheduled query rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (204)

{}