Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricTrigger

Package version

The trigger that results in a scaling action.

Hierarchy

  • MetricTrigger

Index

Properties

Optional dimensions

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

Optional dividePerInstance

dividePerInstance: undefined | false | true

a value indicating whether metric should divide per instance.

metricName

metricName: string

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

Optional metricNamespace

metricNamespace: undefined | string

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

Optional metricResourceLocation

metricResourceLocation: undefined | string

the location of the resource the rule monitors.

metricResourceUri

metricResourceUri: string

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

threshold: number

the threshold of the metric that triggers the scale action.

timeAggregation

timeAggregation: TimeAggregationType

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

timeGrain

timeGrain: string

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

timeWindow: string

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.

Generated using TypeDoc