Share via

AutomaticOSUpgradePolicy Class

  • Reference

The configuration parameters used for performing automatic OS upgrade.

Constructor

AutomaticOSUpgradePolicy(*, disable_automatic_rollback: bool | None = None, enable_automatic_os_upgrade: bool | None = None, use_rolling_upgrade_policy: bool | None = None, os_rolling_upgrade_deferral: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
disable_automatic_rollback
bool

Whether OS image rollback feature should be disabled.

Default value: None
enable_automatic_os_upgrade
bool

Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br />``<br /> If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.

Default value: None
use_rolling_upgrade_policy
bool

Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

Default value: None
os_rolling_upgrade_deferral
bool

Defer OS upgrades on the TVMs if they are running tasks.

Default value: None

Variables

Name Description
disable_automatic_rollback
bool

Whether OS image rollback feature should be disabled.
enable_automatic_os_upgrade
bool

Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br />``<br /> If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.
use_rolling_upgrade_policy
bool

Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.
os_rolling_upgrade_deferral
bool

Defer OS upgrades on the TVMs if they are running tasks.