AgentPool Interface

Implements

public interface AgentPool
extends HasName

A client-side representation for an agent pool.

Method Summary

Modifier and Type Method and Description
abstract List<String> availabilityZones()
abstract int count()
abstract boolean isAutoScalingEnabled()
abstract boolean isFipsEnabled()
abstract KubeletDiskType kubeletDiskType()
abstract int maximumNodeSize()
abstract int maximumPodsPerNode()
abstract int minimumNodeSize()
abstract AgentPoolMode mode()
abstract String networkId()
abstract Map<String,String> nodeLabels()
abstract int nodeSize()
abstract List<String> nodeTaints()
abstract int osDiskSizeInGB()
abstract OSDiskType osDiskType()
abstract OSType osType()
abstract PowerState powerState()
abstract String provisioningState()
abstract String subnetName()
abstract Map<String,String> tags()
abstract AgentPoolType type()
abstract ScaleSetEvictionPolicy virtualMachineEvictionPolicy()
abstract Double virtualMachineMaximumPrice()
abstract ScaleSetPriority virtualMachinePriority()
abstract ContainerServiceVMSizeTypes vmSize()

Method Details

availabilityZones

public abstract List availabilityZones()

Returns:

the list of availability zones

count

public abstract int count()

Returns:

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

isAutoScalingEnabled

public abstract boolean isAutoScalingEnabled()

Returns:

whether auto-scaling is enabled

isFipsEnabled

public abstract boolean isFipsEnabled()

Returns:

whether FIPS-enabled OS is been used for agent pool's machines

kubeletDiskType

public abstract KubeletDiskType kubeletDiskType()

Returns:

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

maximumNodeSize

public abstract int maximumNodeSize()

Returns:

the maximum number of nodes for auto-scaling

maximumPodsPerNode

public abstract int maximumPodsPerNode()

Returns:

the maximum number of pods per node

minimumNodeSize

public abstract int minimumNodeSize()

Returns:

the minimum number of nodes for auto-scaling

mode

public abstract AgentPoolMode mode()

Returns:

agent pool mode

networkId

public abstract String networkId()

Returns:

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

nodeLabels

public abstract Map nodeLabels()

Returns:

the map of node labels

nodeSize

public abstract int nodeSize()

Returns:

the number of agents (VMs) to host docker containers

nodeTaints

public abstract List nodeTaints()

Returns:

the list of node taints

osDiskSizeInGB

public abstract int osDiskSizeInGB()

Returns:

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

osDiskType

public abstract OSDiskType osDiskType()

Returns:

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

osType

public abstract OSType osType()

Returns:

OS of each virtual machine in the agent pool

powerState

public abstract PowerState powerState()

Returns:

the power state, Running or Stopped

provisioningState

public abstract String provisioningState()

Returns:

the provisioning state of the agent pool

subnetName

public abstract String subnetName()

Returns:

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

tags

public abstract Map tags()

Returns:

the tags of the agents.

type

public abstract AgentPoolType type()

Returns:

agent pool type

virtualMachineEvictionPolicy

public abstract ScaleSetEvictionPolicy virtualMachineEvictionPolicy()

Returns:

the eviction policy of each virtual machines in the agent pool

virtualMachineMaximumPrice

public abstract Double virtualMachineMaximumPrice()

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()

Returns:

the priority of each virtual machines in the agent pool

vmSize

public abstract ContainerServiceVMSizeTypes vmSize()

Returns:

size of each agent virtual machine in the agent pool

Applies to