AgentPoolUpgradeSettings Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701

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

AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.

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

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

Public Class AgentPoolUpgradeSettings
Implements IAgentPoolUpgradeSettings

Inheritance: Object
AgentPoolUpgradeSettings

Attributes: TypeConverterAttribute

Implements: IAgentPoolUpgradeSettings IJsonSerializable

Constructors

AgentPoolUpgradeSettings()

Creates an new AgentPoolUpgradeSettings instance.

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

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.NetworkCloud.Models.Api20240701.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

Share via