ArmContainerServiceModelFactory.AgentPoolUpgradeSettings Method

Definition

Namespace:: Azure.ResourceManager.ContainerService.Models

Assembly:: Azure.ResourceManager.ContainerService.dll

Package:: Azure.ResourceManager.ContainerService v1.5.0

Package:: Azure.ResourceManager.ContainerService v1.6.0-beta.1

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(String, String, Nullable<Int32>, Nullable<Int32>, Nullable<UndrainableNodeBehavior>)	Initializes a new instance of AgentPoolUpgradeSettings.
AgentPoolUpgradeSettings(String, String, String, Nullable<Int32>, Nullable<Int32>, Nullable<UndrainableNodeBehavior>)

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

Source:: ArmContainerServiceModelFactory.cs

Source:: ArmContainerServiceModelFactory.cs

Initializes a new instance of AgentPoolUpgradeSettings.

public static Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings AgentPoolUpgradeSettings(string maxSurge = default, string maxUnavailable = default, int? drainTimeoutInMinutes = default, int? nodeSoakDurationInMinutes = default, Azure.ResourceManager.ContainerService.Models.UndrainableNodeBehavior? undrainableNodeBehavior = default);

public static Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings AgentPoolUpgradeSettings(string maxSurge, string maxUnavailable, int? drainTimeoutInMinutes, int? nodeSoakDurationInMinutes, Azure.ResourceManager.ContainerService.Models.UndrainableNodeBehavior? undrainableNodeBehavior);

static member AgentPoolUpgradeSettings : string * string * Nullable<int> * Nullable<int> * Nullable<Azure.ResourceManager.ContainerService.Models.UndrainableNodeBehavior> -> Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings

Public Shared Function AgentPoolUpgradeSettings (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 Nullable(Of UndrainableNodeBehavior) = Nothing) As AgentPoolUpgradeSettings

Public Shared Function AgentPoolUpgradeSettings (maxSurge As String, maxUnavailable As String, drainTimeoutInMinutes As Nullable(Of Integer), nodeSoakDurationInMinutes As Nullable(Of Integer), undrainableNodeBehavior As Nullable(Of UndrainableNodeBehavior)) As AgentPoolUpgradeSettings

Parameters

maxSurge: String

The maximum number or percentage of nodes that are surged during upgrade.

maxUnavailable: String

The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade.

drainTimeoutInMinutes: Nullable<Int32>

The amount of time (in minutes) to wait on eviction of pods and graceful termination per node.

nodeSoakDurationInMinutes: Nullable<Int32>

The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.

undrainableNodeBehavior: Nullable<UndrainableNodeBehavior>

Defines the behavior for undrainable nodes during upgrade.

Returns

AgentPoolUpgradeSettings

A new AgentPoolUpgradeSettings instance for mocking.

Applies to

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

Source:: ArmContainerServiceModelFactory.cs

public static Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings AgentPoolUpgradeSettings(string maxSurge = default, string maxUnavailable = default, string maxBlockedNodes = default, int? drainTimeoutInMinutes = default, int? nodeSoakDurationInMinutes = default, Azure.ResourceManager.ContainerService.Models.UndrainableNodeBehavior? undrainableNodeBehavior = default);

static member AgentPoolUpgradeSettings : string * string * string * Nullable<int> * Nullable<int> * Nullable<Azure.ResourceManager.ContainerService.Models.UndrainableNodeBehavior> -> Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings

Public Shared Function AgentPoolUpgradeSettings (Optional maxSurge As String = Nothing, Optional maxUnavailable As String = Nothing, Optional maxBlockedNodes As String = Nothing, Optional drainTimeoutInMinutes As Nullable(Of Integer) = Nothing, Optional nodeSoakDurationInMinutes As Nullable(Of Integer) = Nothing, Optional undrainableNodeBehavior As Nullable(Of UndrainableNodeBehavior) = Nothing) As AgentPoolUpgradeSettings

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.

maxBlockedNodes: String

The maximum number or percentage of extra nodes that are allowed to be blocked in the agent pool during an upgrade when undrainable node behavior is Cordon. 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 maxSurge. This must always be greater than or equal to maxSurge. 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: Nullable<UndrainableNodeBehavior>

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.

Returns

AgentPoolUpgradeSettings

A new AgentPoolUpgradeSettings instance for mocking.

Applies to

Feedback

Was this page helpful?