RollingUpgradePolicy Constructors

Definition

Namespace:

Microsoft.Azure.Batch.Protocol.Models

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Overloads

RollingUpgradePolicy()	Initializes a new instance of the RollingUpgradePolicy class.
RollingUpgradePolicy(Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<TimeSpan>, Nullable<Boolean>, Nullable<Boolean>)	Initializes a new instance of the RollingUpgradePolicy class.

RollingUpgradePolicy()

Source:

RollingUpgradePolicy.cs

Initializes a new instance of the RollingUpgradePolicy class.

public RollingUpgradePolicy ();

Public Sub New ()

RollingUpgradePolicy(Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<TimeSpan>, Nullable<Boolean>, Nullable<Boolean>)

Source:

RollingUpgradePolicy.cs

Initializes a new instance of the RollingUpgradePolicy class.

public RollingUpgradePolicy (bool? enableCrossZoneUpgrade = default, int? maxBatchInstancePercent = default, int? maxUnhealthyInstancePercent = default, int? maxUnhealthyUpgradedInstancePercent = default, TimeSpan? pauseTimeBetweenBatches = default, bool? prioritizeUnhealthyInstances = default, bool? rollbackFailedInstancesOnPolicyBreach = default);

new Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy : Nullable<bool> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<TimeSpan> * Nullable<bool> * Nullable<bool> -> Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy

Public Sub New (Optional enableCrossZoneUpgrade As Nullable(Of Boolean) = Nothing, Optional maxBatchInstancePercent As Nullable(Of Integer) = Nothing, Optional maxUnhealthyInstancePercent As Nullable(Of Integer) = Nothing, Optional maxUnhealthyUpgradedInstancePercent As Nullable(Of Integer) = Nothing, Optional pauseTimeBetweenBatches As Nullable(Of TimeSpan) = Nothing, Optional prioritizeUnhealthyInstances As Nullable(Of Boolean) = Nothing, Optional rollbackFailedInstancesOnPolicyBreach As Nullable(Of Boolean) = Nothing)

Parameters

enableCrossZoneUpgrade

Nullable<Boolean>

Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal.

maxBatchInstancePercent

Nullable<Int32>

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 value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

Nullable<Int32>

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 value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

Nullable<Int32>

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 value of this field should be between 0 and 100, inclusive.

pauseTimeBetweenBatches

Nullable<TimeSpan>

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.

prioritizeUnhealthyInstances

Nullable<Boolean>

Upgrade all unhealthy instances in a scale set before any healthy instances.

rollbackFailedInstancesOnPolicyBreach

Nullable<Boolean>

Rollback failed instances to previous model if the Rolling Upgrade policy is violated.