Share via


AgentPoolPatchParameters Class

Definition

AgentPoolPatchParameters represents the body of the request to patch the Kubernetes cluster agent pool.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701.AgentPoolPatchParametersTypeConverter))]
public class AgentPoolPatchParameters : Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701.IAgentPoolPatchParameters
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701.AgentPoolPatchParametersTypeConverter))>]
type AgentPoolPatchParameters = class
    interface IAgentPoolPatchParameters
    interface IJsonSerializable
Public Class AgentPoolPatchParameters
Implements IAgentPoolPatchParameters
Inheritance
AgentPoolPatchParameters
Attributes
Implements

Constructors

AgentPoolPatchParameters()

Creates an new AgentPoolPatchParameters instance.

Properties

AdministratorConfigurationSshPublicKey

SshPublicKey represents the public key used to authenticate with a resource through SSH.

Count

The number of virtual machines that use this configuration.

Tag

The Azure resource tags that will replace the existing ones.

UpgradeSettingDrainTimeout

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.

UpgradeSettingMaxSurge

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.

UpgradeSettingMaxUnavailable

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 AgentPoolPatchParameters.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of AgentPoolPatchParameters.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20240701.IAgentPoolPatchParameters.

FromJsonString(String)

Creates a new instance of AgentPoolPatchParameters, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of AgentPoolPatchParameters into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to