Azure Classic v5.58.0, Dec 2 23

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

pulumi/pulumi-azure

azure.monitoring.ScheduledQueryRulesAlert

Explore with Pulumi AI

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

pulumi/pulumi-azure

Create ScheduledQueryRulesAlert Resource

new ScheduledQueryRulesAlert(name: string, args: ScheduledQueryRulesAlertArgs, opts?: CustomResourceOptions);

@overload
def ScheduledQueryRulesAlert(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             action: Optional[ScheduledQueryRulesAlertActionArgs] = None,
                             authorized_resource_ids: Optional[Sequence[str]] = None,
                             auto_mitigation_enabled: Optional[bool] = None,
                             data_source_id: Optional[str] = None,
                             description: Optional[str] = None,
                             enabled: Optional[bool] = None,
                             frequency: Optional[int] = None,
                             location: Optional[str] = None,
                             name: Optional[str] = None,
                             query: Optional[str] = None,
                             query_type: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             severity: Optional[int] = None,
                             tags: Optional[Mapping[str, str]] = None,
                             throttling: Optional[int] = None,
                             time_window: Optional[int] = None,
                             trigger: Optional[ScheduledQueryRulesAlertTriggerArgs] = None)
@overload
def ScheduledQueryRulesAlert(resource_name: str,
                             args: ScheduledQueryRulesAlertArgs,
                             opts: Optional[ResourceOptions] = None)

func NewScheduledQueryRulesAlert(ctx *Context, name string, args ScheduledQueryRulesAlertArgs, opts ...ResourceOption) (*ScheduledQueryRulesAlert, error)

public ScheduledQueryRulesAlert(string name, ScheduledQueryRulesAlertArgs args, CustomResourceOptions? opts = null)

public ScheduledQueryRulesAlert(String name, ScheduledQueryRulesAlertArgs args)
public ScheduledQueryRulesAlert(String name, ScheduledQueryRulesAlertArgs args, CustomResourceOptions options)

type: azure:monitoring:ScheduledQueryRulesAlert
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScheduledQueryRulesAlertArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ScheduledQueryRulesAlertArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ScheduledQueryRulesAlertArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScheduledQueryRulesAlertArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ScheduledQueryRulesAlertArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ScheduledQueryRulesAlert Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ScheduledQueryRulesAlert resource accepts the following input properties:

Action ScheduledQueryRulesAlertAction: An action block as defined below.
DataSourceId string: The resource URI over which log search query is to be run.
Frequency int: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
Query string: Log search query.
ResourceGroupName string: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
TimeWindow int: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
Trigger ScheduledQueryRulesAlertTrigger: A trigger block as defined below.
AuthorizedResourceIds List<string>: List of Resource IDs referred into query.
AutoMitigationEnabled bool: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
Description string: The description of the scheduled query rule.
Enabled bool: Whether this scheduled query rule is enabled. Default is true.
Location string: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
Name string: The name of the scheduled query rule. Changing this forces a new resource to be created.
QueryType string: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
Severity int: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Throttling int: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

Action ScheduledQueryRulesAlertActionArgs: An action block as defined below.
DataSourceId string: The resource URI over which log search query is to be run.
Frequency int: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
Query string: Log search query.
ResourceGroupName string: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
TimeWindow int: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
Trigger ScheduledQueryRulesAlertTriggerArgs: A trigger block as defined below.
AuthorizedResourceIds []string: List of Resource IDs referred into query.
AutoMitigationEnabled bool: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
Description string: The description of the scheduled query rule.
Enabled bool: Whether this scheduled query rule is enabled. Default is true.
Location string: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
Name string: The name of the scheduled query rule. Changing this forces a new resource to be created.
QueryType string: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
Severity int: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
Tags map[string]string: A mapping of tags to assign to the resource.
Throttling int: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

action ScheduledQueryRulesAlertAction: An action block as defined below.
dataSourceId String: The resource URI over which log search query is to be run.
frequency Integer: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
query String: Log search query.
resourceGroupName String: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
timeWindow Integer: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
trigger ScheduledQueryRulesAlertTrigger: A trigger block as defined below.
authorizedResourceIds List<String>: List of Resource IDs referred into query.
autoMitigationEnabled Boolean: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
description String: The description of the scheduled query rule.
enabled Boolean: Whether this scheduled query rule is enabled. Default is true.
location String: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
name String: The name of the scheduled query rule. Changing this forces a new resource to be created.
queryType String: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
severity Integer: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
tags Map<String,String>: A mapping of tags to assign to the resource.
throttling Integer: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

