Class ManagedClusterAgentPoolProfileResponse


  • public final class ManagedClusterAgentPoolProfileResponse
    extends java.lang.Object
    • Method Detail

      • availabilityZones

        public java.util.List<java.lang.String> availabilityZones()
        Returns:
        The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
      • count

        public java.util.Optional<java.lang.Integer> count()
        Returns:
        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.
      • creationData

        public java.util.Optional<CreationDataResponse> creationData()
        Returns:
        CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
      • currentOrchestratorVersion

        public java.lang.String currentOrchestratorVersion()
        Returns:
        If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.
      • enableAutoScaling

        public java.util.Optional<java.lang.Boolean> enableAutoScaling()
        Returns:
        Whether to enable auto-scaler
      • enableEncryptionAtHost

        public java.util.Optional<java.lang.Boolean> enableEncryptionAtHost()
        Returns:
        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
      • enableFIPS

        public java.util.Optional<java.lang.Boolean> enableFIPS()
        Returns:
        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.
      • enableNodePublicIP

        public java.util.Optional<java.lang.Boolean> enableNodePublicIP()
        Returns:
        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.
      • enableUltraSSD

        public java.util.Optional<java.lang.Boolean> enableUltraSSD()
        Returns:
        Whether to enable UltraSSD
      • gpuInstanceProfile

        public java.util.Optional<java.lang.String> gpuInstanceProfile()
        Returns:
        GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
      • hostGroupID

        public java.util.Optional<java.lang.String> hostGroupID()
        Returns:
        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).
      • kubeletConfig

        public java.util.Optional<KubeletConfigResponse> kubeletConfig()
        Returns:
        The Kubelet configuration on the agent pool nodes.
      • kubeletDiskType

        public java.util.Optional<java.lang.String> kubeletDiskType()
        Returns:
        Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
      • linuxOSConfig

        public java.util.Optional<LinuxOSConfigResponse> linuxOSConfig()
        Returns:
        The OS configuration of Linux agent nodes.
      • maxCount

        public java.util.Optional<java.lang.Integer> maxCount()
        Returns:
        The maximum number of nodes for auto-scaling
      • maxPods

        public java.util.Optional<java.lang.Integer> maxPods()
        Returns:
        The maximum number of pods that can run on a node.
      • minCount

        public java.util.Optional<java.lang.Integer> minCount()
        Returns:
        The minimum number of nodes for auto-scaling
      • mode

        public java.util.Optional<java.lang.String> mode()
        Returns:
        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
      • name

        public java.lang.String name()
        Returns:
        Windows agent pool names must be 6 characters or less.
      • nodeImageVersion

        public java.lang.String nodeImageVersion()
        Returns:
        The version of node image
      • nodeLabels

        public java.util.Map<java.lang.String,​java.lang.String> nodeLabels()
        Returns:
        The node labels to be persisted across all nodes in agent pool.
      • nodePublicIPPrefixID

        public java.util.Optional<java.lang.String> nodePublicIPPrefixID()
        Returns:
        This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
      • nodeTaints

        public java.util.List<java.lang.String> nodeTaints()
        Returns:
        The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
      • orchestratorVersion

        public java.util.Optional<java.lang.String> orchestratorVersion()
        Returns:
        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).
      • osDiskSizeGB

        public java.util.Optional<java.lang.Integer> osDiskSizeGB()
        Returns:
        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.
      • osDiskType

        public java.util.Optional<java.lang.String> osDiskType()
        Returns:
        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).
      • osSKU

        public java.util.Optional<java.lang.String> osSKU()
        Returns:
        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.
      • osType

        public java.util.Optional<java.lang.String> osType()
        Returns:
        The operating system type. The default is Linux.
      • podSubnetID

        public java.util.Optional<java.lang.String> podSubnetID()
        Returns:
        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}
      • powerState

        public java.util.Optional<PowerStateResponse> powerState()
        Returns:
        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
      • provisioningState

        public java.lang.String provisioningState()
        Returns:
        The current deployment or provisioning state.
      • proximityPlacementGroupID

        public java.util.Optional<java.lang.String> proximityPlacementGroupID()
        Returns:
        The ID for Proximity Placement Group.
      • scaleDownMode

        public java.util.Optional<java.lang.String> scaleDownMode()
        Returns:
        This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
      • scaleSetEvictionPolicy

        public java.util.Optional<java.lang.String> scaleSetEvictionPolicy()
        Returns:
        This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
      • scaleSetPriority

        public java.util.Optional<java.lang.String> scaleSetPriority()
        Returns:
        The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
      • spotMaxPrice

        public java.util.Optional<java.lang.Double> spotMaxPrice()
        Returns:
        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)
      • tags

        public java.util.Map<java.lang.String,​java.lang.String> tags()
        Returns:
        The tags to be persisted on the agent pool virtual machine scale set.
      • type

        public java.util.Optional<java.lang.String> type()
        Returns:
        The type of Agent Pool.
      • vmSize

        public java.util.Optional<java.lang.String> vmSize()
        Returns:
        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
      • vnetSubnetID

        public java.util.Optional<java.lang.String> vnetSubnetID()
        Returns:
        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}
      • workloadRuntime

        public java.util.Optional<java.lang.String> workloadRuntime()
        Returns:
        Determines the type of workload a node can run.