AgentPoolUpgradeSettings Class

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models

Assembly:: Az.Aks.private.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.

Settings for upgrading an agentpool

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.AgentPoolUpgradeSettingsTypeConverter))]
public class AgentPoolUpgradeSettings : Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAgentPoolUpgradeSettings

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.AgentPoolUpgradeSettingsTypeConverter))>]
type AgentPoolUpgradeSettings = class
    interface IAgentPoolUpgradeSettings
    interface IJsonSerializable

Public Class AgentPoolUpgradeSettings
Implements IAgentPoolUpgradeSettings

Inheritance: Object
AgentPoolUpgradeSettings

Attributes: TypeConverterAttribute

Implements: IAgentPoolUpgradeSettings IJsonSerializable

Constructors

Name	Description
AgentPoolUpgradeSettings()	Creates an new AgentPoolUpgradeSettings instance.

Properties

Name	Description
DrainTimeoutInMinute	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.
MaxSurge	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	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
NodeSoakDurationInMinute	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	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.

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of AgentPoolUpgradeSettings.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of AgentPoolUpgradeSettings.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAgentPoolUpgradeSettings.
FromJsonString(String)	Creates a new instance of AgentPoolUpgradeSettings, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of AgentPoolUpgradeSettings into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()

Applies to