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.
AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.
public class AgentPoolUpgradeSettings : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.NetworkCloud.Models.AgentPoolUpgradeSettings>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.NetworkCloud.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
| AgentPoolUpgradeSettings() |
Initializes a new instance of AgentPoolUpgradeSettings. |
Properties
| DrainTimeout |
The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. |
| 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 during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. |
| MaxUnavailable |
The maximum number or percentage of nodes that can be unavailable 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 during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
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. |
