Class ScheduledQueryRulesAlert

Manages an AlertingAction Scheduled Query Rules resource within Azure Monitor.

Inheritance

System.Object

Resource

CustomResource

ScheduledQueryRulesAlert

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Monitoring

Assembly: Pulumi.Azure.dll

Syntax

public class ScheduledQueryRulesAlert : CustomResource

Constructors

ScheduledQueryRulesAlert(String, ScheduledQueryRulesAlertArgs, CustomResourceOptions)

Create a ScheduledQueryRulesAlert resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ScheduledQueryRulesAlertArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Action

An action block as defined below.

Declaration

public Output<ScheduledQueryRulesAlertAction> Action { get; }

Property Value

Type	Description
Output<ScheduledQueryRulesAlertAction>

AuthorizedResourceIds

List of Resource IDs referred into query.

Declaration

public Output<ImmutableArray<string>> AuthorizedResourceIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

DataSourceId

The resource URI over which log search query is to be run.

Declaration

public Output<string> DataSourceId { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the scheduled query rule.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Enabled

Whether this scheduled query rule is enabled. Default is true.

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Frequency

Frequency (in minutes) at which rule condition should be evaluated. Values must be between 5 and 1440 (inclusive).

Declaration

public Output<int> Frequency { get; }

Property Value

Type	Description
Output<System.Int32>

Location

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the scheduled query rule. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Query

Log search query.

Declaration

public Output<string> Query { get; }

Property Value

Type	Description
Output<System.String>

QueryType

Declaration

public Output<string> QueryType { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which to create the scheduled query rule instance.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Severity

Severity of the alert. Possible values include: 0, 1, 2, 3, or 4.

Declaration

public Output<int?> Severity { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Tags

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Throttling

Time (in minutes) for which Alerts should be throttled or suppressed. Values must be between 0 and 10000 (inclusive).

Declaration

public Output<int?> Throttling { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

TimeWindow

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).

Declaration

public Output<int> TimeWindow { get; }

Property Value

Type	Description
Output<System.Int32>

Trigger

The condition that results in the alert rule being run.

Declaration

public Output<ScheduledQueryRulesAlertTrigger> Trigger { get; }

Property Value

Type	Description
Output<ScheduledQueryRulesAlertTrigger>

Methods

Get(String, Input<String>, ScheduledQueryRulesAlertState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ScheduledQueryRulesAlertState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ScheduledQueryRulesAlert