AgentPoolUpgradeSettings Constructors

Definition

Namespace:: Microsoft.Azure.Management.ContainerService.Models

Assembly:: Microsoft.Azure.PowerShell.Aks.Management.Sdk.dll

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.

Overloads

Name	Description
AgentPoolUpgradeSettings()	Initializes a new instance of the AgentPoolUpgradeSettings class.
AgentPoolUpgradeSettings(String)	Initializes a new instance of the AgentPoolUpgradeSettings class.
AgentPoolUpgradeSettings(String, String, Nullable<Int32>, Nullable<Int32>, String)	Initializes a new instance of the AgentPoolUpgradeSettings class.

AgentPoolUpgradeSettings()

Initializes a new instance of the AgentPoolUpgradeSettings class.

public AgentPoolUpgradeSettings();

Public Sub New ()

Applies to

AgentPoolUpgradeSettings(String)

Initializes a new instance of the AgentPoolUpgradeSettings class.

public AgentPoolUpgradeSettings(string maxSurge = default);

new Microsoft.Azure.Management.ContainerService.Models.AgentPoolUpgradeSettings : string -> Microsoft.Azure.Management.ContainerService.Models.AgentPoolUpgradeSettings

Public Sub New (Optional maxSurge As String = Nothing)

Parameters

maxSurge: String

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 agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

Applies to

AgentPoolUpgradeSettings(String, String, Nullable<Int32>, Nullable<Int32>, String)

Initializes a new instance of the AgentPoolUpgradeSettings class.

public AgentPoolUpgradeSettings(string maxSurge = default, string maxUnavailable = default, int? drainTimeoutInMinutes = default, int? nodeSoakDurationInMinutes = default, string undrainableNodeBehavior = default);

new Microsoft.Azure.Management.ContainerService.Models.AgentPoolUpgradeSettings : string * string * Nullable<int> * Nullable<int> * string -> Microsoft.Azure.Management.ContainerService.Models.AgentPoolUpgradeSettings

Public Sub New (Optional maxSurge As String = Nothing, Optional maxUnavailable As String = Nothing, Optional drainTimeoutInMinutes As Nullable(Of Integer) = Nothing, Optional nodeSoakDurationInMinutes As Nullable(Of Integer) = Nothing, Optional undrainableNodeBehavior As String = Nothing)

Parameters

maxSurge: String

The maximum number or percentage of nodes that are surged during upgrade. 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 agent pool size at the time of the upgrade. 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

maxUnavailable: String

The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster

drainTimeoutInMinutes: Nullable<Int32>

The drain timeout for a node. 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.

nodeSoakDurationInMinutes: Nullable<Int32>

The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.

undrainableNodeBehavior: String

Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes. Possible values include: 'Cordon', 'Schedule'

Applies to