Share via

ComputeBatchModelFactory.AutomaticOsUpgradePolicy Method

Definition

Namespace:
Azure.Compute.Batch
Assembly:
Azure.Compute.Batch.dll
Package:
Azure.Compute.Batch v1.0.0-beta.5
Source:
ComputeBatchModelFactory.cs

The configuration parameters used for performing automatic OS upgrade.

public static Azure.Compute.Batch.AutomaticOsUpgradePolicy AutomaticOsUpgradePolicy(bool? disableAutomaticRollback = default, bool? enableAutomaticOsUpgrade = default, bool? useRollingUpgradePolicy = default, bool? osRollingUpgradeDeferral = default);
static member AutomaticOsUpgradePolicy : Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> -> Azure.Compute.Batch.AutomaticOsUpgradePolicy
Public Shared Function AutomaticOsUpgradePolicy (Optional disableAutomaticRollback As Nullable(Of Boolean) = Nothing, Optional enableAutomaticOsUpgrade As Nullable(Of Boolean) = Nothing, Optional useRollingUpgradePolicy As Nullable(Of Boolean) = Nothing, Optional osRollingUpgradeDeferral As Nullable(Of Boolean) = Nothing) As AutomaticOsUpgradePolicy

Parameters

disableAutomaticRollback
Nullable<Boolean>

Whether OS image rollback feature should be disabled.

enableAutomaticOsUpgrade
Nullable<Boolean>

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.

useRollingUpgradePolicy
Nullable<Boolean>

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.

osRollingUpgradeDeferral
Nullable<Boolean>

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

Returns

AutomaticOsUpgradePolicy

A new AutomaticOsUpgradePolicy instance for mocking.

Applies to