Package com.azure.resourcemanager.hybridcontainerservice.models

Class ControlPlaneProfile

java.lang.Object
com.azure.resourcemanager.hybridcontainerservice.models.AgentPoolProfile
com.azure.resourcemanager.hybridcontainerservice.models.NamedAgentPoolProfile
com.azure.resourcemanager.hybridcontainerservice.models.ControlPlaneProfile
public final class ControlPlaneProfile extends NamedAgentPoolProfile
ControlPlaneProfile - The control plane properties for the provisioned cluster.

  • Constructor Details

    • ControlPlaneProfile

      public ControlPlaneProfile()
      Creates an instance of ControlPlaneProfile class.

  • Method Details

    • controlPlaneEndpoint

      public ControlPlaneEndpointProfileControlPlaneEndpoint controlPlaneEndpoint()
      Get the controlPlaneEndpoint property: API server endpoint for the control plane.
      Returns:
      the controlPlaneEndpoint value.

    • withControlPlaneEndpoint

      public ControlPlaneProfile withControlPlaneEndpoint(ControlPlaneEndpointProfileControlPlaneEndpoint controlPlaneEndpoint)
      Set the controlPlaneEndpoint property: API server endpoint for the control plane.
      Parameters:
      controlPlaneEndpoint - the controlPlaneEndpoint value to set.
      Returns:
      the ControlPlaneProfile object itself.

    • linuxProfile

      public LinuxProfileProperties linuxProfile()
      Get the linuxProfile property: Profile for Linux VMs in the container service cluster.
      Returns:
      the linuxProfile value.

    • withLinuxProfile

      public ControlPlaneProfile withLinuxProfile(LinuxProfileProperties linuxProfile)
      Set the linuxProfile property: Profile for Linux VMs in the container service cluster.
      Parameters:
      linuxProfile - the linuxProfile value to set.
      Returns:
      the ControlPlaneProfile object itself.

    • withName

      public ControlPlaneProfile withName(String name)
      Set the name property: Unique name of the agent pool profile in the context of the subscription and resource group.
      Overrides:
      withName in class NamedAgentPoolProfile
      Parameters:
      name - the name value to set.
      Returns:
      the NamedAgentPoolProfile object itself.

    • withCount

      public ControlPlaneProfile withCount(Integer count)
      Set 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.
      Overrides:
      withCount in class NamedAgentPoolProfile
      Parameters:
      count - the count value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withAvailabilityZones

      public ControlPlaneProfile withAvailabilityZones(List<String> availabilityZones)
      Set the availabilityZones property: AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones.
      Overrides:
      withAvailabilityZones in class NamedAgentPoolProfile
      Parameters:
      availabilityZones - the availabilityZones value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withMaxCount

      public ControlPlaneProfile withMaxCount(Integer maxCount)
      Set the maxCount property: The maximum number of nodes for auto-scaling.
      Overrides:
      withMaxCount in class NamedAgentPoolProfile
      Parameters:
      maxCount - the maxCount value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withMaxPods

      public ControlPlaneProfile withMaxPods(Integer maxPods)
      Set the maxPods property: The maximum number of pods that can run on a node.
      Overrides:
      withMaxPods in class NamedAgentPoolProfile
      Parameters:
      maxPods - the maxPods value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withMinCount

      public ControlPlaneProfile withMinCount(Integer minCount)
      Set the minCount property: The minimum number of nodes for auto-scaling.
      Overrides:
      withMinCount in class NamedAgentPoolProfile
      Parameters:
      minCount - the minCount value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withMode

      public ControlPlaneProfile withMode(Mode mode)
      Set the mode property: Mode - AgentPoolMode represents mode of an agent pool. Possible values include: 'System', 'LB', 'User'. Default is 'User'.
      Overrides:
      withMode in class NamedAgentPoolProfile
      Parameters:
      mode - the mode value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withNodeLabels

      public ControlPlaneProfile withNodeLabels(Map<String,String> nodeLabels)
      Set the nodeLabels property: NodeLabels - Agent pool node labels to be persisted across all nodes in agent pool.
      Overrides:
      withNodeLabels in class NamedAgentPoolProfile
      Parameters:
      nodeLabels - the nodeLabels value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withNodeTaints

      public ControlPlaneProfile withNodeTaints(List<String> nodeTaints)
      Set the nodeTaints property: NodeTaints - Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
      Overrides:
      withNodeTaints in class NamedAgentPoolProfile
      Parameters:
      nodeTaints - the nodeTaints value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withOsType

      public ControlPlaneProfile withOsType(OsType osType)
      Set 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'.
      Overrides:
      withOsType in class NamedAgentPoolProfile
      Parameters:
      osType - the osType value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withNodeImageVersion

      public ControlPlaneProfile withNodeImageVersion(String nodeImageVersion)
      Set the nodeImageVersion property: The version of node image.
      Overrides:
      withNodeImageVersion in class NamedAgentPoolProfile
      Parameters:
      nodeImageVersion - the nodeImageVersion value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withVmSize

      public ControlPlaneProfile withVmSize(String vmSize)
      Set the vmSize property: VmSize - The size of the agent pool VMs.
      Overrides:
      withVmSize in class NamedAgentPoolProfile
      Parameters:
      vmSize - the vmSize value to set.
      Returns:
      the AgentPoolProfile object itself.

    • withCloudProviderProfile

      public ControlPlaneProfile withCloudProviderProfile(CloudProviderProfile cloudProviderProfile)
      Set the cloudProviderProfile property: The underlying cloud infra provider properties.
      Overrides:
      withCloudProviderProfile in class NamedAgentPoolProfile
      Parameters:
      cloudProviderProfile - the cloudProviderProfile value to set.
      Returns:
      the AgentPoolProfile object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class NamedAgentPoolProfile
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.