RollingUpgradePolicy Class

The configuration parameters used while performing a rolling upgrade.

Inheritance

azure.mgmt.compute._serialization.Model

RollingUpgradePolicy

Constructor

RollingUpgradePolicy(*, max_batch_instance_percent: int | None = None, max_unhealthy_instance_percent: int | None = None, max_unhealthy_upgraded_instance_percent: int | None = None, pause_time_between_batches: str | None = None, enable_cross_zone_upgrade: bool | None = None, prioritize_unhealthy_instances: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
max_batch_instance_percent	int 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%.
max_unhealthy_instance_percent	int 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%.
max_unhealthy_upgraded_instance_percent	int 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%.
pause_time_between_batches	str 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).
enable_cross_zone_upgrade	bool Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.
prioritize_unhealthy_instances	bool Upgrade all unhealthy instances in a scale set before any healthy instances.

Variables

Name	Description
max_batch_instance_percent	int 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%.
max_unhealthy_instance_percent	int 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%.
max_unhealthy_upgraded_instance_percent	int 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%.
pause_time_between_batches	str 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).
enable_cross_zone_upgrade	bool Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.
prioritize_unhealthy_instances	bool Upgrade all unhealthy instances in a scale set before any healthy instances.