Docs Home
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
azure-native-v2.insights.ScheduledQueryRule
Explore with Pulumi AI
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
- Example Usage
- Create or update a scheduled query rule for Single Resource
- Create or update a scheduled query rule on Resource group(s)
- Create or update a scheduled query rule on Subscription
- Create ScheduledQueryRule Resource
- Constructor syntax
- Constructor example
- ScheduledQueryRule Resource Properties
- Inputs
- Outputs
- Supporting Types
- Import
- Package Details
The scheduled query rule resource. Azure REST API version: 2023-03-15-preview. Prior API version in Azure Native 1.x: 2018-04-16.
Other available API versions: 2018-04-16, 2020-05-01-preview, 2022-08-01-preview, 2023-12-01, 2024-01-01-preview.
Example Usage
Create or update a scheduled query rule for Single Resource
Create or update a scheduled query rule on Resource group(s)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var scheduledQueryRule = new AzureNative.Insights.ScheduledQueryRule("scheduledQueryRule", new()
{
Actions = new AzureNative.Insights.Inputs.ActionsArgs
{
ActionGroups = new[]
{
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup",
},
CustomProperties =
{
{ "key11", "value11" },
{ "key12", "value12" },
},
},
CheckWorkspaceAlertsStorageConfigured = true,
Criteria = new AzureNative.Insights.Inputs.ScheduledQueryRuleCriteriaArgs
{
AllOf = new[]
{
new AzureNative.Insights.Inputs.ConditionArgs
{
Dimensions = new() { },
FailingPeriods = new AzureNative.Insights.Inputs.ConditionFailingPeriodsArgs
{
MinFailingPeriodsToAlert = 1,
NumberOfEvaluationPeriods = 1,
},
Operator = AzureNative.Insights.ConditionOperator.GreaterThan,
Query = "Heartbeat",
Threshold = 360,
TimeAggregation = AzureNative.Insights.TimeAggregation.Count,
},
},
},
Description = "Health check rule",
Enabled = true,
EvaluationFrequency = "PT5M",
Location = "eastus",
MuteActionsDuration = "PT30M",
ResolveConfiguration = new AzureNative.Insights.Inputs.RuleResolveConfigurationArgs
{
AutoResolved = true,
TimeToResolve = "PT10M",
},
ResourceGroupName = "QueryResourceGroupName",
RuleName = "heartbeat",
Scopes = new[]
{
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1",
},
Severity = 4,
SkipQueryValidation = true,
TargetResourceTypes = new[]
{
"Microsoft.Compute/virtualMachines",
},
WindowSize = "PT10M",
});
});
package main
import (
insights "github.com/pulumi/pulumi-azure-native-sdk/insights/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := insights.NewScheduledQueryRule(ctx, "scheduledQueryRule", &insights.ScheduledQueryRuleArgs{
Actions: &insights.ActionsArgs{
ActionGroups: pulumi.StringArray{
pulumi.String("/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"),
},
CustomProperties: pulumi.StringMap{
"key11": pulumi.String("value11"),
"key12": pulumi.String("value12"),
},
},
CheckWorkspaceAlertsStorageConfigured: pulumi.Bool(true),
Criteria: &insights.ScheduledQueryRuleCriteriaArgs{
AllOf: insights.ConditionArray{
&insights.ConditionArgs{
Dimensions: insights.DimensionArray{},
FailingPeriods: &insights.ConditionFailingPeriodsArgs{
MinFailingPeriodsToAlert: pulumi.Float64(1),
NumberOfEvaluationPeriods: pulumi.Float64(1),
},
Operator: pulumi.String(insights.ConditionOperatorGreaterThan),
Query: pulumi.String("Heartbeat"),
Threshold: pulumi.Float64(360),
TimeAggregation: pulumi.String(insights.TimeAggregationCount),
},
},
},
Description: pulumi.String("Health check rule"),
Enabled: pulumi.Bool(true),
EvaluationFrequency: pulumi.String("PT5M"),
Location: pulumi.String("eastus"),
MuteActionsDuration: pulumi.String("PT30M"),
ResolveConfiguration: &insights.RuleResolveConfigurationArgs{
AutoResolved: pulumi.Bool(true),
TimeToResolve: pulumi.String("PT10M"),
},
ResourceGroupName: pulumi.String("QueryResourceGroupName"),
RuleName: pulumi.String("heartbeat"),
Scopes: pulumi.StringArray{
pulumi.String("/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"),
},
Severity: pulumi.Float64(4),
SkipQueryValidation: pulumi.Bool(true),
TargetResourceTypes: pulumi.StringArray{
pulumi.String("Microsoft.Compute/virtualMachines"),
},
WindowSize: pulumi.String("PT10M"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.insights.ScheduledQueryRule;
import com.pulumi.azurenative.insights.ScheduledQueryRuleArgs;
import com.pulumi.azurenative.insights.inputs.ActionsArgs;
import com.pulumi.azurenative.insights.inputs.ScheduledQueryRuleCriteriaArgs;
import com.pulumi.azurenative.insights.inputs.RuleResolveConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var scheduledQueryRule = new ScheduledQueryRule("scheduledQueryRule", ScheduledQueryRuleArgs.builder()
.actions(ActionsArgs.builder()
.actionGroups("/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup")
.customProperties(Map.ofEntries(
Map.entry("key11", "value11"),
Map.entry("key12", "value12")
))
.build())
.checkWorkspaceAlertsStorageConfigured(true)
.criteria(ScheduledQueryRuleCriteriaArgs.builder()
.allOf(ConditionArgs.builder()
.dimensions()
.failingPeriods(ConditionFailingPeriodsArgs.builder()
.minFailingPeriodsToAlert(1)
.numberOfEvaluationPeriods(1)
.build())
.operator("GreaterThan")
.query("Heartbeat")
.threshold(360)
.timeAggregation("Count")
.build())
.build())
.description("Health check rule")
.enabled(true)
.evaluationFrequency("PT5M")
.location("eastus")
.muteActionsDuration("PT30M")
.resolveConfiguration(RuleResolveConfigurationArgs.builder()
.autoResolved(true)
.timeToResolve("PT10M")
.build())
.resourceGroupName("QueryResourceGroupName")
.ruleName("heartbeat")
.scopes("/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1")
.severity(4)
.skipQueryValidation(true)
.targetResourceTypes("Microsoft.Compute/virtualMachines")
.windowSize("PT10M")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const scheduledQueryRule = new azure_native.insights.ScheduledQueryRule("scheduledQueryRule", {
actions: {
actionGroups: ["/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"],
customProperties: {
key11: "value11",
key12: "value12",
},
},
checkWorkspaceAlertsStorageConfigured: true,
criteria: {
allOf: [{
dimensions: [],
failingPeriods: {
minFailingPeriodsToAlert: 1,
numberOfEvaluationPeriods: 1,
},
operator: azure_native.insights.ConditionOperator.GreaterThan,
query: "Heartbeat",
threshold: 360,
timeAggregation: azure_native.insights.TimeAggregation.Count,
}],
},
description: "Health check rule",
enabled: true,
evaluationFrequency: "PT5M",
location: "eastus",
muteActionsDuration: "PT30M",
resolveConfiguration: {
autoResolved: true,
timeToResolve: "PT10M",
},
resourceGroupName: "QueryResourceGroupName",
ruleName: "heartbeat",
scopes: ["/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"],
severity: 4,
skipQueryValidation: true,
targetResourceTypes: ["Microsoft.Compute/virtualMachines"],
windowSize: "PT10M",
});
import pulumi
import pulumi_azure_native as azure_native
scheduled_query_rule = azure_native.insights.ScheduledQueryRule("scheduledQueryRule",
actions={
"action_groups": ["/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"],
"custom_properties": {
"key11": "value11",
"key12": "value12",
},
},
check_workspace_alerts_storage_configured=True,
criteria={
"all_of": [{
"dimensions": [],
"failing_periods": {
"min_failing_periods_to_alert": 1,
"number_of_evaluation_periods": 1,
},
"operator": azure_native.insights.ConditionOperator.GREATER_THAN,
"query": "Heartbeat",
"threshold": 360,
"time_aggregation": azure_native.insights.TimeAggregation.COUNT,
}],
},
description="Health check rule",
enabled=True,
evaluation_frequency="PT5M",
location="eastus",
mute_actions_duration="PT30M",
resolve_configuration={
"auto_resolved": True,
"time_to_resolve": "PT10M",
},
resource_group_name="QueryResourceGroupName",
rule_name="heartbeat",
scopes=["/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"],
severity=4,
skip_query_validation=True,
target_resource_types=["Microsoft.Compute/virtualMachines"],
window_size="PT10M")
resources:
scheduledQueryRule:
type: azure-native:insights:ScheduledQueryRule
properties:
actions:
actionGroups:
- /subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup
customProperties:
key11: value11
key12: value12
checkWorkspaceAlertsStorageConfigured: true
criteria:
allOf:
- dimensions: []
failingPeriods:
minFailingPeriodsToAlert: 1
numberOfEvaluationPeriods: 1
operator: GreaterThan
query: Heartbeat
threshold: 360
timeAggregation: Count
description: Health check rule
enabled: true
evaluationFrequency: PT5M
location: eastus
muteActionsDuration: PT30M
resolveConfiguration:
autoResolved: true
timeToResolve: PT10M
resourceGroupName: QueryResourceGroupName
ruleName: heartbeat
scopes:
- /subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1
severity: 4
skipQueryValidation: true
targetResourceTypes:
- Microsoft.Compute/virtualMachines
windowSize: PT10M
Create or update a scheduled query rule on Subscription
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var scheduledQueryRule = new AzureNative.Insights.ScheduledQueryRule("scheduledQueryRule", new()
{
Actions = new AzureNative.Insights.Inputs.ActionsArgs
{
ActionGroups = new[]
{
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup",
},
CustomProperties =
{
{ "key11", "value11" },
{ "key12", "value12" },
},
},
CheckWorkspaceAlertsStorageConfigured = true,
Criteria = new AzureNative.Insights.Inputs.ScheduledQueryRuleCriteriaArgs
{
AllOf = new[]
{
new AzureNative.Insights.Inputs.ConditionArgs
{
Dimensions = new[]
{
new AzureNative.Insights.Inputs.DimensionArgs
{
Name = "ComputerIp",
Operator = AzureNative.Insights.DimensionOperator.Exclude,
Values = new[]
{
"192.168.1.1",
},
},
new AzureNative.Insights.Inputs.DimensionArgs
{
Name = "OSType",
Operator = AzureNative.Insights.DimensionOperator.Include,
Values = new[]
{
"*",
},
},
},
FailingPeriods = new AzureNative.Insights.Inputs.ConditionFailingPeriodsArgs
{
MinFailingPeriodsToAlert = 1,
NumberOfEvaluationPeriods = 1,
},
MetricMeasureColumn = "% Processor Time",
Operator = AzureNative.Insights.ConditionOperator.GreaterThan,
Query = "Perf | where ObjectName == \"Processor\"",
ResourceIdColumn = "resourceId",
Threshold = 70,
TimeAggregation = AzureNative.Insights.TimeAggregation.Average,
},
},
},
Description = "Performance rule",
Enabled = true,
EvaluationFrequency = "PT5M",
Location = "eastus",
MuteActionsDuration = "PT30M",
ResolveConfiguration = new AzureNative.Insights.Inputs.RuleResolveConfigurationArgs
{
AutoResolved = true,
TimeToResolve = "PT10M",
},
ResourceGroupName = "QueryResourceGroupName",
RuleName = "perf",
Scopes = new[]
{
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147",
},
Severity = 4,
SkipQueryValidation = true,
TargetResourceTypes = new[]
{
"Microsoft.Compute/virtualMachines",
},
WindowSize = "PT10M",
});
});
package main
import (
insights "github.com/pulumi/pulumi-azure-native-sdk/insights/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := insights.NewScheduledQueryRule(ctx, "scheduledQueryRule", &insights.ScheduledQueryRuleArgs{
Actions: &insights.ActionsArgs{
ActionGroups: pulumi.StringArray{
pulumi.String("/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"),
},
CustomProperties: pulumi.StringMap{
"key11": pulumi.String("value11"),
"key12": pulumi.String("value12"),
},
},
CheckWorkspaceAlertsStorageConfigured: pulumi.Bool(true),
Criteria: &insights.ScheduledQueryRuleCriteriaArgs{
AllOf: insights.ConditionArray{
&insights.ConditionArgs{
Dimensions: insights.DimensionArray{
&insights.DimensionArgs{
Name: pulumi.String("ComputerIp"),
Operator: pulumi.String(insights.DimensionOperatorExclude),
Values: pulumi.StringArray{
pulumi.String("192.168.1.1"),
},
},
&insights.DimensionArgs{
Name: pulumi.String("OSType"),
Operator: pulumi.String(insights.DimensionOperatorInclude),
Values: pulumi.StringArray{
pulumi.String("*"),
},
},
},
FailingPeriods: &insights.ConditionFailingPeriodsArgs{
MinFailingPeriodsToAlert: pulumi.Float64(1),
NumberOfEvaluationPeriods: pulumi.Float64(1),
},
MetricMeasureColumn: pulumi.String("% Processor Time"),
Operator: pulumi.String(insights.ConditionOperatorGreaterThan),
Query: pulumi.String("Perf | where ObjectName == \"Processor\""),
ResourceIdColumn: pulumi.String("resourceId"),
Threshold: pulumi.Float64(70),
TimeAggregation: pulumi.String(insights.TimeAggregationAverage),
},
},
},
Description: pulumi.String("Performance rule"),
Enabled: pulumi.Bool(true),
EvaluationFrequency: pulumi.String("PT5M"),
Location: pulumi.String("eastus"),
MuteActionsDuration: pulumi.String("PT30M"),
ResolveConfiguration: &insights.RuleResolveConfigurationArgs{
AutoResolved: pulumi.Bool(true),
TimeToResolve: pulumi.String("PT10M"),
},
ResourceGroupName: pulumi.String("QueryResourceGroupName"),
RuleName: pulumi.String("perf"),
Scopes: pulumi.StringArray{
pulumi.String("/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"),
},
Severity: pulumi.Float64(4),
SkipQueryValidation: pulumi.Bool(true),
TargetResourceTypes: pulumi.StringArray{
pulumi.String("Microsoft.Compute/virtualMachines"),
},
WindowSize: pulumi.String("PT10M"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.insights.ScheduledQueryRule;
import com.pulumi.azurenative.insights.ScheduledQueryRuleArgs;
import com.pulumi.azurenative.insights.inputs.ActionsArgs;
import com.pulumi.azurenative.insights.inputs.ScheduledQueryRuleCriteriaArgs;
import com.pulumi.azurenative.insights.inputs.RuleResolveConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var scheduledQueryRule = new ScheduledQueryRule("scheduledQueryRule", ScheduledQueryRuleArgs.builder()
.actions(ActionsArgs.builder()
.actionGroups("/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup")
.customProperties(Map.ofEntries(
Map.entry("key11", "value11"),
Map.entry("key12", "value12")
))
.build())
.checkWorkspaceAlertsStorageConfigured(true)
.criteria(ScheduledQueryRuleCriteriaArgs.builder()
.allOf(ConditionArgs.builder()
.dimensions(
DimensionArgs.builder()
.name("ComputerIp")
.operator("Exclude")
.values("192.168.1.1")
.build(),
DimensionArgs.builder()
.name("OSType")
.operator("Include")
.values("*")
.build())
.failingPeriods(ConditionFailingPeriodsArgs.builder()
.minFailingPeriodsToAlert(1)
.numberOfEvaluationPeriods(1)
.build())
.metricMeasureColumn("% Processor Time")
.operator("GreaterThan")
.query("Perf | where ObjectName == \"Processor\"")
.resourceIdColumn("resourceId")
.threshold(70)
.timeAggregation("Average")
.build())
.build())
.description("Performance rule")
.enabled(true)
.evaluationFrequency("PT5M")
.location("eastus")
.muteActionsDuration("PT30M")
.resolveConfiguration(RuleResolveConfigurationArgs.builder()
.autoResolved(true)
.timeToResolve("PT10M")
.build())
.resourceGroupName("QueryResourceGroupName")
.ruleName("perf")
.scopes("/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147")
.severity(4)
.skipQueryValidation(true)
.targetResourceTypes("Microsoft.Compute/virtualMachines")
.windowSize("PT10M")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const scheduledQueryRule = new azure_native.insights.ScheduledQueryRule("scheduledQueryRule", {
actions: {
actionGroups: ["/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"],
customProperties: {
key11: "value11",
key12: "value12",
},
},
checkWorkspaceAlertsStorageConfigured: true,
criteria: {
allOf: [{
dimensions: [
{
name: "ComputerIp",
operator: azure_native.insights.DimensionOperator.Exclude,
values: ["192.168.1.1"],
},
{
name: "OSType",
operator: azure_native.insights.DimensionOperator.Include,
values: ["*"],
},
],
failingPeriods: {
minFailingPeriodsToAlert: 1,
numberOfEvaluationPeriods: 1,
},
metricMeasureColumn: "% Processor Time",
operator: azure_native.insights.ConditionOperator.GreaterThan,
query: "Perf | where ObjectName == \"Processor\"",
resourceIdColumn: "resourceId",
threshold: 70,
timeAggregation: azure_native.insights.TimeAggregation.Average,
}],
},
description: "Performance rule",
enabled: true,
evaluationFrequency: "PT5M",
location: "eastus",
muteActionsDuration: "PT30M",
resolveConfiguration: {
autoResolved: true,
timeToResolve: "PT10M",
},
resourceGroupName: "QueryResourceGroupName",
ruleName: "perf",
scopes: ["/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"],
severity: 4,
skipQueryValidation: true,
targetResourceTypes: ["Microsoft.Compute/virtualMachines"],
windowSize: "PT10M",
});
import pulumi
import pulumi_azure_native as azure_native
scheduled_query_rule = azure_native.insights.ScheduledQueryRule("scheduledQueryRule",
actions={
"action_groups": ["/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"],
"custom_properties": {
"key11": "value11",
"key12": "value12",
},
},
check_workspace_alerts_storage_configured=True,
criteria={
"all_of": [{
"dimensions": [
{
"name": "ComputerIp",
"operator": azure_native.insights.DimensionOperator.EXCLUDE,
"values": ["192.168.1.1"],
},
{
"name": "OSType",
"operator": azure_native.insights.DimensionOperator.INCLUDE,
"values": ["*"],
},
],
"failing_periods": {
"min_failing_periods_to_alert": 1,
"number_of_evaluation_periods": 1,
},
"metric_measure_column": "% Processor Time",
"operator": azure_native.insights.ConditionOperator.GREATER_THAN,
"query": "Perf | where ObjectName == \"Processor\"",
"resource_id_column": "resourceId",
"threshold": 70,
"time_aggregation": azure_native.insights.TimeAggregation.AVERAGE,
}],
},
description="Performance rule",
enabled=True,
evaluation_frequency="PT5M",
location="eastus",
mute_actions_duration="PT30M",
resolve_configuration={
"auto_resolved": True,
"time_to_resolve": "PT10M",
},
resource_group_name="QueryResourceGroupName",
rule_name="perf",
scopes=["/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"],
severity=4,
skip_query_validation=True,
target_resource_types=["Microsoft.Compute/virtualMachines"],
window_size="PT10M")
resources:
scheduledQueryRule:
type: azure-native:insights:ScheduledQueryRule
properties:
actions:
actionGroups:
- /subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup
customProperties:
key11: value11
key12: value12
checkWorkspaceAlertsStorageConfigured: true
criteria:
allOf:
- dimensions:
- name: ComputerIp
operator: Exclude
values:
- 192.168.1.1
- name: OSType
operator: Include
values:
- '*'
failingPeriods:
minFailingPeriodsToAlert: 1
numberOfEvaluationPeriods: 1
metricMeasureColumn: '% Processor Time'
operator: GreaterThan
query: Perf | where ObjectName == "Processor"
resourceIdColumn: resourceId
threshold: 70
timeAggregation: Average
description: Performance rule
enabled: true
evaluationFrequency: PT5M
location: eastus
muteActionsDuration: PT30M
resolveConfiguration:
autoResolved: true
timeToResolve: PT10M
resourceGroupName: QueryResourceGroupName
ruleName: perf
scopes:
- /subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147
severity: 4
skipQueryValidation: true
targetResourceTypes:
- Microsoft.Compute/virtualMachines
windowSize: PT10M
Create ScheduledQueryRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ScheduledQueryRule(name: string, args: ScheduledQueryRuleArgs, opts?: CustomResourceOptions);@overload
def ScheduledQueryRule(resource_name: str,
args: ScheduledQueryRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ScheduledQueryRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
scopes: Optional[Sequence[str]] = None,
resource_group_name: Optional[str] = None,
criteria: Optional[ScheduledQueryRuleCriteriaArgs] = None,
location: Optional[str] = None,
resolve_configuration: Optional[RuleResolveConfigurationArgs] = None,
description: Optional[str] = None,
evaluation_frequency: Optional[str] = None,
identity: Optional[IdentityArgs] = None,
kind: Optional[Union[str, Kind]] = None,
actions: Optional[ActionsArgs] = None,
mute_actions_duration: Optional[str] = None,
override_query_time_range: Optional[str] = None,
display_name: Optional[str] = None,
check_workspace_alerts_storage_configured: Optional[bool] = None,
rule_name: Optional[str] = None,
auto_mitigate: Optional[bool] = None,
severity: Optional[float] = None,
skip_query_validation: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None,
target_resource_types: Optional[Sequence[str]] = None,
window_size: Optional[str] = None)func NewScheduledQueryRule(ctx *Context, name string, args ScheduledQueryRuleArgs, opts ...ResourceOption) (*ScheduledQueryRule, error)public ScheduledQueryRule(string name, ScheduledQueryRuleArgs args, CustomResourceOptions? opts = null)public ScheduledQueryRule(String name, ScheduledQueryRuleArgs args)
public ScheduledQueryRule(String name, ScheduledQueryRuleArgs args, CustomResourceOptions options)
type: azure-native:insights:ScheduledQueryRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ScheduledQueryRuleArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. ScheduledQueryRuleArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ScheduledQueryRuleArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ScheduledQueryRuleArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ScheduledQueryRuleArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var scheduledQueryRuleResource = new AzureNative.Insights.ScheduledQueryRule("scheduledQueryRuleResource", new()
{
Enabled = false,
Scopes = new[]
{
"string",
},
ResourceGroupName = "string",
Criteria =
{
{ "allOf", new[]
{
{
{ "dimensions", new[]
{
{
{ "name", "string" },
{ "operator", "string" },
{ "values", new[]
{
"string",
} },
},
} },
{ "failingPeriods",
{
{ "minFailingPeriodsToAlert", 0 },
{ "numberOfEvaluationPeriods", 0 },
} },
{ "metricMeasureColumn", "string" },
{ "metricName", "string" },
{ "operator", "string" },
{ "query", "string" },
{ "resourceIdColumn", "string" },
{ "threshold", 0 },
{ "timeAggregation", "string" },
},
} },
},
Location = "string",
ResolveConfiguration =
{
{ "autoResolved", false },
{ "timeToResolve", "string" },
},
Description = "string",
EvaluationFrequency = "string",
Identity =
{
{ "type", "SystemAssigned" },
{ "userAssignedIdentities", new[]
{
"string",
} },
},
Kind = "string",
Actions =
{
{ "actionGroups", new[]
{
"string",
} },
{ "actionProperties",
{
{ "string", "string" },
} },
{ "customProperties",
{
{ "string", "string" },
} },
},
MuteActionsDuration = "string",
OverrideQueryTimeRange = "string",
DisplayName = "string",
CheckWorkspaceAlertsStorageConfigured = false,
RuleName = "string",
AutoMitigate = false,
Severity = 0,
SkipQueryValidation = false,
Tags =
{
{ "string", "string" },
},
TargetResourceTypes = new[]
{
"string",
},
WindowSize = "string",
});
example, err := insights.NewScheduledQueryRule(ctx, "scheduledQueryRuleResource", &insights.ScheduledQueryRuleArgs{
Enabled: false,
Scopes: []string{
"string",
},
ResourceGroupName: "string",
Criteria: map[string]interface{}{
"allOf": []map[string]interface{}{
map[string]interface{}{
"dimensions": []map[string]interface{}{
map[string]interface{}{
"name": "string",
"operator": "string",
"values": []string{
"string",
},
},
},
"failingPeriods": map[string]interface{}{
"minFailingPeriodsToAlert": 0,
"numberOfEvaluationPeriods": 0,
},
"metricMeasureColumn": "string",
"metricName": "string",
"operator": "string",
"query": "string",
"resourceIdColumn": "string",
"threshold": 0,
"timeAggregation": "string",
},
},
},
Location: "string",
ResolveConfiguration: map[string]interface{}{
"autoResolved": false,
"timeToResolve": "string",
},
Description: "string",
EvaluationFrequency: "string",
Identity: map[string]interface{}{
"type": "SystemAssigned",
"userAssignedIdentities": []string{
"string",
},
},
Kind: "string",
Actions: map[string]interface{}{
"actionGroups": []string{
"string",
},
"actionProperties": map[string]interface{}{
"string": "string",
},
"customProperties": map[string]interface{}{
"string": "string",
},
},
MuteActionsDuration: "string",
OverrideQueryTimeRange: "string",
DisplayName: "string",
CheckWorkspaceAlertsStorageConfigured: false,
RuleName: "string",
AutoMitigate: false,
Severity: 0,
SkipQueryValidation: false,
Tags: map[string]interface{}{
"string": "string",
},
TargetResourceTypes: []string{
"string",
},
WindowSize: "string",
})
var scheduledQueryRuleResource = new ScheduledQueryRule("scheduledQueryRuleResource", ScheduledQueryRuleArgs.builder()
.enabled(false)
.scopes("string")
.resourceGroupName("string")
.criteria(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.location("string")
.resolveConfiguration(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.description("string")
.evaluationFrequency("string")
.identity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.kind("string")
.actions(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.muteActionsDuration("string")
.overrideQueryTimeRange("string")
.displayName("string")
.checkWorkspaceAlertsStorageConfigured(false)
.ruleName("string")
.autoMitigate(false)
.severity(0)
.skipQueryValidation(false)
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.targetResourceTypes("string")
.windowSize("string")
.build());
scheduled_query_rule_resource = azure_native.insights.ScheduledQueryRule("scheduledQueryRuleResource",
enabled=False,
scopes=[string],
resource_group_name=string,
criteria={
allOf: [{
dimensions: [{
name: string,
operator: string,
values: [string],
}],
failingPeriods: {
minFailingPeriodsToAlert: 0,
numberOfEvaluationPeriods: 0,
},
metricMeasureColumn: string,
metricName: string,
operator: string,
query: string,
resourceIdColumn: string,
threshold: 0,
timeAggregation: string,
}],
},
location=string,
resolve_configuration={
autoResolved: False,
timeToResolve: string,
},
description=string,
evaluation_frequency=string,
identity={
type: SystemAssigned,
userAssignedIdentities: [string],
},
kind=string,
actions={
actionGroups: [string],
actionProperties: {
string: string,
},
customProperties: {
string: string,
},
},
mute_actions_duration=string,
override_query_time_range=string,
display_name=string,
check_workspace_alerts_storage_configured=False,
rule_name=string,
auto_mitigate=False,
severity=0,
skip_query_validation=False,
tags={
string: string,
},
target_resource_types=[string],
window_size=string)
const scheduledQueryRuleResource = new azure_native.insights.ScheduledQueryRule("scheduledQueryRuleResource", {
enabled: false,
scopes: ["string"],
resourceGroupName: "string",
criteria: {
allOf: [{
dimensions: [{
name: "string",
operator: "string",
values: ["string"],
}],
failingPeriods: {
minFailingPeriodsToAlert: 0,
numberOfEvaluationPeriods: 0,
},
metricMeasureColumn: "string",
metricName: "string",
operator: "string",
query: "string",
resourceIdColumn: "string",
threshold: 0,
timeAggregation: "string",
}],
},
location: "string",
resolveConfiguration: {
autoResolved: false,
timeToResolve: "string",
},
description: "string",
evaluationFrequency: "string",
identity: {
type: "SystemAssigned",
userAssignedIdentities: ["string"],
},
kind: "string",
actions: {
actionGroups: ["string"],
actionProperties: {
string: "string",
},
customProperties: {
string: "string",
},
},
muteActionsDuration: "string",
overrideQueryTimeRange: "string",
displayName: "string",
checkWorkspaceAlertsStorageConfigured: false,
ruleName: "string",
autoMitigate: false,
severity: 0,
skipQueryValidation: false,
tags: {
string: "string",
},
targetResourceTypes: ["string"],
windowSize: "string",
});
type: azure-native:insights:ScheduledQueryRule
properties:
actions:
actionGroups:
- string
actionProperties:
string: string
customProperties:
string: string
autoMitigate: false
checkWorkspaceAlertsStorageConfigured: false
criteria:
allOf:
- dimensions:
- name: string
operator: string
values:
- string
failingPeriods:
minFailingPeriodsToAlert: 0
numberOfEvaluationPeriods: 0
metricMeasureColumn: string
metricName: string
operator: string
query: string
resourceIdColumn: string
threshold: 0
timeAggregation: string
description: string
displayName: string
enabled: false
evaluationFrequency: string
identity:
type: SystemAssigned
userAssignedIdentities:
- string
kind: string
location: string
muteActionsDuration: string
overrideQueryTimeRange: string
resolveConfiguration:
autoResolved: false
timeToResolve: string
resourceGroupName: string
ruleName: string
scopes:
- string
severity: 0
skipQueryValidation: false
tags:
string: string
targetResourceTypes:
- string
windowSize: string
ScheduledQueryRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ScheduledQueryRule resource accepts the following input properties:
- Criteria
This property is required. Pulumi.Azure Native. Insights. Inputs. Scheduled Query Rule Criteria - The rule criteria that defines the conditions of the scheduled query rule.
- Enabled
This property is required. bool - The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
- Resource
Group Name stringThis property is required. 
Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- Scopes
This property is required. List<string> - The list of resource id's that this scheduled query rule is scoped to.
- Actions
Pulumi.
Azure Native. Insights. Inputs. Actions - Actions to invoke when the alert fires.
- Auto
Mitigate bool - The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
- Check
Workspace boolAlerts Storage Configured - 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.
- Description string
- The description of the scheduled query rule.
- Display
Name string - The display name of the alert rule
- Evaluation
Frequency string - How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
- Identity
Pulumi.
Azure Native. Insights. Inputs. Identity - The identity of the resource.
- Kind
string | Pulumi.
Azure Native. Insights. Kind - Indicates the type of scheduled query rule. The default is LogAlert.
- Location
- The geo-location where the resource lives
- Mute
Actions stringDuration - 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.
- Override
Query stringTime Range - If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
- Resolve
Configuration Pulumi.Azure Native. Insights. Inputs. Rule Resolve Configuration - Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
- Rule
Name - The name of the rule.
- Severity double
- 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.
- Skip
Query boolValidation - 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.
- Dictionary<string, string>
- Resource tags.
- Target
Resource List<string>Types - 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
- Window
Size string - 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.
- Criteria
This property is required. ScheduledQuery Rule Criteria Args - The rule criteria that defines the conditions of the scheduled query rule.
- Enabled
This property is required. bool - The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
- Resource
Group Name stringThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- Scopes
This property is required. []string - The list of resource id's that this scheduled query rule is scoped to.
- Actions
Actions
Args - Actions to invoke when the alert fires.
- Auto
Mitigate bool - The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
- Check
Workspace boolAlerts Storage Configured - 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.
- Description string
- The description of the scheduled query rule.
- Display
Name string - The display name of the alert rule
- Evaluation
Frequency string - How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
- Identity
Identity
Args - The identity of the resource.
- Kind string | Kind
- Indicates the type of scheduled query rule. The default is LogAlert.
- Location
- The geo-location where the resource lives
- Mute
Actions stringDuration - 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.
- Override
Query stringTime Range - If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
- Resolve
Configuration RuleResolve Configuration Args - Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
- Rule
Name - The name of the rule.
- Severity float64
- 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.
- Skip
Query boolValidation - 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.
- map[string]string
- Resource tags.
- Target
Resource []stringTypes - 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
- Window
Size string - 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.
- criteria
This property is required. ScheduledQuery Rule Criteria - The rule criteria that defines the conditions of the scheduled query rule.
- enabled
This property is required. Boolean - The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
- resource
Group Name StringThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- scopes
This property is required. List<String> - The list of resource id's that this scheduled query rule is scoped to.
- actions Actions
- Actions to invoke when the alert fires.
- auto
Mitigate Boolean - The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
- check
Workspace BooleanAlerts Storage Configured - 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.
- description String
- The description of the scheduled query rule.
- display
Name String - The display name of the alert rule
- evaluation
Frequency String - How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
- identity Identity
- The identity of the resource.
- kind String | Kind
- Indicates the type of scheduled query rule. The default is LogAlert.
- location
- The geo-location where the resource lives
- mute
Actions StringDuration - 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.
- override
Query StringTime Range - If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
- resolve
Configuration RuleResolve Configuration - Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
- rule
Name - The name of the rule.
- severity Double
- 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.
- skip
Query BooleanValidation - 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.
- Map<String,String>
- Resource tags.
- target
Resource List<String>Types - 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
- window
Size String - 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.
- criteria
This property is required. ScheduledQuery Rule Criteria - The rule criteria that defines the conditions of the scheduled query rule.
- enabled
This property is required. boolean - The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
- resource
Group Name stringThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- scopes
This property is required. string[] - The list of resource id's that this scheduled query rule is scoped to.
- actions Actions
- Actions to invoke when the alert fires.
- auto
Mitigate boolean - The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
- check
Workspace booleanAlerts Storage Configured - 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.
- description string
- The description of the scheduled query rule.
- display
Name string - The display name of the alert rule
- evaluation
Frequency string - How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
- identity Identity
- The identity of the resource.
- kind string | Kind
- Indicates the type of scheduled query rule. The default is LogAlert.
- location
- The geo-location where the resource lives
- mute
Actions stringDuration - 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.
- override
Query stringTime Range - If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
- resolve
Configuration RuleResolve Configuration - Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
- rule
Name - The name of the rule.
- severity number
- 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.
- skip
Query booleanValidation - 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.
- {[key: string]: string}
- Resource tags.
- target
Resource string[]Types - 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
- window
Size string - 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.
- criteria
This property is required. ScheduledQuery Rule Criteria Args - The rule criteria that defines the conditions of the scheduled query rule.
- enabled
This property is required. bool - The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
- resource_
group_ name strThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- scopes
This property is required. Sequence[str] - The list of resource id's that this scheduled query rule is scoped to.
- actions
Actions
Args - Actions to invoke when the alert fires.
- auto_
mitigate bool - The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
- check_
workspace_ boolalerts_ storage_ configured - 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.
- description str
- The description of the scheduled query rule.
- display_
name str - The display name of the alert rule
- evaluation_
frequency str - How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
- identity
Identity
Args - The identity of the resource.
- kind str | Kind
- Indicates the type of scheduled query rule. The default is LogAlert.
- location
- The geo-location where the resource lives
- mute_
actions_ strduration - 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.
- override_
query_ strtime_ range - If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
- resolve_
configuration RuleResolve Configuration Args - Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
- rule_
name - The name of the rule.
- severity float
- 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.
- skip_
query_ boolvalidation - 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.
- Mapping[str, str]
- Resource tags.
- target_
resource_ Sequence[str]types - 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
- window_
size str - 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.
- criteria
This property is required. Property Map - The rule criteria that defines the conditions of the scheduled query rule.
- enabled
This property is required. Boolean - The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
- resource
Group Name StringThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- scopes
This property is required. List<String> - The list of resource id's that this scheduled query rule is scoped to.
- actions Property Map
- Actions to invoke when the alert fires.
- auto
Mitigate Boolean - The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
- check
Workspace BooleanAlerts Storage Configured - 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.
- description String
- The description of the scheduled query rule.
- display
Name String - The display name of the alert rule
- evaluation
Frequency String - How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
- identity Property Map
- The identity of the resource.
- kind
String | "Log
Alert" | "Log To Metric" - Indicates the type of scheduled query rule. The default is LogAlert.
- location
- The geo-location where the resource lives
- mute
Actions StringDuration - 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.
- override
Query StringTime Range - If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
- resolve
Configuration Property Map - Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
- rule
Name - The name of the rule.
- severity Number
- 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.
- skip
Query BooleanValidation - 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.
- Map<String>
- Resource tags.
- target
Resource List<String>Types - 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
- window
Size String - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the ScheduledQueryRule resource produces the following output properties:
- Created
With stringApi Version - The api-version used when creating this alert rule
- Etag string
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Legacy boolLog Analytics Rule - True if alert rule is legacy Log Analytic rule
- Is
Workspace boolAlerts Storage Configured - The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Insights. Outputs. System Data Response - SystemData of ScheduledQueryRule.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Created
With stringApi Version - The api-version used when creating this alert rule
- Etag string
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Legacy boolLog Analytics Rule - True if alert rule is legacy Log Analytic rule
- Is
Workspace boolAlerts Storage Configured - The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
- Name string
- The name of the resource
- System
Data SystemData Response - SystemData of ScheduledQueryRule.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- created
With StringApi Version - The api-version used when creating this alert rule
- etag String
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Legacy BooleanLog Analytics Rule - True if alert rule is legacy Log Analytic rule
- is
Workspace BooleanAlerts Storage Configured - The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
- name String
- The name of the resource
- system
Data SystemData Response - SystemData of ScheduledQueryRule.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- created
With stringApi Version - The api-version used when creating this alert rule
- etag string
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Legacy booleanLog Analytics Rule - True if alert rule is legacy Log Analytic rule
- is
Workspace booleanAlerts Storage Configured - The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
- name string
- The name of the resource
- system
Data SystemData Response - SystemData of ScheduledQueryRule.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- created_
with_ strapi_ version - The api-version used when creating this alert rule
- etag str
- 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.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
legacy_ boollog_ analytics_ rule - True if alert rule is legacy Log Analytic rule
- is_
workspace_ boolalerts_ storage_ configured - The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
- name str
- The name of the resource
- system_
data SystemData Response - SystemData of ScheduledQueryRule.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- created
With StringApi Version - The api-version used when creating this alert rule
- etag String
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Legacy BooleanLog Analytics Rule - True if alert rule is legacy Log Analytic rule
- is
Workspace BooleanAlerts Storage Configured - The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
- name String
- The name of the resource
- system
Data Property Map - SystemData of ScheduledQueryRule.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
Actions, ActionsArgs
, ActionsArgs
- Action
Groups List<string> - Action Group resource Ids to invoke when the alert fires.
- Action
Properties Dictionary<string, string> - The properties of an action properties.
- Custom
Properties Dictionary<string, string> - The properties of an alert payload.
- Action
Groups []string - Action Group resource Ids to invoke when the alert fires.
- Action
Properties map[string]string - The properties of an action properties.
- Custom
Properties map[string]string - The properties of an alert payload.
- action
Groups List<String> - Action Group resource Ids to invoke when the alert fires.
- action
Properties Map<String,String> - The properties of an action properties.
- custom
Properties Map<String,String> - The properties of an alert payload.
- action
Groups string[] - Action Group resource Ids to invoke when the alert fires.
- action
Properties {[key: string]: string} - The properties of an action properties.
- custom
Properties {[key: string]: string} - The properties of an alert payload.
- action_
groups Sequence[str] - Action Group resource Ids to invoke when the alert fires.
- action_
properties Mapping[str, str] - The properties of an action properties.
- custom_
properties Mapping[str, str] - The properties of an alert payload.
- action
Groups List<String> - Action Group resource Ids to invoke when the alert fires.
- action
Properties Map<String> - The properties of an action properties.
- custom
Properties Map<String> - The properties of an alert payload.
ActionsResponse, ActionsResponseArgs
, ActionsResponseArgs
- Action
Groups List<string> - Action Group resource Ids to invoke when the alert fires.
- Action
Properties Dictionary<string, string> - The properties of an action properties.
- Custom
Properties Dictionary<string, string> - The properties of an alert payload.
- Action
Groups []string - Action Group resource Ids to invoke when the alert fires.
- Action
Properties map[string]string - The properties of an action properties.
- Custom
Properties map[string]string - The properties of an alert payload.
- action
Groups List<String> - Action Group resource Ids to invoke when the alert fires.
- action
Properties Map<String,String> - The properties of an action properties.
- custom
Properties Map<String,String> - The properties of an alert payload.
- action
Groups string[] - Action Group resource Ids to invoke when the alert fires.
- action
Properties {[key: string]: string} - The properties of an action properties.
- custom
Properties {[key: string]: string} - The properties of an alert payload.
- action_
groups Sequence[str] - Action Group resource Ids to invoke when the alert fires.
- action_
properties Mapping[str, str] - The properties of an action properties.
- custom_
properties Mapping[str, str] - The properties of an alert payload.
- action
Groups List<String> - Action Group resource Ids to invoke when the alert fires.
- action
Properties Map<String> - The properties of an action properties.
- custom
Properties Map<String> - The properties of an alert payload.
Condition, ConditionArgs
, ConditionArgs
- Dimensions
List<Pulumi.
Azure Native. Insights. Inputs. Dimension> - List of Dimensions conditions
- Failing
Periods Pulumi.Azure Native. Insights. Inputs. Condition Failing Periods - 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.
- Metric
Measure stringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- Metric
Name string - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- Operator
string | Pulumi.
Azure Native. Insights. Condition Operator - The criteria operator. Relevant and required only for rules of the kind LogAlert.
- Query string
- Log query alert
- Resource
Id stringColumn - 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.
- Threshold double
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- Time
Aggregation string | Pulumi.Azure Native. Insights. Time Aggregation - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- Dimensions []Dimension
- List of Dimensions conditions
- Failing
Periods ConditionFailing Periods - 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.
- Metric
Measure stringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- Metric
Name string - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- Operator
string | Condition
Operator - The criteria operator. Relevant and required only for rules of the kind LogAlert.
- Query string
- Log query alert
- Resource
Id stringColumn - 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.
- Threshold float64
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- Time
Aggregation string | TimeAggregation - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- dimensions List<Dimension>
- List of Dimensions conditions
- failing
Periods ConditionFailing Periods - 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.
- metric
Measure StringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- metric
Name String - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- operator
String | Condition
Operator - The criteria operator. Relevant and required only for rules of the kind LogAlert.
- query String
- Log query alert
- resource
Id StringColumn - 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.
- threshold Double
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- time
Aggregation String | TimeAggregation - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- dimensions Dimension[]
- List of Dimensions conditions
- failing
Periods ConditionFailing Periods - 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.
- metric
Measure stringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- metric
Name string - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- operator
string | Condition
Operator - The criteria operator. Relevant and required only for rules of the kind LogAlert.
- query string
- Log query alert
- resource
Id stringColumn - 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.
- threshold number
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- time
Aggregation string | TimeAggregation - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- dimensions Sequence[Dimension]
- List of Dimensions conditions
- failing_
periods ConditionFailing Periods - 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.
- metric_
measure_ strcolumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- metric_
name str - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- operator
str | Condition
Operator - The criteria operator. Relevant and required only for rules of the kind LogAlert.
- query str
- Log query alert
- resource_
id_ strcolumn - 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.
- threshold float
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- time_
aggregation str | TimeAggregation - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- dimensions List<Property Map>
- List of Dimensions conditions
- failing
Periods Property Map - 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.
- metric
Measure StringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- metric
Name String - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- operator
String | "Equals" | "Greater
Than" | "Greater Than Or Equal" | "Less Than" | "Less Than Or Equal" - The criteria operator. Relevant and required only for rules of the kind LogAlert.
- query String
- Log query alert
- resource
Id StringColumn - 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.
- threshold Number
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- time
Aggregation String | "Count" | "Average" | "Minimum" | "Maximum" | "Total" - Aggregation type. Relevant and required only for rules of the kind LogAlert.
ConditionFailingPeriods, ConditionFailingPeriodsArgs
, ConditionFailingPeriodsArgs
- Min
Failing doublePeriods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- Number
Of doubleEvaluation Periods - 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
- Min
Failing float64Periods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- Number
Of float64Evaluation Periods - 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
- min
Failing DoublePeriods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- number
Of DoubleEvaluation Periods - 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
- min
Failing numberPeriods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- number
Of numberEvaluation Periods - 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
- min_
failing_ floatperiods_ to_ alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- number_
of_ floatevaluation_ periods - 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
- min
Failing NumberPeriods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- number
Of NumberEvaluation Periods - 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
ConditionOperator, ConditionOperatorArgs
, ConditionOperatorArgs
- Equals
Value - Equals
- Greater
Than - GreaterThan
- Greater
Than Or Equal - GreaterThanOrEqual
- Less
Than - LessThan
- Less
Than Or Equal - LessThanOrEqual
- Condition
Operator Equals - Equals
- Condition
Operator Greater Than - GreaterThan
- Condition
Operator Greater Than Or Equal - GreaterThanOrEqual
- Condition
Operator Less Than - LessThan
- Condition
Operator Less Than Or Equal - LessThanOrEqual
- Equals
- Equals
- Greater
Than - GreaterThan
- Greater
Than Or Equal - GreaterThanOrEqual
- Less
Than - LessThan
- Less
Than Or Equal - LessThanOrEqual
- Equals
- Equals
- Greater
Than - GreaterThan
- Greater
Than Or Equal - GreaterThanOrEqual
- Less
Than - LessThan
- Less
Than Or Equal - LessThanOrEqual
- EQUALS
- Equals
- GREATER_THAN
- GreaterThan
- GREATER_THAN_OR_EQUAL
- GreaterThanOrEqual
- LESS_THAN
- LessThan
- LESS_THAN_OR_EQUAL
- LessThanOrEqual
- "Equals"
- Equals
- "Greater
Than" - GreaterThan
- "Greater
Than Or Equal" - GreaterThanOrEqual
- "Less
Than" - LessThan
- "Less
Than Or Equal" - LessThanOrEqual
ConditionResponse, ConditionResponseArgs
, ConditionResponseArgs
- Dimensions
List<Pulumi.
Azure Native. Insights. Inputs. Dimension Response> - List of Dimensions conditions
- Failing
Periods Pulumi.Azure Native. Insights. Inputs. Condition Response Failing Periods - 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.
- Metric
Measure stringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- Metric
Name string - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- Operator string
- The criteria operator. Relevant and required only for rules of the kind LogAlert.
- Query string
- Log query alert
- Resource
Id stringColumn - 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.
- Threshold double
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- Time
Aggregation string - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- Dimensions
[]Dimension
Response - List of Dimensions conditions
- Failing
Periods ConditionResponse Failing Periods - 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.
- Metric
Measure stringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- Metric
Name string - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- Operator string
- The criteria operator. Relevant and required only for rules of the kind LogAlert.
- Query string
- Log query alert
- Resource
Id stringColumn - 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.
- Threshold float64
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- Time
Aggregation string - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- dimensions
List<Dimension
Response> - List of Dimensions conditions
- failing
Periods ConditionResponse Failing Periods - 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.
- metric
Measure StringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- metric
Name String - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- operator String
- The criteria operator. Relevant and required only for rules of the kind LogAlert.
- query String
- Log query alert
- resource
Id StringColumn - 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.
- threshold Double
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- time
Aggregation String - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- dimensions
Dimension
Response[] - List of Dimensions conditions
- failing
Periods ConditionResponse Failing Periods - 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.
- metric
Measure stringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- metric
Name string - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- operator string
- The criteria operator. Relevant and required only for rules of the kind LogAlert.
- query string
- Log query alert
- resource
Id stringColumn - 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.
- threshold number
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- time
Aggregation string - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- dimensions
Sequence[Dimension
Response] - List of Dimensions conditions
- failing_
periods ConditionResponse Failing Periods - 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.
- metric_
measure_ strcolumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- metric_
name str - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- operator str
- The criteria operator. Relevant and required only for rules of the kind LogAlert.
- query str
- Log query alert
- resource_
id_ strcolumn - 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.
- threshold float
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- time_
aggregation str - Aggregation type. Relevant and required only for rules of the kind LogAlert.
- dimensions List<Property Map>
- List of Dimensions conditions
- failing
Periods Property Map - 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.
- metric
Measure StringColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
- metric
Name String - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
- operator String
- The criteria operator. Relevant and required only for rules of the kind LogAlert.
- query String
- Log query alert
- resource
Id StringColumn - 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.
- threshold Number
- the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
- time
Aggregation String - Aggregation type. Relevant and required only for rules of the kind LogAlert.
ConditionResponseFailingPeriods, ConditionResponseFailingPeriodsArgs
, ConditionResponseFailingPeriodsArgs
- Min
Failing doublePeriods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- Number
Of doubleEvaluation Periods - 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
- Min
Failing float64Periods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- Number
Of float64Evaluation Periods - 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
- min
Failing DoublePeriods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- number
Of DoubleEvaluation Periods - 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
- min
Failing numberPeriods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- number
Of numberEvaluation Periods - 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
- min_
failing_ floatperiods_ to_ alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- number_
of_ floatevaluation_ periods - 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
- min
Failing NumberPeriods To Alert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
- number
Of NumberEvaluation Periods - 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
Dimension, DimensionArgs
, DimensionArgs
- Name
This property is required. string - Name of the dimension
- Operator
This property is required. string | Pulumi.Azure Native. Insights. Dimension Operator - Operator for dimension values
- Values
This property is required. List<string> - List of dimension values
- Name
This property is required. string - Name of the dimension
- Operator
This property is required. string | DimensionOperator - Operator for dimension values
- Values
This property is required. []string - List of dimension values
- name
This property is required. String - Name of the dimension
- operator
This property is required. String | DimensionOperator - Operator for dimension values
- values
This property is required. List<String> - List of dimension values
- name
This property is required. string - Name of the dimension
- operator
This property is required. string | DimensionOperator - Operator for dimension values
- values
This property is required. string[] - List of dimension values
- name
This property is required. str - Name of the dimension
- operator
This property is required. str | DimensionOperator - Operator for dimension values
- values
This property is required. Sequence[str] - List of dimension values
- name
This property is required. String - Name of the dimension
- operator
This property is required. String | "Include" | "Exclude" - Operator for dimension values
- values
This property is required. List<String> - List of dimension values
DimensionOperator, DimensionOperatorArgs
, DimensionOperatorArgs
- Include
- Include
- Exclude
- Exclude
- Dimension
Operator Include - Include
- Dimension
Operator Exclude - Exclude
- Include
- Include
- Exclude
- Exclude
- Include
- Include
- Exclude
- Exclude
- INCLUDE
- Include
- EXCLUDE
- Exclude
- "Include"
- Include
- "Exclude"
- Exclude
DimensionResponse, DimensionResponseArgs
, DimensionResponseArgs
Identity, IdentityArgs
, IdentityArgs
- Type
This property is required. Pulumi.Azure Native. Insights. Identity Type - Type of managed service identity.
- User
Assigned List<string>Identities - 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}'.
- Type
This property is required. IdentityType - Type of managed service identity.
- User
Assigned []stringIdentities - 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}'.
- type
This property is required. IdentityType - Type of managed service identity.
- user
Assigned List<String>Identities - 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}'.
- type
This property is required. IdentityType - Type of managed service identity.
- user
Assigned string[]Identities - 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}'.
- type
This property is required. IdentityType - Type of managed service identity.
- user_
assigned_ Sequence[str]identities - 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}'.
- type
This property is required. "SystemAssigned" | "User Assigned" | "None" - Type of managed service identity.
- user
Assigned List<String>Identities - 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}'.
IdentityResponse, IdentityResponseArgs
, IdentityResponseArgs
- Principal
Id This property is required. string - The principal ID of resource identity.
- Tenant
Id This property is required. string - The tenant ID of resource.
- Type
This property is required. string - Type of managed service identity.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Insights. Inputs. User Identity Properties Response> - 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}'.
- Principal
Id This property is required. string - The principal ID of resource identity.
- Tenant
Id This property is required. string - The tenant ID of resource.
- Type
This property is required. string - Type of managed service identity.
- User
Assigned map[string]UserIdentities Identity Properties Response - 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}'.
- principal
Id This property is required. String - The principal ID of resource identity.
- tenant
Id This property is required. String - The tenant ID of resource.
- type
This property is required. String - Type of managed service identity.
- user
Assigned Map<String,UserIdentities Identity Properties Response> - 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}'.
- principal
Id This property is required. string - The principal ID of resource identity.
- tenant
Id This property is required. string - The tenant ID of resource.
- type
This property is required. string - Type of managed service identity.
- user
Assigned {[key: string]: UserIdentities Identity Properties Response} - 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}'.
- principal_
id This property is required. str - The principal ID of resource identity.
- tenant_
id This property is required. str - The tenant ID of resource.
- type
This property is required. str - Type of managed service identity.
- user_
assigned_ Mapping[str, Useridentities Identity Properties Response] - 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}'.
- principal
Id This property is required. String - The principal ID of resource identity.
- tenant
Id This property is required. String - The tenant ID of resource.
- type
This property is required. String - Type of managed service identity.
- user
Assigned Map<Property Map>Identities - 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}'.
IdentityType, IdentityTypeArgs
, IdentityTypeArgs
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- None
- None
- Identity
Type System Assigned - SystemAssigned
- Identity
Type User Assigned - UserAssigned
- Identity
Type None - None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- None
- None
- SYSTEM_ASSIGNED
- SystemAssigned
- USER_ASSIGNED
- UserAssigned
- NONE
- None
- "System
Assigned" - SystemAssigned
- "User
Assigned" - UserAssigned
- "None"
- None
Kind, KindArgs
, KindArgs
- Log
Alert - LogAlert
- Log
To Metric - LogToMetric
- Kind
Log Alert - LogAlert
- Kind
Log To Metric - LogToMetric
- Log
Alert - LogAlert
- Log
To Metric - LogToMetric
- Log
Alert - LogAlert
- Log
To Metric - LogToMetric
- LOG_ALERT
- LogAlert
- LOG_TO_METRIC
- LogToMetric
- "Log
Alert" - LogAlert
- "Log
To Metric" - LogToMetric
RuleResolveConfiguration, RuleResolveConfigurationArgs
, RuleResolveConfigurationArgs
- Auto
Resolved bool - The flag that indicates whether or not to auto resolve a fired alert.
- Time
To stringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- Auto
Resolved bool - The flag that indicates whether or not to auto resolve a fired alert.
- Time
To stringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- auto
Resolved Boolean - The flag that indicates whether or not to auto resolve a fired alert.
- time
To StringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- auto
Resolved boolean - The flag that indicates whether or not to auto resolve a fired alert.
- time
To stringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- auto_
resolved bool - The flag that indicates whether or not to auto resolve a fired alert.
- time_
to_ strresolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- auto
Resolved Boolean - The flag that indicates whether or not to auto resolve a fired alert.
- time
To StringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
RuleResolveConfigurationResponse, RuleResolveConfigurationResponseArgs
, RuleResolveConfigurationResponseArgs
- Auto
Resolved bool - The flag that indicates whether or not to auto resolve a fired alert.
- Time
To stringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- Auto
Resolved bool - The flag that indicates whether or not to auto resolve a fired alert.
- Time
To stringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- auto
Resolved Boolean - The flag that indicates whether or not to auto resolve a fired alert.
- time
To StringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- auto
Resolved boolean - The flag that indicates whether or not to auto resolve a fired alert.
- time
To stringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- auto_
resolved bool - The flag that indicates whether or not to auto resolve a fired alert.
- time_
to_ strresolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
- auto
Resolved Boolean - The flag that indicates whether or not to auto resolve a fired alert.
- time
To StringResolve - The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.
ScheduledQueryRuleCriteria, ScheduledQueryRuleCriteriaArgs
, ScheduledQueryRuleCriteriaArgs
- All
Of List<Pulumi.Azure Native. Insights. Inputs. Condition> - A list of conditions to evaluate against the specified scopes
- All
Of []Condition - A list of conditions to evaluate against the specified scopes
- all
Of List<Condition> - A list of conditions to evaluate against the specified scopes
- all
Of Condition[] - A list of conditions to evaluate against the specified scopes
- all_
of Sequence[Condition] - A list of conditions to evaluate against the specified scopes
- all
Of List<Property Map> - A list of conditions to evaluate against the specified scopes
ScheduledQueryRuleCriteriaResponse, ScheduledQueryRuleCriteriaResponseArgs
, ScheduledQueryRuleCriteriaResponseArgs
- All
Of List<Pulumi.Azure Native. Insights. Inputs. Condition Response> - A list of conditions to evaluate against the specified scopes
- All
Of []ConditionResponse - A list of conditions to evaluate against the specified scopes
- all
Of List<ConditionResponse> - A list of conditions to evaluate against the specified scopes
- all
Of ConditionResponse[] - A list of conditions to evaluate against the specified scopes
- all_
of Sequence[ConditionResponse] - A list of conditions to evaluate against the specified scopes
- all
Of List<Property Map> - A list of conditions to evaluate against the specified scopes
SystemDataResponse, SystemDataResponseArgs
, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
TimeAggregation, TimeAggregationArgs
, TimeAggregationArgs
- Count
- Count
- Average
- Average
- Minimum
- Minimum
- Maximum
- Maximum
- Total
- Total
- Time
Aggregation Count - Count
- Time
Aggregation Average - Average
- Time
Aggregation Minimum - Minimum
- Time
Aggregation Maximum - Maximum
- Time
Aggregation Total - Total
- Count
- Count
- Average
- Average
- Minimum
- Minimum
- Maximum
- Maximum
- Total
- Total
- Count
- Count
- Average
- Average
- Minimum
- Minimum
- Maximum
- Maximum
- Total
- Total
- COUNT
- Count
- AVERAGE
- Average
- MINIMUM
- Minimum
- MAXIMUM
- Maximum
- TOTAL
- Total
- "Count"
- Count
- "Average"
- Average
- "Minimum"
- Minimum
- "Maximum"
- Maximum
- "Total"
- Total
UserIdentityPropertiesResponse, UserIdentityPropertiesResponseArgs
, UserIdentityPropertiesResponseArgs
- Client
Id This property is required. string - The client id of user assigned identity.
- Principal
Id This property is required. string - The principal id of user assigned identity.
- Client
Id This property is required. string - The client id of user assigned identity.
- Principal
Id This property is required. string - The principal id of user assigned identity.
- client
Id This property is required. String - The client id of user assigned identity.
- principal
Id This property is required. String - The principal id of user assigned identity.
- client
Id This property is required. string - The client id of user assigned identity.
- principal
Id This property is required. string - The principal id of user assigned identity.
- client_
id This property is required. str - The client id of user assigned identity.
- principal_
id This property is required. str - The principal id of user assigned identity.
- client
Id This property is required. String - The client id of user assigned identity.
- principal
Id This property is required. String - The principal id of user assigned identity.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:insights:ScheduledQueryRule perf /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
- Example Usage
- Create or update a scheduled query rule for Single Resource
- Create or update a scheduled query rule on Resource group(s)
- Create or update a scheduled query rule on Subscription
- Create ScheduledQueryRule Resource
- Constructor syntax
- Constructor example
- ScheduledQueryRule Resource Properties
- Inputs
- Outputs
- Supporting Types
- Import
- Package Details