Package com.azure.resourcemanager.hybridcontainerservice.models

Interface AgentPool

public interface AgentPool
An immutable client-side representation of AgentPool.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    AgentPool.Definition
    The entirety of the AgentPool definition.
    static interface 
    AgentPool.DefinitionStages
    The AgentPool definition stages.
    static interface 
    AgentPool.Update
    The template for AgentPool update.
    static interface 
    AgentPool.UpdateStages
    The AgentPool update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    availabilityZones()
    Gets the availabilityZones property: AvailabilityZones - The list of Availability zones to use for nodes.
    CloudProviderProfile
    cloudProviderProfile()
    Gets the cloudProviderProfile property: The underlying cloud infra provider properties.
    Integer
    count()
    Gets the count property: Count - Number of agents to host docker containers.
    AgentPoolExtendedLocation
    extendedLocation()
    Gets the extendedLocation property: The extendedLocation property.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    AgentPoolInner
    innerModel()
    Gets the inner com.azure.resourcemanager.hybridcontainerservice.fluent.models.AgentPoolInner object.
    String
    location()
    Gets the location property: The geo-location where the resource lives.
    Integer
    maxCount()
    Gets the maxCount property: The maximum number of nodes for auto-scaling.
    Integer
    maxPods()
    Gets the maxPods property: The maximum number of pods that can run on a node.
    Integer
    minCount()
    Gets the minCount property: The minimum number of nodes for auto-scaling.
    Mode
    mode()
    Gets the mode property: Mode - AgentPoolMode represents mode of an agent pool.
    String
    name()
    Gets the name property: The name of the resource.
    String
    nodeImageVersion()
    Gets the nodeImageVersion property: The version of node image.
    Map<String,String>
    nodeLabels()
    Gets the nodeLabels property: NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
    List<String>
    nodeTaints()
    Gets the nodeTaints property: NodeTaints - Taints added to new nodes during node pool create and scale.
    OsType
    osType()
    Gets the osType property: OsType - OsType to be used to specify os type.
    AgentPoolProvisioningState
    provisioningState()
    Gets the provisioningState property: The provisioningState property.
    AgentPool
    refresh()
    Refreshes the resource to sync with Azure.
    AgentPool
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    com.azure.core.management.Region
    region()
    Gets the region of the resource.
    String
    regionName()
    Gets the name of the resource region.
    String
    resourceGroupName()
    Gets the name of the resource group.
    AgentPoolProvisioningStatusStatus
    status()
    Gets the status property: HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
    Map<String,String>
    tags()
    Gets the tags property: Resource tags.
    String
    type()
    Gets the type property: The type of the resource.
    AgentPool.Update
    update()
    Begins update for the AgentPool resource.
    String
    vmSize()
    Gets the vmSize property: VmSize - The size of the agent pool VMs.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.

    • extendedLocation

      AgentPoolExtendedLocation extendedLocation()
      Gets the extendedLocation property: The extendedLocation property.
      Returns:
      the extendedLocation value.

    • provisioningState

      AgentPoolProvisioningState provisioningState()
      Gets the provisioningState property: The provisioningState property.
      Returns:
      the provisioningState value.

    • status

      AgentPoolProvisioningStatusStatus status()
      Gets the status property: HybridAKSNodePoolStatus defines the observed state of HybridAKSNodePool.
      Returns:
      the status value.

    • count

      Integer count()
      Gets the count property: Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
      Returns:
      the count value.

    • availabilityZones

      List<String> availabilityZones()
      Gets the availabilityZones property: AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones.
      Returns:
      the availabilityZones value.

    • maxCount

      Integer maxCount()
      Gets the maxCount property: The maximum number of nodes for auto-scaling.
      Returns:
      the maxCount value.

    • maxPods

      Integer maxPods()
      Gets the maxPods property: The maximum number of pods that can run on a node.
      Returns:
      the maxPods value.

    • minCount

      Integer minCount()
      Gets the minCount property: The minimum number of nodes for auto-scaling.
      Returns:
      the minCount value.

    • mode

      Mode mode()
      Gets the mode property: Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'.
      Returns:
      the mode value.

    • nodeLabels

      Map<String,String> nodeLabels()
      Gets the nodeLabels property: NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
      Returns:
      the nodeLabels value.

    • nodeTaints

      List<String> nodeTaints()
      Gets the nodeTaints property: NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
      Returns:
      the nodeTaints value.

    • osType

      OsType osType()
      Gets the osType property: OsType - OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'.
      Returns:
      the osType value.

    • nodeImageVersion

      String nodeImageVersion()
      Gets the nodeImageVersion property: The version of node image.
      Returns:
      the nodeImageVersion value.

    • vmSize

      String vmSize()
      Gets the vmSize property: VmSize - The size of the agent pool VMs.
      Returns:
      the vmSize value.

    • cloudProviderProfile

      CloudProviderProfile cloudProviderProfile()
      Gets the cloudProviderProfile property: The underlying cloud infra provider properties.
      Returns:
      the cloudProviderProfile value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      AgentPoolInner innerModel()
      Gets the inner com.azure.resourcemanager.hybridcontainerservice.fluent.models.AgentPoolInner object.
      Returns:
      the inner object.

    • update

      AgentPool.Update update()
      Begins update for the AgentPool resource.
      Returns:
      the stage of resource update.

    • refresh

      AgentPool refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      AgentPool refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.