164 строки
14 KiB
YAML
164 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update"
|
|
name: "ScaleRule.Update"
|
|
nameWithType: "ScaleRule.Update"
|
|
summary: "Grouping of scale rule update stages."
|
|
syntax: "public static interface **ScaleRule.Update**</br> extends <xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Settable?alt=com.azure.resourcemanager.resources.fluentcore.model.Settable&text=Settable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.monitor.models.AutoscaleProfile.Update?alt=com.azure.resourcemanager.monitor.models.AutoscaleProfile.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withCondition(com.azure.resourcemanager.monitor.models.TimeAggregationType,com.azure.resourcemanager.monitor.models.ComparisonOperationType,double)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withCondition(TimeAggregationType timeAggregation, ComparisonOperationType condition, double threshold)"
|
|
name: "withCondition(TimeAggregationType timeAggregation, ComparisonOperationType condition, double threshold)"
|
|
nameWithType: "ScaleRule.Update.withCondition(TimeAggregationType timeAggregation, ComparisonOperationType condition, double threshold)"
|
|
summary: "Updates the condition to monitor for the current metric alert."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the time aggregation type. How the data that is collected should be combined over\n time. The default value is Average. Possible values include: 'Average', 'Minimum', 'Maximum', 'Total',\n 'Count'."
|
|
name: "timeAggregation"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.TimeAggregationType?alt=com.azure.resourcemanager.monitor.models.TimeAggregationType&text=TimeAggregationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the operator that is used to compare the metric data and the threshold. Possible values\n include: 'Equals', 'NotEquals', 'GreaterThan', 'GreaterThanOrEqual', 'LessThan', 'LessThanOrEqual'."
|
|
name: "condition"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ComparisonOperationType?alt=com.azure.resourcemanager.monitor.models.ComparisonOperationType&text=ComparisonOperationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the threshold of the metric that triggers the scale action."
|
|
name: "threshold"
|
|
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract ScaleRule.Update withCondition(TimeAggregationType timeAggregation, ComparisonOperationType condition, double threshold)"
|
|
desc: "Updates the condition to monitor for the current metric alert."
|
|
returns:
|
|
description: "the next stage of the scale rule update."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRule.Update?alt=com.azure.resourcemanager.monitor.models.ScaleRule.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withMetricName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withMetricName(String metricName)"
|
|
name: "withMetricName(String metricName)"
|
|
nameWithType: "ScaleRule.Update.withMetricName(String metricName)"
|
|
summary: "the name of the metric that defines what the rule monitors."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "metricName name of the metric."
|
|
name: "metricName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract ScaleRule.Update withMetricName(String metricName)"
|
|
desc: "the name of the metric that defines what the rule monitors."
|
|
returns:
|
|
description: "the next stage of the scale rule update."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRule.Update?alt=com.azure.resourcemanager.monitor.models.ScaleRule.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withMetricSource(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withMetricSource(String metricSourceResourceId)"
|
|
name: "withMetricSource(String metricSourceResourceId)"
|
|
nameWithType: "ScaleRule.Update.withMetricSource(String metricSourceResourceId)"
|
|
summary: "Updates the resource identifier of the resource the rule monitors."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "resourceId of the resource."
|
|
name: "metricSourceResourceId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract ScaleRule.Update withMetricSource(String metricSourceResourceId)"
|
|
desc: "Updates the resource identifier of the resource the rule monitors."
|
|
returns:
|
|
description: "the next stage of the scale rule update."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRule.Update?alt=com.azure.resourcemanager.monitor.models.ScaleRule.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withScaleAction(com.azure.resourcemanager.monitor.models.ScaleDirection,com.azure.resourcemanager.monitor.models.ScaleType,int,java.time.Duration)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withScaleAction(ScaleDirection direction, ScaleType type, int instanceCountChange, Duration cooldown)"
|
|
name: "withScaleAction(ScaleDirection direction, ScaleType type, int instanceCountChange, Duration cooldown)"
|
|
nameWithType: "ScaleRule.Update.withScaleAction(ScaleDirection direction, ScaleType type, int instanceCountChange, Duration cooldown)"
|
|
summary: "Updates the action to be performed when the scale rule will be active."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the scale direction. Whether the scaling action increases or decreases the number of\n instances. Possible values include: 'None', 'Increase', 'Decrease'."
|
|
name: "direction"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleDirection?alt=com.azure.resourcemanager.monitor.models.ScaleDirection&text=ScaleDirection\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the type of action that should occur when the scale rule fires. Possible values include:\n 'ChangeCount', 'PercentChangeCount', 'ExactCount'."
|
|
name: "type"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleType?alt=com.azure.resourcemanager.monitor.models.ScaleType&text=ScaleType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the number of instances that are involved in the scaling action."
|
|
name: "instanceCountChange"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the amount of time to wait since the last scaling action before this action occurs. It must\n be between 1 week and 1 minute in ISO 8601 format."
|
|
name: "cooldown"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public abstract ScaleRule.Update withScaleAction(ScaleDirection direction, ScaleType type, int instanceCountChange, Duration cooldown)"
|
|
desc: "Updates the action to be performed when the scale rule will be active."
|
|
returns:
|
|
description: "the next stage of the scale rule update."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRule.Update?alt=com.azure.resourcemanager.monitor.models.ScaleRule.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withStatistic()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withStatistic()"
|
|
name: "withStatistic()"
|
|
nameWithType: "ScaleRule.Update.withStatistic()"
|
|
summary: "Sets statistics for autoscale trigger action with default values of 10 minutes for duration, 1 minute for frequency(time grain) and 'Average' for statistic type."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract ScaleRule.Update withStatistic()"
|
|
desc: "Sets statistics for autoscale trigger action with default values of 10 minutes for duration, 1 minute for frequency(time grain) and 'Average' for statistic type."
|
|
returns:
|
|
description: "the next stage of the definition."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRule.Update?alt=com.azure.resourcemanager.monitor.models.ScaleRule.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withStatistic(java.time.Duration)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withStatistic(Duration duration)"
|
|
name: "withStatistic(Duration duration)"
|
|
nameWithType: "ScaleRule.Update.withStatistic(Duration duration)"
|
|
summary: "Sets statistics for autoscale trigger action with default values of 1 minute for frequency(time grain) and 'Average' for statistic type."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the range of time in which instance data is collected. This value must be greater than the\n delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5\n minutes."
|
|
name: "duration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public abstract ScaleRule.Update withStatistic(Duration duration)"
|
|
desc: "Sets statistics for autoscale trigger action with default values of 1 minute for frequency(time grain) and 'Average' for statistic type."
|
|
returns:
|
|
description: "the next stage of the definition."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRule.Update?alt=com.azure.resourcemanager.monitor.models.ScaleRule.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withStatistic(java.time.Duration,com.azure.resourcemanager.monitor.models.MetricStatisticType)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withStatistic(Duration duration, MetricStatisticType statisticType)"
|
|
name: "withStatistic(Duration duration, MetricStatisticType statisticType)"
|
|
nameWithType: "ScaleRule.Update.withStatistic(Duration duration, MetricStatisticType statisticType)"
|
|
summary: "Sets statistics for autoscale trigger action with default values of 1 minute for frequency(time grain)."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the range of time in which instance data is collected. This value must be greater than the\n delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5\n minutes."
|
|
name: "duration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "the metric statistic type. How the metrics from multiple instances are combined.\n Possible values include: 'Average', 'Min', 'Max', 'Sum'."
|
|
name: "statisticType"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricStatisticType?alt=com.azure.resourcemanager.monitor.models.MetricStatisticType&text=MetricStatisticType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract ScaleRule.Update withStatistic(Duration duration, MetricStatisticType statisticType)"
|
|
desc: "Sets statistics for autoscale trigger action with default values of 1 minute for frequency(time grain)."
|
|
returns:
|
|
description: "the next stage of the definition."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRule.Update?alt=com.azure.resourcemanager.monitor.models.ScaleRule.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withStatistic(java.time.Duration,java.time.Duration,com.azure.resourcemanager.monitor.models.MetricStatisticType)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.ScaleRule.Update.withStatistic(Duration duration, Duration frequency, MetricStatisticType statisticType)"
|
|
name: "withStatistic(Duration duration, Duration frequency, MetricStatisticType statisticType)"
|
|
nameWithType: "ScaleRule.Update.withStatistic(Duration duration, Duration frequency, MetricStatisticType statisticType)"
|
|
summary: "Updates the statistics for autoscale trigger action."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the range of time in which instance data is collected. This value must be greater than the\n delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5\n minutes."
|
|
name: "duration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "the granularity of metrics the rule monitors. Must be one of the predefined values returned\n from metric definitions for the metric. Must be between 12 hours and 1 minute."
|
|
name: "frequency"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "the metric statistic type. How the metrics from multiple instances are combined.\n Possible values include: 'Average', 'Min', 'Max', 'Sum'."
|
|
name: "statisticType"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricStatisticType?alt=com.azure.resourcemanager.monitor.models.MetricStatisticType&text=MetricStatisticType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract ScaleRule.Update withStatistic(Duration duration, Duration frequency, MetricStatisticType statisticType)"
|
|
desc: "Updates the statistics for autoscale trigger action."
|
|
returns:
|
|
description: "the next stage of the scale rule update."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRule.Update?alt=com.azure.resourcemanager.monitor.models.ScaleRule.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "interface"
|
|
desc: "Grouping of scale rule update stages."
|
|
implements:
|
|
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Settable?alt=com.azure.resourcemanager.resources.fluentcore.model.Settable&text=Settable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.monitor.models.AutoscaleProfile.Update?alt=com.azure.resourcemanager.monitor.models.AutoscaleProfile.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.monitor.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-monitor:2.42.0
|