ArmContainerServiceModelFactory.AgentPoolBlueGreenUpgradeSettings Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public static Azure.ResourceManager.ContainerService.Models.AgentPoolBlueGreenUpgradeSettings AgentPoolBlueGreenUpgradeSettings(string drainBatchSize = default, int? drainTimeoutInMinutes = default, int? batchSoakDurationInMinutes = default, int? finalSoakDurationInMinutes = default);static member AgentPoolBlueGreenUpgradeSettings : string * Nullable<int> * Nullable<int> * Nullable<int> -> Azure.ResourceManager.ContainerService.Models.AgentPoolBlueGreenUpgradeSettingsPublic Shared Function AgentPoolBlueGreenUpgradeSettings (Optional drainBatchSize As String = Nothing, Optional drainTimeoutInMinutes As Nullable(Of Integer) = Nothing, Optional batchSoakDurationInMinutes As Nullable(Of Integer) = Nothing, Optional finalSoakDurationInMinutes As Nullable(Of Integer) = Nothing) As AgentPoolBlueGreenUpgradeSettingsParameters
- drainBatchSize
- String
The number or percentage of nodes to drain in batch during blue-green upgrade. Must be a non-zero number. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total number of blue nodes of the initial upgrade operation. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster.
The drain timeout for a node, i.e., the amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
The soak duration after draining a batch of nodes, i.e., the amount of time (in minutes) to wait after draining a batch of nodes before moving on the next batch. If not specified, the default is 15 minutes.
The soak duration for a node pool, i.e., the amount of time (in minutes) to wait after all old nodes are drained before we remove the old nodes. If not specified, the default is 60 minutes. Only applicable for blue-green upgrade strategy.
Returns
A new AgentPoolBlueGreenUpgradeSettings instance for mocking.
