Class RollingUpgradePolicy
The configuration parameters used while performing a rolling upgrade.
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.Compute.dll
Syntax
public class RollingUpgradePolicyConstructors
RollingUpgradePolicy()
Initializes a new instance of the RollingUpgradePolicy class.
Declaration
public RollingUpgradePolicy ();RollingUpgradePolicy(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String)
Initializes a new instance of the RollingUpgradePolicy class.
Declaration
public RollingUpgradePolicy (Nullable<int> maxBatchInstancePercent = null, Nullable<int> maxUnhealthyInstancePercent = null, Nullable<int> maxUnhealthyUpgradedInstancePercent = null, string pauseTimeBetweenBatches = null);Parameters
|
Nullable<Int32>
maxBatchInstancePercent
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. |
|
Nullable<Int32>
maxUnhealthyInstancePercent
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. |
|
Nullable<Int32>
maxUnhealthyUpgradedInstancePercent
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. |
|
String
pauseTimeBetweenBatches
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). |
Properties
MaxBatchInstancePercent
Gets or sets the maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.
Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="maxBatchInstancePercent")]
public Nullable<int> MaxBatchInstancePercent { get; set; }Property Value
|
Nullable<Int32>
|
MaxUnhealthyInstancePercent
Gets or sets the maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.
Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="maxUnhealthyInstancePercent")]
public Nullable<int> MaxUnhealthyInstancePercent { get; set; }Property Value
|
Nullable<Int32>
|
MaxUnhealthyUpgradedInstancePercent
Gets or sets the maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.
Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="maxUnhealthyUpgradedInstancePercent")]
public Nullable<int> MaxUnhealthyUpgradedInstancePercent { get; set; }Property Value
|
Nullable<Int32>
|
PauseTimeBetweenBatches
Gets or sets the wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).
Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="pauseTimeBetweenBatches")]
public string PauseTimeBetweenBatches { get; set; }Property Value
|
String
|
Methods
Validate()
Validate the object.
Declaration
public virtual void Validate ();Exceptions
|
ValidationException
Thrown if validation fails |