action ScheduledQueryRulesAlertAction: An action block as defined below.
dataSourceId string: The resource URI over which log search query is to be run.
frequency number: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
query string: Log search query.
resourceGroupName string: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
timeWindow number: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
trigger ScheduledQueryRulesAlertTrigger: A trigger block as defined below.
authorizedResourceIds string[]: List of Resource IDs referred into query.
autoMitigationEnabled boolean: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
description string: The description of the scheduled query rule.
enabled boolean: Whether this scheduled query rule is enabled. Default is true.
location string: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
name string: The name of the scheduled query rule. Changing this forces a new resource to be created.
queryType string: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
severity number: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
throttling number: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

action ScheduledQueryRulesAlertActionArgs: An action block as defined below.
data_source_id str: The resource URI over which log search query is to be run.
frequency int: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
query str: Log search query.
resource_group_name str: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
time_window int: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
trigger ScheduledQueryRulesAlertTriggerArgs: A trigger block as defined below.
authorized_resource_ids Sequence[str]: List of Resource IDs referred into query.
auto_mitigation_enabled bool: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
description str: The description of the scheduled query rule.
enabled bool: Whether this scheduled query rule is enabled. Default is true.
location str: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
name str: The name of the scheduled query rule. Changing this forces a new resource to be created.
query_type str: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
severity int: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
throttling int: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

action Property Map: An action block as defined below.
dataSourceId String: The resource URI over which log search query is to be run.
frequency Number: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
query String: Log search query.
resourceGroupName String: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
timeWindow Number: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
trigger Property Map: A trigger block as defined below.
authorizedResourceIds List<String>: List of Resource IDs referred into query.
autoMitigationEnabled Boolean: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
description String: The description of the scheduled query rule.
enabled Boolean: Whether this scheduled query rule is enabled. Default is true.
location String: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
name String: The name of the scheduled query rule. Changing this forces a new resource to be created.
queryType String: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
severity Number: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
tags Map<String>: A mapping of tags to assign to the resource.
throttling Number: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

Outputs

All input properties are implicitly available as output properties. Additionally, the ScheduledQueryRulesAlert resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ScheduledQueryRulesAlert Resource

Get an existing ScheduledQueryRulesAlert resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ScheduledQueryRulesAlertState, opts?: CustomResourceOptions): ScheduledQueryRulesAlert

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[ScheduledQueryRulesAlertActionArgs] = None,
        authorized_resource_ids: Optional[Sequence[str]] = None,
        auto_mitigation_enabled: Optional[bool] = None,
        data_source_id: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        frequency: Optional[int] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        query: Optional[str] = None,
        query_type: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        severity: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        throttling: Optional[int] = None,
        time_window: Optional[int] = None,
        trigger: Optional[ScheduledQueryRulesAlertTriggerArgs] = None) -> ScheduledQueryRulesAlert

func GetScheduledQueryRulesAlert(ctx *Context, name string, id IDInput, state *ScheduledQueryRulesAlertState, opts ...ResourceOption) (*ScheduledQueryRulesAlert, error)

public static ScheduledQueryRulesAlert Get(string name, Input<string> id, ScheduledQueryRulesAlertState? state, CustomResourceOptions? opts = null)

public static ScheduledQueryRulesAlert get(String name, Output<String> id, ScheduledQueryRulesAlertState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Action ScheduledQueryRulesAlertAction: An action block as defined below.
AuthorizedResourceIds List<string>: List of Resource IDs referred into query.
AutoMitigationEnabled bool: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
DataSourceId string: The resource URI over which log search query is to be run.
Description string: The description of the scheduled query rule.
Enabled bool: Whether this scheduled query rule is enabled. Default is true.
Frequency int: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
Location string: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
Name string: The name of the scheduled query rule. Changing this forces a new resource to be created.
Query string: Log search query.
QueryType string: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
ResourceGroupName string: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
Severity int: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Throttling int: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).
TimeWindow int: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
Trigger ScheduledQueryRulesAlertTrigger: A trigger block as defined below.

Action ScheduledQueryRulesAlertActionArgs: An action block as defined below.
AuthorizedResourceIds []string: List of Resource IDs referred into query.
AutoMitigationEnabled bool: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
DataSourceId string: The resource URI over which log search query is to be run.
Description string: The description of the scheduled query rule.
Enabled bool: Whether this scheduled query rule is enabled. Default is true.
Frequency int: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
Location string: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
Name string: The name of the scheduled query rule. Changing this forces a new resource to be created.
Query string: Log search query.
QueryType string: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
ResourceGroupName string: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
Severity int: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
Tags map[string]string: A mapping of tags to assign to the resource.
Throttling int: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).
TimeWindow int: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
Trigger ScheduledQueryRulesAlertTriggerArgs: A trigger block as defined below.

