Package com.azure.resourcemanager.containerservice.models

Class ManagedClusterAgentPoolProfile

java.lang.Object
com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties
com.azure.resourcemanager.containerservice.models.ManagedClusterAgentPoolProfile
public final class ManagedClusterAgentPoolProfile extends ManagedClusterAgentPoolProfileProperties
Profile for the container service agent pool.

  • Constructor Details

    • ManagedClusterAgentPoolProfile

      public ManagedClusterAgentPoolProfile()

  • Method Details

    • name

      public String name()
      Get the name property: Unique name of the agent pool profile in the context of the subscription and resource group.

      Windows agent pool names must be 6 characters or less.

      Returns:
      the name value.

    • withName

      public ManagedClusterAgentPoolProfile withName(String name)
      Set the name property: Unique name of the agent pool profile in the context of the subscription and resource group.

      Windows agent pool names must be 6 characters or less.

      Parameters:
      name - the name value to set.
      Returns:
      the ManagedClusterAgentPoolProfile object itself.

    • withCount

      public ManagedClusterAgentPoolProfile withCount(Integer count)
      Set the count property: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1.
      Overrides:
      withCount in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      count - the count value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withVmSize

      public ManagedClusterAgentPoolProfile withVmSize(String vmSize)
      Set the vmSize property: The size of the agent pool VMs.

      VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions.

      Overrides:
      withVmSize in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      vmSize - the vmSize value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withOsDiskSizeGB

      public ManagedClusterAgentPoolProfile withOsDiskSizeGB(Integer osDiskSizeGB)
      Set the osDiskSizeGB property: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.
      Overrides:
      withOsDiskSizeGB in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      osDiskSizeGB - the osDiskSizeGB value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withOsDiskType

      public ManagedClusterAgentPoolProfile withOsDiskType(OSDiskType osDiskType)
      Set the osDiskType property: The OS disk type to be used for machines in the agent pool.

      The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os).

      Overrides:
      withOsDiskType in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      osDiskType - the osDiskType value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withKubeletDiskType

      public ManagedClusterAgentPoolProfile withKubeletDiskType(KubeletDiskType kubeletDiskType)
      Set the kubeletDiskType property: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
      Overrides:
      withKubeletDiskType in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      kubeletDiskType - the kubeletDiskType value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withWorkloadRuntime

      public ManagedClusterAgentPoolProfile withWorkloadRuntime(WorkloadRuntime workloadRuntime)
      Set the workloadRuntime property: Determines the type of workload a node can run.
      Overrides:
      withWorkloadRuntime in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      workloadRuntime - the workloadRuntime value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withVnetSubnetId

      public ManagedClusterAgentPoolProfile withVnetSubnetId(String vnetSubnetId)
      Set the vnetSubnetId property: The ID of the subnet which agent pool nodes and optionally pods will join on startup.

      If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.

      Overrides:
      withVnetSubnetId in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      vnetSubnetId - the vnetSubnetId value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withPodSubnetId

      public ManagedClusterAgentPoolProfile withPodSubnetId(String podSubnetId)
      Set the podSubnetId property: The ID of the subnet which pods will join when launched.

      If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.

      Overrides:
      withPodSubnetId in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      podSubnetId - the podSubnetId value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withMaxPods

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

    • withOsType

      public ManagedClusterAgentPoolProfile withOsType(OSType osType)
      Set the osType property: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
      Overrides:
      withOsType in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      osType - the osType value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withOsSku

      public ManagedClusterAgentPoolProfile withOsSku(OSSku osSku)
      Set the osSku property: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
      Overrides:
      withOsSku in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      osSku - the osSku value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withMaxCount

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

    • withMinCount

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

    • withEnableAutoScaling

      public ManagedClusterAgentPoolProfile withEnableAutoScaling(Boolean enableAutoScaling)
      Set the enableAutoScaling property: Whether to enable auto-scaler.
      Overrides:
      withEnableAutoScaling in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      enableAutoScaling - the enableAutoScaling value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withScaleDownMode

      public ManagedClusterAgentPoolProfile withScaleDownMode(ScaleDownMode scaleDownMode)
      Set the scaleDownMode property: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
      Overrides:
      withScaleDownMode in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      scaleDownMode - the scaleDownMode value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withType

      public ManagedClusterAgentPoolProfile withType(AgentPoolType type)
      Set the type property: The type of Agent Pool.
      Overrides:
      withType in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      type - the type value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withMode

      public ManagedClusterAgentPoolProfile withMode(AgentPoolMode mode)
      Set the mode property: The mode of an agent pool.

      A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools.

      Overrides:
      withMode in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      mode - the mode value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withOrchestratorVersion

      public ManagedClusterAgentPoolProfile withOrchestratorVersion(String orchestratorVersion)
      Set the orchestratorVersion property: The version of Kubernetes specified by the user.

      Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool).

      Overrides:
      withOrchestratorVersion in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      orchestratorVersion - the orchestratorVersion value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withUpgradeSettings

      public ManagedClusterAgentPoolProfile withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)
      Set the upgradeSettings property: Settings for upgrading the agentpool.
      Overrides:
      withUpgradeSettings in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      upgradeSettings - the upgradeSettings value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withPowerState

      public ManagedClusterAgentPoolProfile withPowerState(PowerState powerState)
      Set the powerState property: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded.
      Overrides:
      withPowerState in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      powerState - the powerState value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withAvailabilityZones

      public ManagedClusterAgentPoolProfile withAvailabilityZones(List<String> availabilityZones)
      Set the availabilityZones property: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
      Overrides:
      withAvailabilityZones in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      availabilityZones - the availabilityZones value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withEnableNodePublicIp

      public ManagedClusterAgentPoolProfile withEnableNodePublicIp(Boolean enableNodePublicIp)
      Set the enableNodePublicIp property: Whether each node is allocated its own public IP.

      Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false.

      Overrides:
      withEnableNodePublicIp in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      enableNodePublicIp - the enableNodePublicIp value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withNodePublicIpPrefixId

      public ManagedClusterAgentPoolProfile withNodePublicIpPrefixId(String nodePublicIpPrefixId)
      Set the nodePublicIpPrefixId property: The public IP prefix ID which VM nodes should use IPs from.

      This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}.

      Overrides:
      withNodePublicIpPrefixId in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      nodePublicIpPrefixId - the nodePublicIpPrefixId value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withScaleSetPriority

      public ManagedClusterAgentPoolProfile withScaleSetPriority(ScaleSetPriority scaleSetPriority)
      Set the scaleSetPriority property: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
      Overrides:
      withScaleSetPriority in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      scaleSetPriority - the scaleSetPriority value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withScaleSetEvictionPolicy

      public ManagedClusterAgentPoolProfile withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)
      Set the scaleSetEvictionPolicy property: The Virtual Machine Scale Set eviction policy.

      This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

      Overrides:
      withScaleSetEvictionPolicy in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      scaleSetEvictionPolicy - the scaleSetEvictionPolicy value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withSpotMaxPrice

      public ManagedClusterAgentPoolProfile withSpotMaxPrice(Float spotMaxPrice)
      Set the spotMaxPrice property: The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.

      Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing).

      Overrides:
      withSpotMaxPrice in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      spotMaxPrice - the spotMaxPrice value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withTags

      public ManagedClusterAgentPoolProfile withTags(Map<String,String> tags)
      Set the tags property: The tags to be persisted on the agent pool virtual machine scale set.
      Overrides:
      withTags in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      tags - the tags value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withNodeLabels

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

    • withNodeTaints

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

    • withProximityPlacementGroupId

      public ManagedClusterAgentPoolProfile withProximityPlacementGroupId(String proximityPlacementGroupId)
      Set the proximityPlacementGroupId property: The ID for Proximity Placement Group.
      Overrides:
      withProximityPlacementGroupId in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      proximityPlacementGroupId - the proximityPlacementGroupId value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withKubeletConfig

      public ManagedClusterAgentPoolProfile withKubeletConfig(KubeletConfig kubeletConfig)
      Set the kubeletConfig property: Kubelet configurations of agent nodes.

      The Kubelet configuration on the agent pool nodes.

      Overrides:
      withKubeletConfig in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      kubeletConfig - the kubeletConfig value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withLinuxOSConfig

      public ManagedClusterAgentPoolProfile withLinuxOSConfig(LinuxOSConfig linuxOSConfig)
      Set the linuxOSConfig property: OS configurations of Linux agent nodes.

      The OS configuration of Linux agent nodes.

      Overrides:
      withLinuxOSConfig in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      linuxOSConfig - the linuxOSConfig value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withEnableEncryptionAtHost

      public ManagedClusterAgentPoolProfile withEnableEncryptionAtHost(Boolean enableEncryptionAtHost)
      Set the enableEncryptionAtHost property: Whether to enable host based OS and data drive encryption.

      This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption.

      Overrides:
      withEnableEncryptionAtHost in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      enableEncryptionAtHost - the enableEncryptionAtHost value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withEnableUltraSsd

      public ManagedClusterAgentPoolProfile withEnableUltraSsd(Boolean enableUltraSsd)
      Set the enableUltraSsd property: Whether to enable UltraSSD.
      Overrides:
      withEnableUltraSsd in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      enableUltraSsd - the enableUltraSsd value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withEnableFips

      public ManagedClusterAgentPoolProfile withEnableFips(Boolean enableFips)
      Set the enableFips property: Whether to use a FIPS-enabled OS.

      See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details.

      Overrides:
      withEnableFips in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      enableFips - the enableFips value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withGpuInstanceProfile

      public ManagedClusterAgentPoolProfile withGpuInstanceProfile(GpuInstanceProfile gpuInstanceProfile)
      Set the gpuInstanceProfile property: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
      Overrides:
      withGpuInstanceProfile in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      gpuInstanceProfile - the gpuInstanceProfile value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withCreationData

      public ManagedClusterAgentPoolProfile withCreationData(CreationData creationData)
      Set the creationData property: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
      Overrides:
      withCreationData in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      creationData - the creationData value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • withHostGroupId

      public ManagedClusterAgentPoolProfile withHostGroupId(String hostGroupId)
      Set the hostGroupId property: The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.

      This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts).

      Overrides:
      withHostGroupId in class ManagedClusterAgentPoolProfileProperties
      Parameters:
      hostGroupId - the hostGroupId value to set.
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • validate

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