Share via

AutomaticOSUpgradePolicy Class

  • Reference

The configuration parameters used for performing automatic OS upgrade.

Inheritance
azure.mgmt.compute._serialization.Model
AutomaticOSUpgradePolicy

Constructor

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

Keyword-Only Parameters

Name Description
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. Default value is false. If this is set to true for Windows based scale sets, enableAutomaticUpdates # pylint: disable=line-too-long is automatically set to false and cannot be set to true.
disable_automatic_rollback
bool

Whether OS image rollback feature should be disabled. Default value is false.
use_rolling_upgrade_policy
bool

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

Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call.

Variables

Name Description
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. Default value is false. If this is set to true for Windows based scale sets, enableAutomaticUpdates # pylint: disable=line-too-long is automatically set to false and cannot be set to true.
disable_automatic_rollback
bool

Whether OS image rollback feature should be disabled. Default value is false.
use_rolling_upgrade_policy
bool

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

Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call.