KubernetesClusterAgentPool Interface

Package:

com.azure.resourcemanager.containerservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-containerservice:2.47.0

Implements

AgentPool ChildResource<KubernetesCluster> HasInnerModel<ManagedClusterAgentPoolProfile>

public interface KubernetesClusterAgentPool
extends ChildResource<KubernetesCluster>, HasInnerModel<ManagedClusterAgentPoolProfile>, AgentPool

A client-side representation for a Kubernetes cluster agent pool.

Method Summary

Modifier and Type	Method and Description
abstract List<String>	availabilityZones() Gets the list of availability zones.
abstract int	count() Gets the number of agents (virtual machines) to host docker containers.
abstract boolean	isAutoScalingEnabled() Checks whether auto-scaling is enabled.
abstract KubeletDiskType	kubeletDiskType() Gets the disk type for the placement.
abstract int	maximumNodeSize() Gets the maximum number of nodes for auto-scaling.
abstract int	maximumPodsPerNode() Gets the maximum number of pods per node.
abstract int	minimumNodeSize() Gets the minimum number of nodes for auto-scaling.
abstract AgentPoolMode	mode() Gets agent pool mode.
abstract String	networkId() Gets the ID of the virtual network used by each virtual machine in the agent pool.
abstract Map<String,String>	nodeLabels() Gets the map of node labels.
abstract int	nodeSize() Gets the number of agents (VMs) to host docker containers.
abstract List<String>	nodeTaints() Gets the list of node taints.
abstract int	osDiskSizeInGB() Gets OS disk size in GB set for each virtual machine in the agent pool.
abstract OSDiskType	osDiskType() Gets the OS disk type to be used for machines in the agent pool.
abstract OSType	osType() Gets OS of each virtual machine in the agent pool.
abstract PowerState	powerState() Gets the power state.
abstract String	provisioningState() Gets the provisioning state of the agent pool.
abstract String	subnetName() Gets the name of the subnet used by each virtual machine in the agent pool.
abstract Map<String,String>	tags() Gets the tags of the agents.
abstract AgentPoolType	type() Gets agent pool type.
abstract ScaleSetEvictionPolicy	virtualMachineEvictionPolicy() Gets the eviction policy of each virtual machines in the agent pool.
abstract Double	virtualMachineMaximumPrice() Gets the maximum price of each spot virtual machines in the agent pool.
abstract ScaleSetPriority	virtualMachinePriority() Gets the priority of each virtual machines in the agent pool.
abstract ContainerServiceVMSizeTypes	vmSize() Gets size of each agent virtual machine in the agent pool.

Method Details

availabilityZones

public abstract List availabilityZones()

Gets the list of availability zones.

Returns:

the list of availability zones

count

public abstract int count()

Gets the number of agents (virtual machines) to host docker containers.

Returns:

the number of agents (virtual machines) to host docker containers

isAutoScalingEnabled

public abstract boolean isAutoScalingEnabled()

Checks whether auto-scaling is enabled.

Returns:

whether auto-scaling is enabled

kubeletDiskType

public abstract KubeletDiskType kubeletDiskType()

Gets the disk type for the placement.

Returns:

the disk type for the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage

maximumNodeSize

public abstract int maximumNodeSize()

Gets the maximum number of nodes for auto-scaling.

Returns:

the maximum number of nodes for auto-scaling

maximumPodsPerNode

public abstract int maximumPodsPerNode()

Gets the maximum number of pods per node.

Returns:

the maximum number of pods per node

minimumNodeSize

public abstract int minimumNodeSize()

Gets the minimum number of nodes for auto-scaling.

Returns:

the minimum number of nodes for auto-scaling

mode

public abstract AgentPoolMode mode()

Gets agent pool mode.

Returns:

agent pool mode

networkId

public abstract String networkId()

Gets the ID of the virtual network used by each virtual machine in the agent pool.

Returns:

the ID of the virtual network used by each virtual machine in the agent pool

nodeLabels

public abstract Map nodeLabels()

Gets the map of node labels.

Returns:

the map of node labels

nodeSize

public abstract int nodeSize()

Gets the number of agents (VMs) to host docker containers.

Returns:

the number of agents (VMs) to host docker containers

nodeTaints

public abstract List nodeTaints()

Gets the list of node taints.

Returns:

the list of node taints

osDiskSizeInGB

public abstract int osDiskSizeInGB()

Gets OS disk size in GB set for each virtual machine in the agent pool.

Returns:

OS disk size in GB set for each virtual machine in the agent pool

osDiskType

public abstract OSDiskType osDiskType()

Gets the OS disk type to be used for machines in the agent pool.

Returns:

the OS disk type to be used for machines in the agent pool

osType

public abstract OSType osType()

Gets OS of each virtual machine in the agent pool.

Returns:

OS of each virtual machine in the agent pool

powerState

public abstract PowerState powerState()

Gets the power state.

Returns:

the power state, Running or Stopped

provisioningState

public abstract String provisioningState()

Gets the provisioning state of the agent pool.

Returns:

the provisioning state of the agent pool

subnetName

public abstract String subnetName()

Gets the name of the subnet used by each virtual machine in the agent pool.

Returns:

the name of the subnet used by each virtual machine in the agent pool

tags

public abstract Map tags()

Gets the tags of the agents.

Returns:

the tags of the agents.

type

public abstract AgentPoolType type()

Gets agent pool type.

Returns:

agent pool type

virtualMachineEvictionPolicy

public abstract ScaleSetEvictionPolicy virtualMachineEvictionPolicy()

Gets the eviction policy of each virtual machines in the agent pool.

Returns:

the eviction policy of each virtual machines in the agent pool

virtualMachineMaximumPrice

public abstract Double virtualMachineMaximumPrice()

Gets the maximum price of each spot virtual machines in the agent pool.

Returns:

the maximum price of each spot virtual machines in the agent pool, -1 means pay-as-you-go prices

virtualMachinePriority

public abstract ScaleSetPriority virtualMachinePriority()

Gets the priority of each virtual machines in the agent pool.

Returns:

the priority of each virtual machines in the agent pool

vmSize

public abstract ContainerServiceVMSizeTypes vmSize()

Gets size of each agent virtual machine in the agent pool.

Returns:

size of each agent virtual machine in the agent pool