Class ThresholdRuleCondition

A rule condition based on a metric crossing a threshold.

Inheritance

Object

RuleCondition

ThresholdRuleCondition

Inherited Members

RuleCondition.DataSource

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.Monitor.dll

Syntax

[Newtonsoft.Json.JsonObject("Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition")]
public class ThresholdRuleCondition : Microsoft.Azure.Management.Monitor.Models.RuleCondition

Constructors

ThresholdRuleCondition()

Initializes a new instance of the ThresholdRuleCondition class.

Declaration

public ThresholdRuleCondition ();

ThresholdRuleCondition(ConditionOperator, Double, RuleDataSource, Nullable<TimeSpan>, Nullable<TimeAggregationOperator>)

Initializes a new instance of the ThresholdRuleCondition class.

Declaration

public ThresholdRuleCondition (Microsoft.Azure.Management.Monitor.Models.ConditionOperator operatorProperty, double threshold, Microsoft.Azure.Management.Monitor.Models.RuleDataSource dataSource = null, Nullable<TimeSpan> windowSize = null, Nullable<Microsoft.Azure.Management.Monitor.Models.TimeAggregationOperator> timeAggregation = null);

Parameters

ConditionOperator operatorProperty the operator used to compare the data and the threshold. Possible values include: 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'

Double threshold the threshold value that activates the alert.

RuleDataSource dataSource the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.

Nullable<TimeSpan> windowSize the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.

Nullable<TimeAggregationOperator> timeAggregation the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric. Possible values include: 'Average', 'Minimum', 'Maximum', 'Total', 'Last'

Properties

OperatorProperty

Gets or sets the operator used to compare the data and the threshold. Possible values include: 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="operator")]
public Microsoft.Azure.Management.Monitor.Models.ConditionOperator OperatorProperty { get; set; }

Property Value

ConditionOperator

Threshold

Gets or sets the threshold value that activates the alert.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="threshold")]
public double Threshold { get; set; }

Property Value

Double

TimeAggregation

Gets or sets the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric. Possible values include: 'Average', 'Minimum', 'Maximum', 'Total', 'Last'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="timeAggregation")]
public Nullable<Microsoft.Azure.Management.Monitor.Models.TimeAggregationOperator> TimeAggregation { get; set; }

Property Value

Nullable<TimeAggregationOperator>

WindowSize

Gets or sets the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="windowSize")]
public Nullable<TimeSpan> WindowSize { get; set; }

Property Value

Nullable<TimeSpan>

Methods

Validate()

Validate the object.

Declaration

public virtual void Validate ();

Exceptions

ValidationException Thrown if validation fails