azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.monitor.models.ScaleRule.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.monitor.models.ScaleRule"
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule"
name: "ScaleRule"
nameWithType: "ScaleRule"
summary: "An immutable client-side representation of an Azure autoscale profile scale rule."
syntax: "public interface **ScaleRule**</br> extends <xref href=\"com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel?alt=com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel&text=HasInnerModel\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.monitor.fluent.models.ScaleRuleInner?alt=com.azure.resourcemanager.monitor.fluent.models.ScaleRuleInner&text=ScaleRuleInner\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent&text=HasParent\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.monitor.models.AutoscaleProfile?alt=com.azure.resourcemanager.monitor.models.AutoscaleProfile&text=AutoscaleProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.condition()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.condition()"
  name: "condition()"
  nameWithType: "ScaleRule.condition()"
  summary: "Get the operator that is used to compare the metric data and the threshold."
  modifiers:
  - "abstract"
  syntax: "public abstract ComparisonOperationType condition()"
  desc: "Get the operator that is used to compare the metric data and the threshold. Possible values include: 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'."
  returns:
    description: "the operator value"
    type: "<xref href=\"com.azure.resourcemanager.monitor.models.ComparisonOperationType?alt=com.azure.resourcemanager.monitor.models.ComparisonOperationType&text=ComparisonOperationType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.cooldown()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.cooldown()"
  name: "cooldown()"
  nameWithType: "ScaleRule.cooldown()"
  summary: "Get the amount of time to wait since the last scaling action before this action occurs."
  modifiers:
  - "abstract"
  syntax: "public abstract Duration cooldown()"
  desc: "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:
    description: "the cooldown value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.duration()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.duration()"
  name: "duration()"
  nameWithType: "ScaleRule.duration()"
  summary: "Get the range of time in which instance data is collected."
  modifiers:
  - "abstract"
  syntax: "public abstract Duration duration()"
  desc: "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:
    description: "the timeWindow value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.frequency()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.frequency()"
  name: "frequency()"
  nameWithType: "ScaleRule.frequency()"
  summary: "Get the granularity of metrics the rule monitors."
  modifiers:
  - "abstract"
  syntax: "public abstract Duration frequency()"
  desc: "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:
    description: "the timeGrain value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.frequencyStatistic()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.frequencyStatistic()"
  name: "frequencyStatistic()"
  nameWithType: "ScaleRule.frequencyStatistic()"
  summary: "Get the metric statistic type."
  modifiers:
  - "abstract"
  syntax: "public abstract MetricStatisticType frequencyStatistic()"
  desc: "Get the metric statistic type. How the metrics from multiple instances are combined. Possible values include: 'Average', 'Min', 'Max', 'Sum'."
  returns:
    description: "the statistic value"
    type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricStatisticType?alt=com.azure.resourcemanager.monitor.models.MetricStatisticType&text=MetricStatisticType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.metricName()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.metricName()"
  name: "metricName()"
  nameWithType: "ScaleRule.metricName()"
  summary: "Get the name of the metric that defines what the rule monitors."
  modifiers:
  - "abstract"
  syntax: "public abstract String metricName()"
  desc: "Get the name of the metric that defines what the rule monitors."
  returns:
    description: "the metricName value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.metricSource()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.metricSource()"
  name: "metricSource()"
  nameWithType: "ScaleRule.metricSource()"
  summary: "Get the resource identifier of the resource the rule monitors."
  modifiers:
  - "abstract"
  syntax: "public abstract String metricSource()"
  desc: "Get the resource identifier of the resource the rule monitors."
  returns:
    description: "the metricResourceUri value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.scaleDirection()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.scaleDirection()"
  name: "scaleDirection()"
  nameWithType: "ScaleRule.scaleDirection()"
  summary: "Get the scale direction."
  modifiers:
  - "abstract"
  syntax: "public abstract ScaleDirection scaleDirection()"
  desc: "Get the scale direction. Whether the scaling action increases or decreases the number of instances. Possible values include: 'None', 'Increase', 'Decrease'."
  returns:
    description: "the direction value"
    type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleDirection?alt=com.azure.resourcemanager.monitor.models.ScaleDirection&text=ScaleDirection\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.scaleInstanceCount()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.scaleInstanceCount()"
  name: "scaleInstanceCount()"
  nameWithType: "ScaleRule.scaleInstanceCount()"
  summary: "Get the number of instances that are involved in the scaling action."
  modifiers:
  - "abstract"
  syntax: "public abstract int scaleInstanceCount()"
  desc: "Get the number of instances that are involved in the scaling action."
  returns:
    description: "the value value"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.scaleType()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.scaleType()"
  name: "scaleType()"
  nameWithType: "ScaleRule.scaleType()"
  summary: "Get the type of action that should occur when the scale rule fires."
  modifiers:
  - "abstract"
  syntax: "public abstract ScaleType scaleType()"
  desc: "Get the type of action that should occur when the scale rule fires. Possible values include: 'ChangeCount', 'PercentChangeCount', 'ExactCount'."
  returns:
    description: "the type value"
    type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleType?alt=com.azure.resourcemanager.monitor.models.ScaleType&text=ScaleType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.threshold()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.threshold()"
  name: "threshold()"
  nameWithType: "ScaleRule.threshold()"
  summary: "Get the threshold of the metric that triggers the scale action."
  modifiers:
  - "abstract"
  syntax: "public abstract double threshold()"
  desc: "Get the threshold of the metric that triggers the scale action."
  returns:
    description: "the threshold value"
    type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.timeAggregation()"
  fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.timeAggregation()"
  name: "timeAggregation()"
  nameWithType: "ScaleRule.timeAggregation()"
  summary: "Get the time aggregation type."
  modifiers:
  - "abstract"
  syntax: "public abstract TimeAggregationType timeAggregation()"
  desc: "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:
    description: "the timeAggregation value"
    type: "<xref href=\"com.azure.resourcemanager.monitor.models.TimeAggregationType?alt=com.azure.resourcemanager.monitor.models.TimeAggregationType&text=TimeAggregationType\" data-throw-if-not-resolved=\"False\" />"
type: "interface"
desc: "An immutable client-side representation of an Azure autoscale profile scale rule."
implements:
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.HasParent&text=HasParent\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.monitor.models.AutoscaleProfile?alt=com.azure.resourcemanager.monitor.models.AutoscaleProfile&text=AutoscaleProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel?alt=com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel&text=HasInnerModel\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.monitor.fluent.models.ScaleRuleInner?alt=com.azure.resourcemanager.monitor.fluent.models.ScaleRuleInner&text=ScaleRuleInner\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.monitor.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-monitor:2.24.0