126 строки
12 KiB
YAML
126 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy"
|
|
name: "ScaleInPolicy"
|
|
nameWithType: "ScaleInPolicy"
|
|
summary: "Describes a scale-in policy for a virtual machine scale set."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **ScaleInPolicy**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.compute.models.ScaleInPolicy?alt=com.azure.resourcemanager.compute.models.ScaleInPolicy&text=ScaleInPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy.ScaleInPolicy()"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy.ScaleInPolicy()"
|
|
name: "ScaleInPolicy()"
|
|
nameWithType: "ScaleInPolicy.ScaleInPolicy()"
|
|
summary: "Creates an instance of Scale<wbr>InPolicy class."
|
|
syntax: "public ScaleInPolicy()"
|
|
desc: "Creates an instance of ScaleInPolicy class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy.forceDeletion()"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy.forceDeletion()"
|
|
name: "forceDeletion()"
|
|
nameWithType: "ScaleInPolicy.forceDeletion()"
|
|
summary: "Get the force<wbr>Deletion property: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)."
|
|
syntax: "public Boolean forceDeletion()"
|
|
desc: "Get the forceDeletion property: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)."
|
|
returns:
|
|
description: "the forceDeletion value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "ScaleInPolicy.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Scale<wbr>InPolicy from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static ScaleInPolicy fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the ScaleInPolicy."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of ScaleInPolicy from the JsonReader."
|
|
returns:
|
|
description: "An instance of ScaleInPolicy if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.ScaleInPolicy?alt=com.azure.resourcemanager.compute.models.ScaleInPolicy&text=ScaleInPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy.rules()"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy.rules()"
|
|
name: "rules()"
|
|
nameWithType: "ScaleInPolicy.rules()"
|
|
summary: "Get the rules property: The rules to be followed when scaling-in a virtual machine scale set."
|
|
syntax: "public List<VirtualMachineScaleSetScaleInRules> rules()"
|
|
desc: "Get the rules property: The rules to be followed when scaling-in a virtual machine scale set. <br><br> Possible values are: <br><br> \\*\\*Default\\*\\* When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. <br><br> \\*\\*OldestVM\\*\\* When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. <br><br> \\*\\*NewestVM\\*\\* When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. <br><br>."
|
|
returns:
|
|
description: "the rules value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.compute.models.VirtualMachineScaleSetScaleInRules?alt=com.azure.resourcemanager.compute.models.VirtualMachineScaleSetScaleInRules&text=VirtualMachineScaleSetScaleInRules\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "ScaleInPolicy.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy.validate()"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy.validate()"
|
|
name: "validate()"
|
|
nameWithType: "ScaleInPolicy.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy.withForceDeletion(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy.withForceDeletion(Boolean forceDeletion)"
|
|
name: "withForceDeletion(Boolean forceDeletion)"
|
|
nameWithType: "ScaleInPolicy.withForceDeletion(Boolean forceDeletion)"
|
|
summary: "Set the force<wbr>Deletion property: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)."
|
|
parameters:
|
|
- description: "the forceDeletion value to set."
|
|
name: "forceDeletion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ScaleInPolicy withForceDeletion(Boolean forceDeletion)"
|
|
desc: "Set the forceDeletion property: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)."
|
|
returns:
|
|
description: "the ScaleInPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.ScaleInPolicy?alt=com.azure.resourcemanager.compute.models.ScaleInPolicy&text=ScaleInPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.compute.models.ScaleInPolicy.withRules(java.util.List<com.azure.resourcemanager.compute.models.VirtualMachineScaleSetScaleInRules>)"
|
|
fullName: "com.azure.resourcemanager.compute.models.ScaleInPolicy.withRules(List<VirtualMachineScaleSetScaleInRules> rules)"
|
|
name: "withRules(List<VirtualMachineScaleSetScaleInRules> rules)"
|
|
nameWithType: "ScaleInPolicy.withRules(List<VirtualMachineScaleSetScaleInRules> rules)"
|
|
summary: "Set the rules property: The rules to be followed when scaling-in a virtual machine scale set."
|
|
parameters:
|
|
- description: "the rules value to set."
|
|
name: "rules"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.compute.models.VirtualMachineScaleSetScaleInRules?alt=com.azure.resourcemanager.compute.models.VirtualMachineScaleSetScaleInRules&text=VirtualMachineScaleSetScaleInRules\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ScaleInPolicy withRules(List<VirtualMachineScaleSetScaleInRules> rules)"
|
|
desc: "Set the rules property: The rules to be followed when scaling-in a virtual machine scale set. <br><br> Possible values are: <br><br> \\*\\*Default\\*\\* When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. <br><br> \\*\\*OldestVM\\*\\* When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. <br><br> \\*\\*NewestVM\\*\\* When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. <br><br>."
|
|
returns:
|
|
description: "the ScaleInPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.compute.models.ScaleInPolicy?alt=com.azure.resourcemanager.compute.models.ScaleInPolicy&text=ScaleInPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Describes a scale-in policy for a virtual machine scale set."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.compute.models.ScaleInPolicy?alt=com.azure.resourcemanager.compute.models.ScaleInPolicy&text=ScaleInPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.compute.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0
|