action ScheduledQueryRulesAlertAction: An action block as defined below.
authorizedResourceIds List<String>: List of Resource IDs referred into query.
autoMitigationEnabled Boolean: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
dataSourceId String: The resource URI over which log search query is to be run.
description String: The description of the scheduled query rule.
enabled Boolean: Whether this scheduled query rule is enabled. Default is true.
frequency Integer: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
location String: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
name String: The name of the scheduled query rule. Changing this forces a new resource to be created.
query String: Log search query.
queryType String: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
resourceGroupName String: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
severity Integer: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
tags Map<String,String>: A mapping of tags to assign to the resource.
throttling Integer: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).
timeWindow Integer: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
trigger ScheduledQueryRulesAlertTrigger: A trigger block as defined below.

action ScheduledQueryRulesAlertAction: An action block as defined below.
authorizedResourceIds string[]: List of Resource IDs referred into query.
autoMitigationEnabled boolean: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
dataSourceId string: The resource URI over which log search query is to be run.
description string: The description of the scheduled query rule.
enabled boolean: Whether this scheduled query rule is enabled. Default is true.
frequency number: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
location string: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
name string: The name of the scheduled query rule. Changing this forces a new resource to be created.
query string: Log search query.
queryType string: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
resourceGroupName string: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
severity number: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
throttling number: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).
timeWindow number: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
trigger ScheduledQueryRulesAlertTrigger: A trigger block as defined below.

action ScheduledQueryRulesAlertActionArgs: An action block as defined below.
authorized_resource_ids Sequence[str]: List of Resource IDs referred into query.
auto_mitigation_enabled bool: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
data_source_id str: The resource URI over which log search query is to be run.
description str: The description of the scheduled query rule.
enabled bool: Whether this scheduled query rule is enabled. Default is true.
frequency int: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
location str: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
name str: The name of the scheduled query rule. Changing this forces a new resource to be created.
query str: Log search query.
query_type str: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
resource_group_name str: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
severity int: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
throttling int: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).
time_window int: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
trigger ScheduledQueryRulesAlertTriggerArgs: A trigger block as defined below.

action Property Map: An action block as defined below.
authorizedResourceIds List<String>: List of Resource IDs referred into query.
autoMitigationEnabled Boolean: Should the alerts in this Metric Alert be auto resolved? Defaults to false.
NOTE auto_mitigation_enabled and throttling are mutually exclusive and cannot both be set.
dataSourceId String: The resource URI over which log search query is to be run.
description String: The description of the scheduled query rule.
enabled Boolean: Whether this scheduled query rule is enabled. Default is true.
frequency Number: Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).
location String: Specifies the Azure Region where the resource should exist. Changing this forces a new resource to be created.
name String: The name of the scheduled query rule. Changing this forces a new resource to be created.
query String: Log search query.
queryType String: The type of query results. Possible values are ResultCount and Number. Default is ResultCount. If set to ResultCount, query must include an AggregatedValue column of a numeric type, for example, Heartbeat | summarize AggregatedValue = count() by bin(TimeGenerated, 5m).
resourceGroupName String: The name of the resource group in which to create the scheduled query rule instance. Changing this forces a new resource to be created.
severity Number: Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.
tags Map<String>: A mapping of tags to assign to the resource.
throttling Number: Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).
timeWindow Number: Time window for which data needs to be fetched for query (must be greater than or equal to frequency). Values must be between 5 and 2880 (inclusive).
trigger Property Map: A trigger block as defined below.

Supporting Types

ScheduledQueryRulesAlertAction, ScheduledQueryRulesAlertActionArgs

ActionGroups List<string>: List of action group reference resource IDs.
CustomWebhookPayload string: Custom payload to be sent for all webhook payloads in alerting action.
EmailSubject string: Custom subject override for all email ids in Azure action group.

ActionGroups []string: List of action group reference resource IDs.
CustomWebhookPayload string: Custom payload to be sent for all webhook payloads in alerting action.
EmailSubject string: Custom subject override for all email ids in Azure action group.

actionGroups List<String>: List of action group reference resource IDs.
customWebhookPayload String: Custom payload to be sent for all webhook payloads in alerting action.
emailSubject String: Custom subject override for all email ids in Azure action group.

