Package com.azure.resourcemanager.monitor.models

Interface ScaleRule

All Superinterfaces:

HasInnerModel<ScaleRuleInner>, HasParent<AutoscaleProfile>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ScaleRule.Definition	The entirety of an autoscale profile scale rule definition.
static interface	ScaleRule.DefinitionStages	Grouping of autoscale profile scale rule definition stages.
static interface	ScaleRule.ParentUpdateDefinition	The entirety of an autoscale profile scale rule definition during parent Autoscale Profile definition in Autoscale Settings update stage.
static interface	ScaleRule.ParentUpdateDefinitionStages	Grouping of autoscale profile scale rule definition stages during definition of Autoscale Profile in the Autoscale update stage.
static interface	ScaleRule.Update	Grouping of scale rule update stages.
static interface	ScaleRule.UpdateDefinition	The entirety of an autoscale profile scale rule definition during parent Autoscale Profile update in Autoscale Settings update stage.
static interface	ScaleRule.UpdateDefinitionStages	Grouping of autoscale profile scale rule definition stages during update of Autoscale Profile in the Autoscale update stage.

Method Summary

Modifier and Type	Method	Description
ComparisonOperationType	condition()	Get the operator that is used to compare the metric data and the threshold.
Duration	cooldown()	Get the amount of time to wait since the last scaling action before this action occurs.
Duration	duration()	Get the range of time in which instance data is collected.
Duration	frequency()	Get the granularity of metrics the rule monitors.
MetricStatisticType	frequencyStatistic()	Get the metric statistic type.
String	metricName()	Get the name of the metric that defines what the rule monitors.
String	metricSource()	Get the resource identifier of the resource the rule monitors.
ScaleDirection	scaleDirection()	Get the scale direction.
int	scaleInstanceCount()	Get the number of instances that are involved in the scaling action.
ScaleType	scaleType()	Get the type of action that should occur when the scale rule fires.
double	threshold()	Get the threshold of the metric that triggers the scale action.
TimeAggregationType	timeAggregation()	Get the time aggregation type.

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent

parent

Method Detail

metricSource

String metricSource()

Get the resource identifier of the resource the rule monitors.

Returns:

the metricResourceUri value

metricName

String metricName()

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

Returns:

the metricName value

duration

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

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

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

condition

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

timeAggregation

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

threshold

double threshold()

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

Returns:

the threshold value

scaleDirection

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

scaleType

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

scaleInstanceCount

int scaleInstanceCount()

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

Returns:

the value value

cooldown

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