AgentPoolProperties 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.
Properties of the agent pool resource
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.AgentPoolPropertiesTypeConverter))]
public class AgentPoolProperties : Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.IAgentPoolProperties, Microsoft.Azure.PowerShell.Cmdlets.AksArc.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.AgentPoolPropertiesTypeConverter))>]
type AgentPoolProperties = class
interface IAgentPoolProperties
interface IJsonSerializable
interface IAgentPoolProfile
interface IAgentPoolUpdateProfile
interface IAgentPoolProvisioningStatus
interface IValidates
Public Class AgentPoolProperties
Implements IAgentPoolProperties, IValidates
- Inheritance
-
AgentPoolProperties
- Attributes
- Implements
Constructors
AgentPoolProperties() |
Creates an new AgentPoolProperties instance. |
Properties
Count |
Number of nodes in the agent pool. The default value is 1. |
EnableAutoScaling |
Whether to enable auto-scaler. Default value is false |
KubernetesVersion |
Version of Kubernetes in use by the agent pool. This is inherited from the kubernetesVersion of the provisioned cluster. |
MaxCount |
The maximum number of nodes for auto-scaling |
MaxPod |
The maximum number of pods that can run on a node. |
MinCount |
The minimum number of nodes for auto-scaling |
NodeLabel |
The node labels to be persisted across all nodes in agent pool. |
NodeTaint |
Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. |
OSSku |
Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows. |
OSType |
The particular KubernetesVersion Image OS Type (Linux, Windows) |
ProvisioningState |
The status of the latest long running operation for the agent pool. |
StatusCurrentState |
The current state of the agent pool. |
StatusErrorMessage |
Error messages during an agent pool operation or steady state. |
StatusReadyReplica | |
VMSize |
The VM sku size of the agent pool node VMs. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of AgentPoolProperties. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of AgentPoolProperties. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.IAgentPoolProperties. |
FromJsonString(String) |
Creates a new instance of AgentPoolProperties, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of AgentPoolProperties into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
ToString() | |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |