AgentPool Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models

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

The agentPool resource definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.AgentPoolTypeConverter))]
public class AgentPool : Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.IAgentPool, Microsoft.Azure.PowerShell.Cmdlets.AksArc.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.AgentPoolTypeConverter))>]
type AgentPool = class
    interface IAgentPool
    interface IJsonSerializable
    interface IProxyResource
    interface IResource
    interface IValidates

Public Class AgentPool
Implements IAgentPool, IValidates

Inheritance: Object
AgentPool

Attributes: TypeConverterAttribute

Implements: IAgentPool IProxyResource IResource IJsonSerializable IValidates

Constructors

AgentPool()

Creates an new AgentPool 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
ExtendedLocationName	ARM Id of the extended location.
ExtendedLocationType	The extended location type. Allowed value: 'CustomLocation'
Id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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
Name	The name of the resource
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.
ResourceGroupName	Gets the resource group name
StatusCurrentState	The current state of the agent pool.
StatusErrorMessage	Error messages during an agent pool operation or steady state.
StatusReadyReplica
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tag	Resource tags
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VMSize	The VM sku size of the agent pool node VMs.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of AgentPool.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of AgentPool.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.IAgentPool.
FromJsonString(String)	Creates a new instance of AgentPool, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of AgentPool into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to

Share via