Share via

ScaleRule Interface

  • Reference
Package:
com.azure.resourcemanager.monitor.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-monitor:2.44.0

Implements

HasParent<AutoscaleProfile> HasInnerModel<ScaleRuleInner>

public interface ScaleRule
extends HasInnerModel<ScaleRuleInner>, HasParent<AutoscaleProfile>

An immutable client-side representation of an Azure autoscale profile scale rule.

Method Summary

Modifier and Type Method and Description
abstract ComparisonOperationType condition()

Get the operator that is used to compare the metric data and the threshold.
abstract Duration cooldown()

Get the amount of time to wait since the last scaling action before this action occurs.
abstract Duration duration()

Get the range of time in which instance data is collected.
abstract Duration frequency()

Get the granularity of metrics the rule monitors.
abstract MetricStatisticType frequencyStatistic()

Get the metric statistic type.
abstract String metricName()

Get the name of the metric that defines what the rule monitors.
abstract String metricSource()

Get the resource identifier of the resource the rule monitors.
abstract ScaleDirection scaleDirection()

Get the scale direction.
abstract int scaleInstanceCount()

Get the number of instances that are involved in the scaling action.
abstract ScaleType scaleType()

Get the type of action that should occur when the scale rule fires.
abstract double threshold()

Get the threshold of the metric that triggers the scale action.
abstract TimeAggregationType timeAggregation()

Get the time aggregation type.

Method Details

condition

public abstract ComparisonOperationType condition()

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

Returns:

the operator value

cooldown

public abstract Duration cooldown()

Get the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format.

Returns:

the cooldown value

duration

public abstract Duration duration()

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

Returns:

the timeWindow value

frequency

public abstract Duration frequency()

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

Returns:

the timeGrain value

frequencyStatistic

public abstract MetricStatisticType frequencyStatistic()

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

Returns:

the statistic value

metricName

public abstract String metricName()

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

Returns:

the metricName value

metricSource

public abstract String metricSource()

Get the resource identifier of the resource the rule monitors.

Returns:

the metricResourceUri value

scaleDirection

public abstract ScaleDirection scaleDirection()

Get the scale direction. Whether the scaling action increases or decreases the number of instances. Possible values include: 'None', 'Increase', 'Decrease'.

Returns:

the direction value

scaleInstanceCount

public abstract int scaleInstanceCount()

Get the number of instances that are involved in the scaling action.

Returns:

the value value

scaleType

public abstract ScaleType scaleType()

Get the type of action that should occur when the scale rule fires. Possible values include: 'ChangeCount', 'PercentChangeCount', 'ExactCount'.

Returns:

the type value

threshold

public abstract double threshold()

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

Returns:

the threshold value

timeAggregation

public abstract TimeAggregationType timeAggregation()

Get the 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'.

Returns:

the timeAggregation value

Applies to