Share via

AutomaticOSUpgradePolicy interface

  • Reference
Package:
@azure/arm-batch

The configuration parameters used for performing automatic OS upgrade.

Properties

disableAutomaticRollback

Whether OS image rollback feature should be disabled.
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.

If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.
osRollingUpgradeDeferral

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

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.

Property Details

disableAutomaticRollback

Whether OS image rollback feature should be disabled.

disableAutomaticRollback?: boolean

Property Value

boolean

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.

If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates cannot be set to true.

enableAutomaticOSUpgrade?: boolean

Property Value

boolean

osRollingUpgradeDeferral

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

osRollingUpgradeDeferral?: boolean

Property Value

boolean

useRollingUpgradePolicy

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.

useRollingUpgradePolicy?: boolean

Property Value

boolean