Package com.azure.resourcemanager.containerservice.fluent.models

Class AgentPoolInner

java.lang.Object
com.azure.core.management.SubResource
com.azure.resourcemanager.containerservice.fluent.models.AgentPoolInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.SubResource>
public final class AgentPoolInner extends com.azure.core.management.SubResource
Agent Pool.

  • Constructor Details

    • AgentPoolInner

      public AgentPoolInner()
      Creates an instance of AgentPoolInner class.

  • Method Details

    • name

      public String name()
      Get the name property: The name of the resource that is unique within a resource group. This name can be used to access the resource.
      Returns:
      the name value.

    • type

      public String type()
      Get the type property: Resource type.
      Returns:
      the type value.

    • withId

      public AgentPoolInner withId(String id)
      Overrides:
      withId in class com.azure.core.management.SubResource

    • etag

      public String etag()
      Get the etag property: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.
      Returns:
      the etag value.

    • count

      public Integer count()
      Get 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.
      Returns:
      the count value.

    • withCount

      public AgentPoolInner 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.
      Parameters:
      count - the count value to set.
      Returns:
      the AgentPoolInner object itself.

    • vmSize

      public String vmSize()
      Get the vmSize property: 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.
      Returns:
      the vmSize value.

    • withVmSize

      public AgentPoolInner withVmSize(String vmSize)
      Set the vmSize property: 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.
      Parameters:
      vmSize - the vmSize value to set.
      Returns:
      the AgentPoolInner object itself.

    • osDiskSizeGB

      public Integer osDiskSizeGB()
      Get 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.
      Returns:
      the osDiskSizeGB value.

    • withOsDiskSizeGB

      public AgentPoolInner 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.
      Parameters:
      osDiskSizeGB - the osDiskSizeGB value to set.
      Returns:
      the AgentPoolInner object itself.

    • osDiskType

      public OSDiskType osDiskType()
      Get the osDiskType property: 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).
      Returns:
      the osDiskType value.

    • withOsDiskType

      public AgentPoolInner withOsDiskType(OSDiskType osDiskType)
      Set the osDiskType property: 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).
      Parameters:
      osDiskType - the osDiskType value to set.
      Returns:
      the AgentPoolInner object itself.

    • kubeletDiskType

      public KubeletDiskType kubeletDiskType()
      Get the kubeletDiskType property: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
      Returns:
      the kubeletDiskType value.

    • withKubeletDiskType

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

    • workloadRuntime

      public WorkloadRuntime workloadRuntime()
      Get the workloadRuntime property: Determines the type of workload a node can run.
      Returns:
      the workloadRuntime value.

    • withWorkloadRuntime

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

    • messageOfTheDay

      public String messageOfTheDay()
      Get the messageOfTheDay property: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
      Returns:
      the messageOfTheDay value.

    • withMessageOfTheDay

      public AgentPoolInner withMessageOfTheDay(String messageOfTheDay)
      Set the messageOfTheDay property: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
      Parameters:
      messageOfTheDay - the messageOfTheDay value to set.
      Returns:
      the AgentPoolInner object itself.

    • vnetSubnetId

      public String vnetSubnetId()
      Get the vnetSubnetId property: 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}.
      Returns:
      the vnetSubnetId value.

    • withVnetSubnetId

      public AgentPoolInner withVnetSubnetId(String vnetSubnetId)
      Set the vnetSubnetId property: 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}.
      Parameters:
      vnetSubnetId - the vnetSubnetId value to set.
      Returns:
      the AgentPoolInner object itself.

    • podSubnetId

      public String podSubnetId()
      Get the podSubnetId property: 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}.
      Returns:
      the podSubnetId value.

    • withPodSubnetId

      public AgentPoolInner withPodSubnetId(String podSubnetId)
      Set the podSubnetId property: 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}.
      Parameters:
      podSubnetId - the podSubnetId value to set.
      Returns:
      the AgentPoolInner object itself.

    • podIpAllocationMode

      public PodIpAllocationMode podIpAllocationMode()
      Get the podIpAllocationMode property: The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
      Returns:
      the podIpAllocationMode value.

    • withPodIpAllocationMode

      public AgentPoolInner withPodIpAllocationMode(PodIpAllocationMode podIpAllocationMode)
      Set the podIpAllocationMode property: The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
      Parameters:
      podIpAllocationMode - the podIpAllocationMode value to set.
      Returns:
      the AgentPoolInner object itself.

    • maxPods

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

    • withMaxPods

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

    • osType

      public OSType osType()
      Get the osType property: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
      Returns:
      the osType value.

    • withOsType

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

    • osSku

      public OSSku osSku()
      Get 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.
      Returns:
      the osSku value.

    • withOsSku

      public AgentPoolInner 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.
      Parameters:
      osSku - the osSku value to set.
      Returns:
      the AgentPoolInner object itself.

    • maxCount

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

    • withMaxCount

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

    • minCount

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

    • withMinCount

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

    • enableAutoScaling

      public Boolean enableAutoScaling()
      Get the enableAutoScaling property: Whether to enable auto-scaler.
      Returns:
      the enableAutoScaling value.

    • withEnableAutoScaling

      public AgentPoolInner withEnableAutoScaling(Boolean enableAutoScaling)
      Set the enableAutoScaling property: Whether to enable auto-scaler.
      Parameters:
      enableAutoScaling - the enableAutoScaling value to set.
      Returns:
      the AgentPoolInner object itself.

    • scaleDownMode

      public ScaleDownMode scaleDownMode()
      Get the scaleDownMode property: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
      Returns:
      the scaleDownMode value.

    • withScaleDownMode

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

    • typePropertiesType

      public AgentPoolType typePropertiesType()
      Get the type property: The type of Agent Pool.
      Returns:
      the type value.

    • withTypePropertiesType

      public AgentPoolInner withTypePropertiesType(AgentPoolType type)
      Set the type property: The type of Agent Pool.
      Parameters:
      type - the type value to set.
      Returns:
      the AgentPoolInner object itself.

    • mode

      public AgentPoolMode mode()
      Get the mode property: 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.
      Returns:
      the mode value.

    • withMode

      public AgentPoolInner withMode(AgentPoolMode mode)
      Set the mode property: 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.
      Parameters:
      mode - the mode value to set.
      Returns:
      the AgentPoolInner object itself.

    • orchestratorVersion

      public String orchestratorVersion()
      Get the orchestratorVersion property: 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).
      Returns:
      the orchestratorVersion value.

    • withOrchestratorVersion

      public AgentPoolInner withOrchestratorVersion(String orchestratorVersion)
      Set the orchestratorVersion property: 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).
      Parameters:
      orchestratorVersion - the orchestratorVersion value to set.
      Returns:
      the AgentPoolInner object itself.

    • currentOrchestratorVersion

      public String currentOrchestratorVersion()
      Get the currentOrchestratorVersion property: 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.
      Returns:
      the currentOrchestratorVersion value.

    • nodeImageVersion

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

    • upgradeSettings

      public AgentPoolUpgradeSettings upgradeSettings()
      Get the upgradeSettings property: Settings for upgrading the agentpool.
      Returns:
      the upgradeSettings value.

    • withUpgradeSettings

      public AgentPoolInner withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)
      Set the upgradeSettings property: Settings for upgrading the agentpool.
      Parameters:
      upgradeSettings - the upgradeSettings value to set.
      Returns:
      the AgentPoolInner object itself.

    • provisioningState

      public String provisioningState()
      Get the provisioningState property: The current deployment or provisioning state.
      Returns:
      the provisioningState value.

    • powerState

      public PowerState powerState()
      Get 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.
      Returns:
      the powerState value.

    • withPowerState

      public AgentPoolInner 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.
      Parameters:
      powerState - the powerState value to set.
      Returns:
      the AgentPoolInner object itself.

    • availabilityZones

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

    • withAvailabilityZones

      public AgentPoolInner 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'.
      Parameters:
      availabilityZones - the availabilityZones value to set.
      Returns:
      the AgentPoolInner object itself.

    • enableNodePublicIp

      public Boolean enableNodePublicIp()
      Get the enableNodePublicIp property: 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.
      Returns:
      the enableNodePublicIp value.

    • withEnableNodePublicIp

      public AgentPoolInner withEnableNodePublicIp(Boolean enableNodePublicIp)
      Set the enableNodePublicIp property: 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.
      Parameters:
      enableNodePublicIp - the enableNodePublicIp value to set.
      Returns:
      the AgentPoolInner object itself.

    • nodePublicIpPrefixId

      public String nodePublicIpPrefixId()
      Get the nodePublicIpPrefixId property: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}.
      Returns:
      the nodePublicIpPrefixId value.

    • withNodePublicIpPrefixId

      public AgentPoolInner withNodePublicIpPrefixId(String nodePublicIpPrefixId)
      Set the nodePublicIpPrefixId property: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}.
      Parameters:
      nodePublicIpPrefixId - the nodePublicIpPrefixId value to set.
      Returns:
      the AgentPoolInner object itself.

    • scaleSetPriority

      public ScaleSetPriority scaleSetPriority()
      Get the scaleSetPriority property: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
      Returns:
      the scaleSetPriority value.

    • withScaleSetPriority

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

    • scaleSetEvictionPolicy

      public ScaleSetEvictionPolicy scaleSetEvictionPolicy()
      Get the scaleSetEvictionPolicy property: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
      Returns:
      the scaleSetEvictionPolicy value.

    • withScaleSetEvictionPolicy

      public AgentPoolInner withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)
      Set the scaleSetEvictionPolicy property: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
      Parameters:
      scaleSetEvictionPolicy - the scaleSetEvictionPolicy value to set.
      Returns:
      the AgentPoolInner object itself.

    • spotMaxPrice

      public Float spotMaxPrice()
      Get the spotMaxPrice property: 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).
      Returns:
      the spotMaxPrice value.

    • withSpotMaxPrice

      public AgentPoolInner withSpotMaxPrice(Float spotMaxPrice)
      Set the spotMaxPrice property: 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).
      Parameters:
      spotMaxPrice - the spotMaxPrice value to set.
      Returns:
      the AgentPoolInner object itself.

    • tags

      public Map<String,String> tags()
      Get the tags property: The tags to be persisted on the agent pool virtual machine scale set.
      Returns:
      the tags value.

    • withTags

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

    • nodeLabels

      public Map<String,String> nodeLabels()
      Get the nodeLabels property: The node labels to be persisted across all nodes in agent pool.
      Returns:
      the nodeLabels value.

    • withNodeLabels

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

    • nodeTaints

      public List<String> nodeTaints()
      Get the nodeTaints property: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
      Returns:
      the nodeTaints value.

    • withNodeTaints

      public AgentPoolInner 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.
      Parameters:
      nodeTaints - the nodeTaints value to set.
      Returns:
      the AgentPoolInner object itself.

    • proximityPlacementGroupId

      public String proximityPlacementGroupId()
      Get the proximityPlacementGroupId property: The ID for Proximity Placement Group.
      Returns:
      the proximityPlacementGroupId value.

    • withProximityPlacementGroupId

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

    • kubeletConfig

      public KubeletConfig kubeletConfig()
      Get the kubeletConfig property: The Kubelet configuration on the agent pool nodes.
      Returns:
      the kubeletConfig value.

    • withKubeletConfig

      public AgentPoolInner withKubeletConfig(KubeletConfig kubeletConfig)
      Set the kubeletConfig property: The Kubelet configuration on the agent pool nodes.
      Parameters:
      kubeletConfig - the kubeletConfig value to set.
      Returns:
      the AgentPoolInner object itself.

    • linuxOSConfig

      public LinuxOSConfig linuxOSConfig()
      Get the linuxOSConfig property: The OS configuration of Linux agent nodes.
      Returns:
      the linuxOSConfig value.

    • withLinuxOSConfig

      public AgentPoolInner withLinuxOSConfig(LinuxOSConfig linuxOSConfig)
      Set the linuxOSConfig property: The OS configuration of Linux agent nodes.
      Parameters:
      linuxOSConfig - the linuxOSConfig value to set.
      Returns:
      the AgentPoolInner object itself.

    • enableEncryptionAtHost

      public Boolean enableEncryptionAtHost()
      Get the enableEncryptionAtHost property: 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.
      Returns:
      the enableEncryptionAtHost value.

    • withEnableEncryptionAtHost

      public AgentPoolInner withEnableEncryptionAtHost(Boolean enableEncryptionAtHost)
      Set the enableEncryptionAtHost property: 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.
      Parameters:
      enableEncryptionAtHost - the enableEncryptionAtHost value to set.
      Returns:
      the AgentPoolInner object itself.

    • enableUltraSsd

      public Boolean enableUltraSsd()
      Get the enableUltraSsd property: Whether to enable UltraSSD.
      Returns:
      the enableUltraSsd value.

    • withEnableUltraSsd

      public AgentPoolInner withEnableUltraSsd(Boolean enableUltraSsd)
      Set the enableUltraSsd property: Whether to enable UltraSSD.
      Parameters:
      enableUltraSsd - the enableUltraSsd value to set.
      Returns:
      the AgentPoolInner object itself.

    • enableFips

      public Boolean enableFips()
      Get the enableFips property: 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.
      Returns:
      the enableFips value.

    • withEnableFips

      public AgentPoolInner withEnableFips(Boolean enableFips)
      Set the enableFips property: 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.
      Parameters:
      enableFips - the enableFips value to set.
      Returns:
      the AgentPoolInner object itself.

    • gpuInstanceProfile

      public GpuInstanceProfile gpuInstanceProfile()
      Get the gpuInstanceProfile property: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
      Returns:
      the gpuInstanceProfile value.

    • withGpuInstanceProfile

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

    • creationData

      public CreationData creationData()
      Get the creationData property: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
      Returns:
      the creationData value.

    • withCreationData

      public AgentPoolInner 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.
      Parameters:
      creationData - the creationData value to set.
      Returns:
      the AgentPoolInner object itself.

    • capacityReservationGroupId

      public String capacityReservationGroupId()
      Get the capacityReservationGroupId property: AKS will associate the specified agent pool with the Capacity Reservation Group.
      Returns:
      the capacityReservationGroupId value.

    • withCapacityReservationGroupId

      public AgentPoolInner withCapacityReservationGroupId(String capacityReservationGroupId)
      Set the capacityReservationGroupId property: AKS will associate the specified agent pool with the Capacity Reservation Group.
      Parameters:
      capacityReservationGroupId - the capacityReservationGroupId value to set.
      Returns:
      the AgentPoolInner object itself.

    • hostGroupId

      public String hostGroupId()
      Get the hostGroupId property: 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).
      Returns:
      the hostGroupId value.

    • withHostGroupId

      public AgentPoolInner withHostGroupId(String hostGroupId)
      Set the hostGroupId property: 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).
      Parameters:
      hostGroupId - the hostGroupId value to set.
      Returns:
      the AgentPoolInner object itself.

    • networkProfile

      public AgentPoolNetworkProfile networkProfile()
      Get the networkProfile property: Network-related settings of an agent pool.
      Returns:
      the networkProfile value.

    • withNetworkProfile

      public AgentPoolInner withNetworkProfile(AgentPoolNetworkProfile networkProfile)
      Set the networkProfile property: Network-related settings of an agent pool.
      Parameters:
      networkProfile - the networkProfile value to set.
      Returns:
      the AgentPoolInner object itself.

    • windowsProfile

      public AgentPoolWindowsProfile windowsProfile()
      Get the windowsProfile property: The Windows agent pool's specific profile.
      Returns:
      the windowsProfile value.

    • withWindowsProfile

      public AgentPoolInner withWindowsProfile(AgentPoolWindowsProfile windowsProfile)
      Set the windowsProfile property: The Windows agent pool's specific profile.
      Parameters:
      windowsProfile - the windowsProfile value to set.
      Returns:
      the AgentPoolInner object itself.

    • securityProfile

      public AgentPoolSecurityProfile securityProfile()
      Get the securityProfile property: The security settings of an agent pool.
      Returns:
      the securityProfile value.

    • withSecurityProfile

      public AgentPoolInner withSecurityProfile(AgentPoolSecurityProfile securityProfile)
      Set the securityProfile property: The security settings of an agent pool.
      Parameters:
      securityProfile - the securityProfile value to set.
      Returns:
      the AgentPoolInner object itself.

    • gpuProfile

      public GpuProfile gpuProfile()
      Get the gpuProfile property: GPU settings for the Agent Pool.
      Returns:
      the gpuProfile value.

    • withGpuProfile

      public AgentPoolInner withGpuProfile(GpuProfile gpuProfile)
      Set the gpuProfile property: GPU settings for the Agent Pool.
      Parameters:
      gpuProfile - the gpuProfile value to set.
      Returns:
      the AgentPoolInner object itself.

    • gatewayProfile

      public AgentPoolGatewayProfile gatewayProfile()
      Get the gatewayProfile property: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
      Returns:
      the gatewayProfile value.

    • withGatewayProfile

      public AgentPoolInner withGatewayProfile(AgentPoolGatewayProfile gatewayProfile)
      Set the gatewayProfile property: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
      Parameters:
      gatewayProfile - the gatewayProfile value to set.
      Returns:
      the AgentPoolInner object itself.

    • virtualMachinesProfile

      public VirtualMachinesProfile virtualMachinesProfile()
      Get the virtualMachinesProfile property: Specifications on VirtualMachines agent pool.
      Returns:
      the virtualMachinesProfile value.

    • withVirtualMachinesProfile

      public AgentPoolInner withVirtualMachinesProfile(VirtualMachinesProfile virtualMachinesProfile)
      Set the virtualMachinesProfile property: Specifications on VirtualMachines agent pool.
      Parameters:
      virtualMachinesProfile - the virtualMachinesProfile value to set.
      Returns:
      the AgentPoolInner object itself.

    • virtualMachineNodesStatus

      public List<VirtualMachineNodes> virtualMachineNodesStatus()
      Get the virtualMachineNodesStatus property: The status of nodes in a VirtualMachines agent pool.
      Returns:
      the virtualMachineNodesStatus value.

    • withVirtualMachineNodesStatus

      public AgentPoolInner withVirtualMachineNodesStatus(List<VirtualMachineNodes> virtualMachineNodesStatus)
      Set the virtualMachineNodesStatus property: The status of nodes in a VirtualMachines agent pool.
      Parameters:
      virtualMachineNodesStatus - the virtualMachineNodesStatus value to set.
      Returns:
      the AgentPoolInner object itself.

    • status

      public AgentPoolStatus status()
      Get the status property: Contains read-only information about the Agent Pool.
      Returns:
      the status value.

    • withStatus

      public AgentPoolInner withStatus(AgentPoolStatus status)
      Set the status property: Contains read-only information about the Agent Pool.
      Parameters:
      status - the status value to set.
      Returns:
      the AgentPoolInner object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<com.azure.core.management.SubResource>
      Overrides:
      toJson in class com.azure.core.management.SubResource
      Throws:
      IOException

    • fromJson

      public static AgentPoolInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AgentPoolInner from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AgentPoolInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the AgentPoolInner.