AutomaticOSUpgradePolicy Class

The configuration parameters used for performing automatic OS upgrade.

Constructor

AutomaticOSUpgradePolicy()

Variables

Name Description
enableAutomaticOSUpgrade
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 is automatically set to false and cannot be set to true.
disableAutomaticRollback
bool

Whether OS image rollback feature should be disabled. Default value is false.
useRollingUpgradePolicy
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.
osRollingUpgradeDeferral
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.

Attributes

disableAutomaticRollback

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

disableAutomaticRollback: bool

enableAutomaticOSUpgrade

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 is automatically set to false and cannot be set to true.

enableAutomaticOSUpgrade: bool

osRollingUpgradeDeferral

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.

osRollingUpgradeDeferral: bool

useRollingUpgradePolicy

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.

useRollingUpgradePolicy: bool