Package com.azure.resourcemanager.containerservice.models

Interface AgentPool

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()
      Gets the provisioning state of the agent pool.
      Returns:
      the provisioning state of the agent pool

    • count

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

    • vmSize

      ContainerServiceVMSizeTypes vmSize()
      Gets size of each agent virtual machine in the agent pool.
      Returns:
      size of each agent virtual machine in the agent pool

    • osDiskSizeInGB

      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

    • osType

      OSType osType()
      Gets OS of each virtual machine in the agent pool.
      Returns:
      OS of each virtual machine in the agent pool

    • type

      AgentPoolType type()
      Gets agent pool type.
      Returns:
      agent pool type

    • mode

      AgentPoolMode mode()
      Gets agent pool mode.
      Returns:
      agent pool mode

    • subnetName

      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

    • networkId

      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

    • availabilityZones

      List<String> availabilityZones()
      Gets the list of availability zones.
      Returns:
      the list of availability zones

    • nodeLabels

      Map<String,String> nodeLabels()
      Gets the map of node labels.
      Returns:
      the map of node labels

    • nodeTaints

      List<String> nodeTaints()
      Gets the list of node taints.
      Returns:
      the list of node taints

    • powerState

      PowerState powerState()
      Gets the power state.
      Returns:
      the power state, Running or Stopped

    • nodeSize

      int nodeSize()
      Gets the number of agents (VMs) to host docker containers.
      Returns:
      the number of agents (VMs) to host docker containers

    • maximumPodsPerNode

      int maximumPodsPerNode()
      Gets the maximum number of pods per node.
      Returns:
      the maximum number of pods per node

    • isAutoScalingEnabled

      boolean isAutoScalingEnabled()
      Checks whether auto-scaling is enabled.
      Returns:
      whether auto-scaling is enabled

    • minimumNodeSize

      int minimumNodeSize()
      Gets the minimum number of nodes for auto-scaling.
      Returns:
      the minimum number of nodes for auto-scaling

    • maximumNodeSize

      int maximumNodeSize()
      Gets the maximum number of nodes for auto-scaling.
      Returns:
      the maximum number of nodes for auto-scaling

    • virtualMachinePriority

      ScaleSetPriority virtualMachinePriority()
      Gets the priority of each virtual machines in the agent pool.
      Returns:
      the priority of each virtual machines in the agent pool

    • virtualMachineEvictionPolicy

      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

      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

    • osDiskType

      OSDiskType osDiskType()
      Gets the maximum price of each spot virtual machines in the agent pool.
      Returns:
      the OS disk type to be used for machines in the agent pool

    • kubeletDiskType

      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

    • tags

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

    • isFipsEnabled

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