Share via


AgentPoolMode Class

public final class AgentPoolMode
extends ExpandableStringEnum<AgentPoolMode>

The mode of an agent pool. 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.

Field Summary

Modifier and Type Field and Description
static final AgentPoolMode GATEWAY

Gateway agent pools are dedicated to providing static egress IPs to pods.

static final AgentPoolMode SYSTEM

System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server.

static final AgentPoolMode USER

User agent pools are primarily for hosting your application pods.

Constructor Summary

Constructor Description
AgentPoolMode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of AgentPoolMode value.

Method Summary

Modifier and Type Method and Description
static AgentPoolMode fromString(String name)

Creates or finds a AgentPoolMode from its string representation.

static Collection<AgentPoolMode> values()

Gets known AgentPoolMode values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

GATEWAY

public static final AgentPoolMode GATEWAY

Gateway agent pools are dedicated to providing static egress IPs to pods. For more details, see https://aka.ms/aks/static-egress-gateway.

SYSTEM

public static final AgentPoolMode SYSTEM

System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory.

USER

public static final AgentPoolMode USER

User agent pools are primarily for hosting your application pods.

Constructor Details

AgentPoolMode

@Deprecated
public AgentPoolMode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of AgentPoolMode value.

Method Details

fromString

public static AgentPoolMode fromString(String name)

Creates or finds a AgentPoolMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding AgentPoolMode.

values

public static Collection<AgentPoolMode> values()

Gets known AgentPoolMode values.

Returns:

known AgentPoolMode values.

Applies to