AgentPoolUpgradeSettings Class
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.
Settings for upgrading an agentpool Serialized Name: AgentPoolUpgradeSettings
public class AgentPoolUpgradeSettings : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings>type AgentPoolUpgradeSettings = class
interface IJsonModel<AgentPoolUpgradeSettings>
interface IPersistableModel<AgentPoolUpgradeSettings>Public Class AgentPoolUpgradeSettings
Implements IJsonModel(Of AgentPoolUpgradeSettings), IPersistableModel(Of AgentPoolUpgradeSettings)- Inheritance
-
AgentPoolUpgradeSettings
- Implements
Constructors
| Name | Description |
|---|---|
| AgentPoolUpgradeSettings() |
Initializes a new instance of AgentPoolUpgradeSettings. |
Properties
| Name | Description |
|---|---|
| DrainTimeoutInMinutes |
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. Serialized Name: AgentPoolUpgradeSettings.drainTimeoutInMinutes |
| 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 Serialized Name: AgentPoolUpgradeSettings.maxSurge |
| 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 Serialized Name: AgentPoolUpgradeSettings.maxUnavailable |
| NodeSoakDurationInMinutes |
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. Serialized Name: AgentPoolUpgradeSettings.nodeSoakDurationInMinutes |
| 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. Serialized Name: AgentPoolUpgradeSettings.undrainableNodeBehavior |
Methods
| Name | Description |
|---|---|
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<AgentPoolUpgradeSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<AgentPoolUpgradeSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<AgentPoolUpgradeSettings>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<AgentPoolUpgradeSettings>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<AgentPoolUpgradeSettings>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
