Share via


MetricTrigger Class

Definition

The trigger that results in a scaling action.

public class MetricTrigger
type MetricTrigger = class
Public Class MetricTrigger
Inheritance
MetricTrigger

Constructors

MetricTrigger()

Initializes a new instance of the MetricTrigger class.

MetricTrigger(String, String, TimeSpan, MetricStatisticType, TimeSpan, TimeAggregationType, ComparisonOperationType, Double, String, String, IList<ScaleRuleMetricDimension>, Nullable<Boolean>)

Initializes a new instance of the MetricTrigger class.

Properties

Dimensions

Gets or sets list of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}].

DividePerInstance

Gets or sets a value indicating whether metric should divide per instance.

MetricName

Gets or sets the name of the metric that defines what the rule monitors.

MetricNamespace

Gets or sets the namespace of the metric that defines what the rule monitors.

MetricResourceLocation

Gets or sets the location of the resource the rule monitors.

MetricResourceUri

Gets or sets the resource identifier of the resource the rule monitors.

OperatorProperty

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

Statistic

Gets or sets the metric statistic type. How the metrics from multiple instances are combined. Possible values include: 'Average', 'Min', 'Max', 'Sum', 'Count'

Threshold

Gets or sets the threshold of the metric that triggers the scale action.

TimeAggregation

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

TimeGrain

Gets or sets the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute.

TimeWindow

Gets or sets the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes.

Methods

Validate()

Validate the object.

Applies to