GetScheduledQueryRulesAlert

Use this data source to access the properties of an AlertingAction scheduled query rule.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Monitoring.GetScheduledQueryRulesAlert.InvokeAsync(new Azure.Monitoring.GetScheduledQueryRulesAlertArgs
        {
            Name = "tfex-queryrule",
            ResourceGroupName = "example-rg",
        }));
        this.QueryRuleId = example.Apply(example => example.Id);
    }

    [Output("queryRuleId")]
    public Output<string> QueryRuleId { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/monitoring"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := monitoring.LookupScheduledQueryRulesAlert(ctx, &monitoring.LookupScheduledQueryRulesAlertArgs{
            Name:              "tfex-queryrule",
            ResourceGroupName: "example-rg",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("queryRuleId", example.Id)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.monitoring.get_scheduled_query_rules_alert(name="tfex-queryrule",
    resource_group_name="example-rg")
pulumi.export("queryRuleId", example.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.monitoring.getScheduledQueryRulesAlert({
    name: "tfex-queryrule",
    resourceGroupName: "example-rg",
}, { async: true }));

export const queryRuleId = example.id;

Using GetScheduledQueryRulesAlert

function getScheduledQueryRulesAlert(args: GetScheduledQueryRulesAlertArgs, opts?: InvokeOptions): Promise<GetScheduledQueryRulesAlertResult>

function  get_scheduled_query_rules_alert(name=None, resource_group_name=None, opts=None)

func LookupScheduledQueryRulesAlert(ctx *Context, args *LookupScheduledQueryRulesAlertArgs, opts ...InvokeOption) (*LookupScheduledQueryRulesAlertResult, error)

Note: This function is named LookupScheduledQueryRulesAlert in the Go SDK.

public static class GetScheduledQueryRulesAlert {
    public static Task<GetScheduledQueryRulesAlertResult> InvokeAsync(GetScheduledQueryRulesAlertArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: Specifies the name of the scheduled query rule.
ResourceGroupName string: Specifies the name of the resource group where the scheduled query rule is located.

Name string: Specifies the name of the scheduled query rule.
ResourceGroupName string: Specifies the name of the resource group where the scheduled query rule is located.

name string: Specifies the name of the scheduled query rule.
resourceGroupName string: Specifies the name of the resource group where the scheduled query rule is located.

name str: Specifies the name of the scheduled query rule.
resource_group_name str: Specifies the name of the resource group where the scheduled query rule is located.

GetScheduledQueryRulesAlert Result

The following output properties are available:

Actions List<GetScheduledQueryRulesAlertAction>: An action block as defined below.
AuthorizedResourceIds List<string>: List of Resource IDs referred into query.
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.
Frequency int: Frequency at which rule condition should be evaluated.
Id string: The provider-assigned unique ID for this managed resource.
Location string
Name string
Query string: Log search query.
QueryType string
ResourceGroupName string
Severity int: Severity of the alert.
Tags Dictionary<string, string>
Throttling int: Time for which alerts should be throttled or suppressed.
TimeWindow int: Time window for which data needs to be fetched for query.
Triggers List<GetScheduledQueryRulesAlertTrigger>: A trigger block as defined below.

Actions []GetScheduledQueryRulesAlertAction: An action block as defined below.
AuthorizedResourceIds []string: List of Resource IDs referred into query.
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.
Frequency int: Frequency at which rule condition should be evaluated.
Id string: The provider-assigned unique ID for this managed resource.
Location string
Name string
Query string: Log search query.
QueryType string
ResourceGroupName string
Severity int: Severity of the alert.
Tags map[string]string
Throttling int: Time for which alerts should be throttled or suppressed.
TimeWindow int: Time window for which data needs to be fetched for query.
Triggers []GetScheduledQueryRulesAlertTrigger: A trigger block as defined below.

actions GetScheduledQueryRulesAlertAction[]: An action block as defined below.
authorizedResourceIds string[]: List of Resource IDs referred into query.
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.
frequency number: Frequency at which rule condition should be evaluated.
id string: The provider-assigned unique ID for this managed resource.
location string
name string
query string: Log search query.
queryType string
resourceGroupName string
severity number: Severity of the alert.
tags {[key: string]: string}
throttling number: Time for which alerts should be throttled or suppressed.
timeWindow number: Time window for which data needs to be fetched for query.
triggers GetScheduledQueryRulesAlertTrigger[]: A trigger block as defined below.

actions List[GetScheduledQueryRulesAlertAction]: An action block as defined below.
authorized_resource_ids List[str]: List of Resource IDs referred into query.
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.
frequency float: Frequency at which rule condition should be evaluated.
id str: The provider-assigned unique ID for this managed resource.
location str
name str
query str: Log search query.
query_type str
resource_group_name str
severity float: Severity of the alert.
tags Dict[str, str]
throttling float: Time for which alerts should be throttled or suppressed.
time_window float: Time window for which data needs to be fetched for query.
triggers List[GetScheduledQueryRulesAlertTrigger]: A trigger block as defined below.

Supporting Types

GetScheduledQueryRulesAlertAction

See the output API doc for this type.

ActionGroups List<string>: List of action group reference resource IDs.
CustomWebhookPayload string: Custom payload to be sent for all webhook URI in Azure action group.
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 URI in Azure action group.
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 URI in Azure action group.
emailSubject string: Custom subject override for all email IDs in Azure action group.

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

GetScheduledQueryRulesAlertTrigger

See the output API doc for this type.

MetricTriggers List<GetScheduledQueryRulesAlertTriggerMetricTriggerArgs>
Operator string: Evaluation operation for rule.
Threshold double: Result or count threshold based on which rule should be triggered.

MetricTriggers []GetScheduledQueryRulesAlertTriggerMetricTrigger
Operator string: Evaluation operation for rule.
Threshold float64: Result or count threshold based on which rule should be triggered.

metricTriggers GetScheduledQueryRulesAlertTriggerMetricTrigger[]
operator string: Evaluation operation for rule.
threshold number: Result or count threshold based on which rule should be triggered.

metricTriggers List[GetScheduledQueryRulesAlertTriggerMetricTrigger]
operator str: Evaluation operation for rule.
threshold float: Result or count threshold based on which rule should be triggered.

GetScheduledQueryRulesAlertTriggerMetricTrigger

See the output API doc for this type.

MetricColumn string
MetricTriggerType string
Operator string: Evaluation operation for rule.
Threshold double: Result or count threshold based on which rule should be triggered.

MetricColumn string
MetricTriggerType string
Operator string: Evaluation operation for rule.
Threshold float64: Result or count threshold based on which rule should be triggered.

metricColumn string
metricTriggerType string
operator string: Evaluation operation for rule.
threshold number: Result or count threshold based on which rule should be triggered.

metricColumn str
metricTriggerType str
operator str: Evaluation operation for rule.
threshold float: Result or count threshold based on which rule should be triggered.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetScheduledQueryRulesAlert

Example Usage

Using GetScheduledQueryRulesAlert

GetScheduledQueryRulesAlert Result

Supporting Types

GetScheduledQueryRulesAlertAction

GetScheduledQueryRulesAlertTrigger

GetScheduledQueryRulesAlertTriggerMetricTrigger

Package Details

On This Page