actionGroups string[]: List of action group reference resource IDs.
customWebhookPayload string: Custom payload to be sent for all webhook payloads in alerting action.
emailSubject string: Custom subject override for all email ids in Azure action group.

action_groups Sequence[str]: List of action group reference resource IDs.
custom_webhook_payload str: Custom payload to be sent for all webhook payloads in alerting action.
email_subject str: Custom subject override for all email ids in Azure action group.

actionGroups List<String>: List of action group reference resource IDs.
customWebhookPayload String: Custom payload to be sent for all webhook payloads in alerting action.
emailSubject String: Custom subject override for all email ids in Azure action group.

ScheduledQueryRulesAlertTrigger, ScheduledQueryRulesAlertTriggerArgs

Operator string: Evaluation operation for rule - 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
Threshold double: Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.
MetricTrigger ScheduledQueryRulesAlertTriggerMetricTrigger: A metric_trigger block as defined above. Trigger condition for metric query rule.

Operator string: Evaluation operation for rule - 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
Threshold float64: Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.
MetricTrigger ScheduledQueryRulesAlertTriggerMetricTrigger: A metric_trigger block as defined above. Trigger condition for metric query rule.

operator String: Evaluation operation for rule - 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
threshold Double: Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.
metricTrigger ScheduledQueryRulesAlertTriggerMetricTrigger: A metric_trigger block as defined above. Trigger condition for metric query rule.

operator string: Evaluation operation for rule - 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
threshold number: Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.
metricTrigger ScheduledQueryRulesAlertTriggerMetricTrigger: A metric_trigger block as defined above. Trigger condition for metric query rule.

operator str: Evaluation operation for rule - 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
threshold float: Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.
metric_trigger ScheduledQueryRulesAlertTriggerMetricTrigger: A metric_trigger block as defined above. Trigger condition for metric query rule.

operator String: Evaluation operation for rule - 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
threshold Number: Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.
metricTrigger Property Map: A metric_trigger block as defined above. Trigger condition for metric query rule.

ScheduledQueryRulesAlertTriggerMetricTrigger, ScheduledQueryRulesAlertTriggerMetricTriggerArgs

MetricTriggerType string: Metric Trigger Type - 'Consecutive' or 'Total'.
Operator string: Evaluation operation for rule - 'Equal', 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
Threshold double: The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.
MetricColumn string: Evaluation of metric on a particular column.

MetricTriggerType string: Metric Trigger Type - 'Consecutive' or 'Total'.
Operator string: Evaluation operation for rule - 'Equal', 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
Threshold float64: The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.
MetricColumn string: Evaluation of metric on a particular column.

metricTriggerType String: Metric Trigger Type - 'Consecutive' or 'Total'.
operator String: Evaluation operation for rule - 'Equal', 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
threshold Double: The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.
metricColumn String: Evaluation of metric on a particular column.

metricTriggerType string: Metric Trigger Type - 'Consecutive' or 'Total'.
operator string: Evaluation operation for rule - 'Equal', 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
threshold number: The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.
metricColumn string: Evaluation of metric on a particular column.

metric_trigger_type str: Metric Trigger Type - 'Consecutive' or 'Total'.
operator str: Evaluation operation for rule - 'Equal', 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
threshold float: The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.
metric_column str: Evaluation of metric on a particular column.

metricTriggerType String: Metric Trigger Type - 'Consecutive' or 'Total'.
operator String: Evaluation operation for rule - 'Equal', 'GreaterThan', GreaterThanOrEqual', 'LessThan', or 'LessThanOrEqual'.
threshold Number: The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.
metricColumn String: Evaluation of metric on a particular column.

Import

Scheduled Query Rule Alerts can be imported using the resource id, e.g.

 $ pulumi import azure:monitoring/scheduledQueryRulesAlert:ScheduledQueryRulesAlert example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Insights/scheduledQueryRules/myrulename

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

pulumi/pulumi-azure

azure.monitoring.ScheduledQueryRulesAlert

On this page

On this page

Create ScheduledQueryRulesAlert Resource

ScheduledQueryRulesAlert Resource Properties

Inputs

Outputs

Look up Existing ScheduledQueryRulesAlert Resource

Supporting Types

ScheduledQueryRulesAlertAction, ScheduledQueryRulesAlertActionArgs

ScheduledQueryRulesAlertTrigger, ScheduledQueryRulesAlertTriggerArgs

ScheduledQueryRulesAlertTriggerMetricTrigger, ScheduledQueryRulesAlertTriggerMetricTriggerArgs

Import

Package Details

On this page

On this page