ManagedClusterAgentPoolProfile 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.
Profile for the container service agent pool.
public class ManagedClusterAgentPoolProfile : Azure.ResourceManager.ContainerService.Models.ManagedClusterAgentPoolProfileProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ContainerService.Models.ManagedClusterAgentPoolProfile>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ContainerService.Models.ManagedClusterAgentPoolProfile>public class ManagedClusterAgentPoolProfile : Azure.ResourceManager.ContainerService.Models.ManagedClusterAgentPoolProfilePropertiestype ManagedClusterAgentPoolProfile = class
inherit ManagedClusterAgentPoolProfileProperties
interface IJsonModel<ManagedClusterAgentPoolProfile>
interface IPersistableModel<ManagedClusterAgentPoolProfile>type ManagedClusterAgentPoolProfile = class
inherit ManagedClusterAgentPoolProfilePropertiesPublic Class ManagedClusterAgentPoolProfile
Inherits ManagedClusterAgentPoolProfileProperties
Implements IJsonModel(Of ManagedClusterAgentPoolProfile), IPersistableModel(Of ManagedClusterAgentPoolProfile)Public Class ManagedClusterAgentPoolProfile
Inherits ManagedClusterAgentPoolProfileProperties- Inheritance
- Implements
Constructors
| ManagedClusterAgentPoolProfile(String) |
Initializes a new instance of ManagedClusterAgentPoolProfile. |
Properties
| AgentPoolType |
The type of Agent Pool. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| AvailabilityZones |
The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| CapacityReservationGroupId |
AKS will associate the specified agent pool with the Capacity Reservation Group. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| Count |
Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| CreationDataSourceResourceId |
This is the ARM ID of the source object to be used to create the target object. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| CurrentOrchestratorVersion |
If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| DisableOutboundNat |
The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| EnableAutoScaling |
Whether to enable auto-scaler. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| EnableCustomCATrust |
When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| EnableEncryptionAtHost |
This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| EnableFips |
See Add a FIPS-enabled node pool for more details. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| EnableNodePublicIP |
Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| EnableUltraSsd |
Whether to enable UltraSSD. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| GpuInstanceProfile |
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| HostGroupId |
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| KubeletConfig |
The Kubelet configuration on the agent pool nodes. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| KubeletDiskType |
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| LinuxOSConfig |
The OS configuration of Linux agent nodes. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| MaxCount |
The maximum number of nodes for auto-scaling. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| MaxPods |
The maximum number of pods that can run on a node. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| MessageOfTheDay |
A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). (Inherited from ManagedClusterAgentPoolProfileProperties) |
| MinCount |
The minimum number of nodes for auto-scaling. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| Mode |
A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| Name |
Windows agent pool names must be 6 characters or less. |
| NetworkProfile |
Network-related settings of an agent pool. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| NodeImageVersion |
The version of node image. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| NodeLabels |
The node labels to be persisted across all nodes in agent pool. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| NodePublicIPPrefixId |
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| NodeTaints |
The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| OrchestratorVersion |
Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| OSDiskSizeInGB |
OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| OSDiskType |
The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| OSSku |
Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| OSType |
The operating system type. The default is Linux. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| PodSubnetId |
If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| PowerStateCode |
Tells whether the cluster is Running or Stopped. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| ProvisioningState |
The current deployment or provisioning state. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| ProximityPlacementGroupId |
The ID for Proximity Placement Group. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| ScaleDownMode |
This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| ScaleSetEvictionPolicy |
This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| ScaleSetPriority |
The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| SpotMaxPrice |
Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| Tags |
The tags to be persisted on the agent pool virtual machine scale set. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| UpgradeSettings |
Settings for upgrading the agentpool. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| VmSize |
VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| VnetSubnetId |
If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. (Inherited from ManagedClusterAgentPoolProfileProperties) |
| WorkloadRuntime |
Determines the type of workload a node can run. (Inherited from ManagedClusterAgentPoolProfileProperties) |
Explicit Interface Implementations
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for