AgentPool Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701

Assembly:

Az.NetworkCloud.private.dll

AgentPool represents the agent pool of Kubernetes cluster.

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

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

Public Class AgentPool
Implements IAgentPool, IValidates

Inheritance

Object

AgentPool

Attributes

TypeConverterAttribute

Implements

IAgentPool IResource ITrackedResource IJsonSerializable IValidates

Constructors

AgentPool()

Creates an new AgentPool instance.

Properties

AdministratorConfigurationAdminUsername	The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
AdministratorConfigurationSshPublicKey	The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.
AgentOptionHugepagesCount	The number of hugepages to allocate.
AgentOptionHugepagesSize	The size of the hugepages to allocate.
AttachedNetworkConfigurationL2Network	The list of Layer 2 Networks and related configuration for attachment.
AttachedNetworkConfigurationL3Network	The list of Layer 3 Networks and related configuration for attachment.
AttachedNetworkConfigurationTrunkedNetwork	The list of Trunked Networks and related configuration for attachment.
AvailabilityZone	The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
Count	The number of virtual machines that use this configuration.
DetailedStatus	The current status of the agent pool.
DetailedStatusMessage	The descriptive message about the current detailed status.
ExtendedLocationName	The resource ID of the extended location on which the resource will be created.
ExtendedLocationType	The extended location type, for example, CustomLocation.
Id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
KubernetesVersion	The Kubernetes version running in this agent pool.
Label	The labels applied to the nodes in this agent pool.
Location	The geo-location where the resource lives
Mode	The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
Name	The name of the resource
ProvisioningState	The provisioning state of the agent pool.
ResourceGroupName	Gets the resource group name
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
Taint	The taints applied to the nodes in this agent pool.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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, the default is 1.
VMSkuName	The name of the VM SKU that determines the size of resources allocated for 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.NetworkCloud.Models.Api20230701.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.