AgentPoolUpgradeSettings Class

Reference

Definition

Namespace:: Azure.ResourceManager.ContainerService.Models

Assembly:: Azure.ResourceManager.ContainerService.dll

Package:: Azure.ResourceManager.ContainerService v1.2.1

Source:: AgentPoolUpgradeSettings.cs

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.

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: Object
AgentPoolUpgradeSettings

Implements: IJsonModel<AgentPoolUpgradeSettings> IPersistableModel<AgentPoolUpgradeSettings> IPersistableModel<T>

Constructors

AgentPoolUpgradeSettings()

Initializes a new instance of AgentPoolUpgradeSettings.

Properties

DrainTimeoutInMinutes

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

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.

Explicit Interface Implementations

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.

Applies to