Azure Classic
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
{
ResourceGroupName = "example-rg",
Name = "tfex-queryrule",
}));
this.QueryRuleId = example.Apply(example => example.Id);
}
[Output("queryRuleId")]
public Output<string> QueryRuleId { get; set; }
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := monitoring.LookupScheduledQueryRulesAlert(ctx, &monitoring.LookupScheduledQueryRulesAlertArgs{
ResourceGroupName: "example-rg",
Name: "tfex-queryrule",
}, nil)
if err != nil {
return err
}
ctx.Export("queryRuleId", example.Id)
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = Output.of(MonitoringFunctions.getScheduledQueryRulesAlert(GetScheduledQueryRulesAlertArgs.builder()
.resourceGroupName("example-rg")
.name("tfex-queryrule")
.build()));
ctx.export("queryRuleId", example.apply(getScheduledQueryRulesAlertResult -> getScheduledQueryRulesAlertResult.getId()));
}
}
import pulumi
import pulumi_azure as azure
example = azure.monitoring.get_scheduled_query_rules_alert(resource_group_name="example-rg",
name="tfex-queryrule")
pulumi.export("queryRuleId", example.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.monitoring.getScheduledQueryRulesAlert({
resourceGroupName: "example-rg",
name: "tfex-queryrule",
});
export const queryRuleId = example.then(example => example.id);
variables:
example:
Fn::Invoke:
Function: azure:monitoring:getScheduledQueryRulesAlert
Arguments:
resourceGroupName: example-rg
name: tfex-queryrule
outputs:
queryRuleId: ${example.id}
Using getScheduledQueryRulesAlert
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getScheduledQueryRulesAlert(args: GetScheduledQueryRulesAlertArgs, opts?: InvokeOptions): Promise<GetScheduledQueryRulesAlertResult>
function getScheduledQueryRulesAlertOutput(args: GetScheduledQueryRulesAlertOutputArgs, opts?: InvokeOptions): Output<GetScheduledQueryRulesAlertResult>
def get_scheduled_query_rules_alert(name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetScheduledQueryRulesAlertResult
def get_scheduled_query_rules_alert_output(name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetScheduledQueryRulesAlertResult]
func LookupScheduledQueryRulesAlert(ctx *Context, args *LookupScheduledQueryRulesAlertArgs, opts ...InvokeOption) (*LookupScheduledQueryRulesAlertResult, error)
func LookupScheduledQueryRulesAlertOutput(ctx *Context, args *LookupScheduledQueryRulesAlertOutputArgs, opts ...InvokeOption) LookupScheduledQueryRulesAlertResultOutput
> Note: This function is named LookupScheduledQueryRulesAlert
in the Go SDK.
public static class GetScheduledQueryRulesAlert
{
public static Task<GetScheduledQueryRulesAlertResult> InvokeAsync(GetScheduledQueryRulesAlertArgs args, InvokeOptions? opts = null)
public static Output<GetScheduledQueryRulesAlertResult> Invoke(GetScheduledQueryRulesAlertInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetScheduledQueryRulesAlertResult> getScheduledQueryRulesAlert(GetScheduledQueryRulesAlertArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: azure:monitoring/getScheduledQueryRulesAlert:getScheduledQueryRulesAlert
Arguments:
# Arguments dictionary
The following arguments are supported:
- Name string
Specifies the name of the scheduled query rule.
- Resource
Group stringName Specifies the name of the resource group where the scheduled query rule is located.
- Name string
Specifies the name of the scheduled query rule.
- Resource
Group stringName Specifies the name of the resource group where the scheduled query rule is located.
- name String
Specifies the name of the scheduled query rule.
- resource
Group StringName Specifies the name of the resource group where the scheduled query rule is located.
- name string
Specifies the name of the scheduled query rule.
- resource
Group stringName 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_ strname Specifies the name of the resource group where the scheduled query rule is located.
- name String
Specifies the name of the scheduled query rule.
- resource
Group StringName Specifies the name of the resource group where the scheduled query rule is located.
getScheduledQueryRulesAlert Result
The following output properties are available:
- Actions
List<Get
Scheduled Query Rules Alert Action> An
action
block as defined below.- List<string>
The list of Resource IDs referred into query.
- Data
Source stringId 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.
- Query
Type string - Resource
Group stringName - Severity int
Severity of the alert.
- Dictionary<string, string>
- Throttling int
Time for which alerts should be throttled or suppressed.
- Time
Window int Time window for which data needs to be fetched for query.
- Triggers
List<Get
Scheduled Query Rules Alert Trigger> A
trigger
block as defined below.
- Actions
[]Get
Scheduled Query Rules Alert Action An
action
block as defined below.- []string
The list of Resource IDs referred into query.
- Data
Source stringId 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.
- Query
Type string - Resource
Group stringName - Severity int
Severity of the alert.
- map[string]string
- Throttling int
Time for which alerts should be throttled or suppressed.
- Time
Window int Time window for which data needs to be fetched for query.
- Triggers
[]Get
Scheduled Query Rules Alert Trigger A
trigger
block as defined below.
- actions
List
Scheduled Query Rules Alert Action> An
action
block as defined below.- List
The list of Resource IDs referred into query.
- data
Source StringId 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 Integer
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.
- query
Type String - resource
Group StringName - severity Integer
Severity of the alert.
- Map
- throttling Integer
Time for which alerts should be throttled or suppressed.
- time
Window Integer Time window for which data needs to be fetched for query.
- triggers
List
Scheduled Query Rules Alert Trigger> A
trigger
block as defined below.
- actions
Get
Scheduled Query Rules Alert Action[] An
action
block as defined below.- string[]
The list of Resource IDs referred into query.
- data
Source stringId 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.
- query
Type string - resource
Group stringName - severity number
Severity of the alert.
- {[key: string]: string}
- throttling number
Time for which alerts should be throttled or suppressed.
- time
Window number Time window for which data needs to be fetched for query.
- triggers
Get
Scheduled Query Rules Alert Trigger[] A
trigger
block as defined below.
- actions
Sequence[Get
Scheduled Query Rules Alert Action] An
action
block as defined below.- Sequence[str]
The list of Resource IDs referred into query.
- data_
source_ strid 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 int
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_ strname - severity int
Severity of the alert.
- Mapping[str, str]
- throttling int
Time for which alerts should be throttled or suppressed.
- time_
window int Time window for which data needs to be fetched for query.
- triggers
Sequence[Get
Scheduled Query Rules Alert Trigger] A
trigger
block as defined below.
- actions
List
An
action
block as defined below.- List
The list of Resource IDs referred into query.
- data
Source StringId 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.
- query
Type String - resource
Group StringName - severity Number
Severity of the alert.
- Map
- throttling Number
Time for which alerts should be throttled or suppressed.
- time
Window Number Time window for which data needs to be fetched for query.
- triggers
List
A
trigger
block as defined below.
Supporting Types
GetScheduledQueryRulesAlertAction
- Action
Groups List<string> List of action group reference resource IDs.
- Custom
Webhook stringPayload Custom payload to be sent for all webhook URI in Azure action group.
- Email
Subject string Custom subject override for all email IDs in Azure action group.
- Action
Groups []string List of action group reference resource IDs.
- Custom
Webhook stringPayload Custom payload to be sent for all webhook URI in Azure action group.
- Email
Subject string Custom subject override for all email IDs in Azure action group.
- action
Groups List List of action group reference resource IDs.
- custom
Webhook StringPayload Custom payload to be sent for all webhook URI in Azure action group.
- email
Subject String Custom subject override for all email IDs in Azure action group.
- action
Groups string[] List of action group reference resource IDs.
- custom
Webhook stringPayload Custom payload to be sent for all webhook URI in Azure action group.
- email
Subject 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_ strpayload Custom payload to be sent for all webhook URI in Azure action group.
- email_
subject str Custom subject override for all email IDs in Azure action group.
- action
Groups List List of action group reference resource IDs.
- custom
Webhook StringPayload Custom payload to be sent for all webhook URI in Azure action group.
- email
Subject String Custom subject override for all email IDs in Azure action group.
GetScheduledQueryRulesAlertTrigger
- Metric
Triggers List<GetScheduled Query Rules Alert Trigger Metric Trigger> - Operator string
Evaluation operation for rule.
- Threshold double
Result or count threshold based on which rule should be triggered.
- Metric
Triggers []GetScheduled Query Rules Alert Trigger Metric Trigger - Operator string
Evaluation operation for rule.
- Threshold float64
Result or count threshold based on which rule should be triggered.
- metric
Triggers ListScheduled Query Rules Alert Trigger Metric Trigger> - operator String
Evaluation operation for rule.
- threshold Double
Result or count threshold based on which rule should be triggered.
- metric
Triggers GetScheduled Query Rules Alert Trigger Metric Trigger[] - operator string
Evaluation operation for rule.
- threshold number
Result or count threshold based on which rule should be triggered.
- metric_
triggers Sequence[GetScheduled Query Rules Alert Trigger Metric Trigger] - operator str
Evaluation operation for rule.
- threshold float
Result or count threshold based on which rule should be triggered.
- metric
Triggers List - operator String
Evaluation operation for rule.
- threshold Number
Result or count threshold based on which rule should be triggered.
GetScheduledQueryRulesAlertTriggerMetricTrigger
- Metric
Column string - Metric
Trigger stringType - Operator string
Evaluation operation for rule.
- Threshold double
Result or count threshold based on which rule should be triggered.
- Metric
Column string - Metric
Trigger stringType - Operator string
Evaluation operation for rule.
- Threshold float64
Result or count threshold based on which rule should be triggered.
- metric
Column String - metric
Trigger StringType - operator String
Evaluation operation for rule.
- threshold Double
Result or count threshold based on which rule should be triggered.
- metric
Column string - metric
Trigger stringType - operator string
Evaluation operation for rule.
- threshold number
Result or count threshold based on which rule should be triggered.
- metric_
column str - metric_
trigger_ strtype - operator str
Evaluation operation for rule.
- threshold float
Result or count threshold based on which rule should be triggered.
- metric
Column String - metric
Trigger StringType - operator String
Evaluation operation for rule.
- threshold Number
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.