All Superinterfaces:
HasName
All Known Subinterfaces:
KubernetesClusterAgentPool
All Known Implementing Classes:
AgentPoolData

public interface AgentPool extends HasName
A client-side representation for an agent pool.
  • Method Details

    • provisioningState

      String provisioningState()
      Returns:
      the provisioning state of the agent pool
    • count

      int count()
      Returns:
      the number of agents (virtual machines) to host docker containers
    • vmSize

      Returns:
      size of each agent virtual machine in the agent pool
    • osDiskSizeInGB

      int osDiskSizeInGB()
      Returns:
      OS disk size in GB set for each virtual machine in the agent pool
    • osType

      OSType osType()
      Returns:
      OS of each virtual machine in the agent pool
    • type

      Returns:
      agent pool type
    • mode

      Returns:
      agent pool mode
    • subnetName

      String subnetName()
      Returns:
      the name of the subnet used by each virtual machine in the agent pool
    • networkId

      String networkId()
      Returns:
      the ID of the virtual network used by each virtual machine in the agent pool
    • availabilityZones

      List<String> availabilityZones()
      Returns:
      the list of availability zones
    • nodeLabels

      Map<String,String> nodeLabels()
      Returns:
      the map of node labels
    • nodeTaints

      List<String> nodeTaints()
      Returns:
      the list of node taints
    • powerState

      PowerState powerState()
      Returns:
      the power state, Running or Stopped
    • nodeSize

      int nodeSize()
      Returns:
      the number of agents (VMs) to host docker containers
    • maximumPodsPerNode

      int maximumPodsPerNode()
      Returns:
      the maximum number of pods per node
    • isAutoScalingEnabled

      boolean isAutoScalingEnabled()
      Returns:
      whether auto-scaling is enabled
    • minimumNodeSize

      int minimumNodeSize()
      Returns:
      the minimum number of nodes for auto-scaling
    • maximumNodeSize

      int maximumNodeSize()
      Returns:
      the maximum number of nodes for auto-scaling
    • virtualMachinePriority

      ScaleSetPriority virtualMachinePriority()
      Returns:
      the priority of each virtual machines in the agent pool
    • virtualMachineEvictionPolicy

      ScaleSetEvictionPolicy virtualMachineEvictionPolicy()
      Returns:
      the eviction policy of each virtual machines in the agent pool
    • virtualMachineMaximumPrice

      Double virtualMachineMaximumPrice()
      Returns:
      the maximum price of each spot virtual machines in the agent pool, -1 means pay-as-you-go prices
    • osDiskType

      OSDiskType osDiskType()
      Returns:
      the OS disk type to be used for machines in the agent pool
    • kubeletDiskType

      KubeletDiskType kubeletDiskType()
      Returns:
      the disk type for the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage
    • tags

      Map<String,String> tags()
      Returns:
      the tags of the agents.
    • isFipsEnabled

      boolean isFipsEnabled()
      Returns:
      whether FIPS-enabled OS is been used for agent pool's machines
      See Also: