Share via

MetricTrigger interface

  • Reference
Package:
@azure/arm-monitor

The trigger that results in a scaling action.

Properties

dimensions

List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}].
dividePerInstance

a value indicating whether metric should divide per instance.
metricName

the name of the metric that defines what the rule monitors.
metricNamespace

the namespace of the metric that defines what the rule monitors.
metricResourceLocation

the location of the resource the rule monitors.
metricResourceUri

the resource identifier of the resource the rule monitors.
operator

the operator that is used to compare the metric data and the threshold.
statistic

the metric statistic type. How the metrics from multiple instances are combined.
threshold

the threshold of the metric that triggers the scale action.
timeAggregation

time aggregation type. How the data that is collected should be combined over time. The default value is Average.
timeGrain

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

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.

Property Details

dimensions

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

dimensions?: ScaleRuleMetricDimension[]

Property Value

ScaleRuleMetricDimension[]

dividePerInstance

a value indicating whether metric should divide per instance.

dividePerInstance?: boolean

Property Value

boolean

metricName

the name of the metric that defines what the rule monitors.

metricName: string

Property Value

string

metricNamespace

the namespace of the metric that defines what the rule monitors.

metricNamespace?: string

Property Value

string

metricResourceLocation

the location of the resource the rule monitors.

metricResourceLocation?: string

Property Value

string

metricResourceUri

the resource identifier of the resource the rule monitors.

metricResourceUri: string

Property Value

string

operator

the operator that is used to compare the metric data and the threshold.

operator: ComparisonOperationType

Property Value

ComparisonOperationType

statistic

the metric statistic type. How the metrics from multiple instances are combined.

statistic: MetricStatisticType

Property Value

MetricStatisticType

threshold

the threshold of the metric that triggers the scale action.

threshold: number

Property Value

number

timeAggregation

time aggregation type. How the data that is collected should be combined over time. The default value is Average.

timeAggregation: TimeAggregationType

Property Value

TimeAggregationType

timeGrain

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.

timeGrain: string

Property Value

string

timeWindow

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.

timeWindow: string

Property Value

string