Class AgentPoolInner
- java.lang.Object
-
- com.azure.core.management.SubResource
-
- com.azure.resourcemanager.containerservice.fluent.models.AgentPoolInner
-
public final class AgentPoolInner extends com.azure.core.management.SubResourceAgent Pool.
-
-
Constructor Summary
Constructors Constructor Description AgentPoolInner()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>availabilityZones()Get the availabilityZones property: The list of Availability zones to use for nodes.Integercount()Get the count property: Number of agents (VMs) to host docker containers.CreationDatacreationData()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.BooleanenableAutoScaling()Get the enableAutoScaling property: Whether to enable auto-scaler.BooleanenableEncryptionAtHost()Get the enableEncryptionAtHost property: Whether to enable host based OS and data drive encryption.BooleanenableFips()Get the enableFips property: Whether to use a FIPS-enabled OS.BooleanenableNodePublicIp()Get the enableNodePublicIp property: Whether each node is allocated its own public IP.BooleanenableUltraSsd()Get the enableUltraSsd property: Whether to enable UltraSSD.GpuInstanceProfilegpuInstanceProfile()Get the gpuInstanceProfile property: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.KubeletConfigkubeletConfig()Get the kubeletConfig property: Kubelet configurations of agent nodes.KubeletDiskTypekubeletDiskType()Get the kubeletDiskType property: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.LinuxOSConfiglinuxOSConfig()Get the linuxOSConfig property: OS configurations of Linux agent nodes.IntegermaxCount()Get the maxCount property: The maximum number of nodes for auto-scaling.IntegermaxPods()Get the maxPods property: The maximum number of pods that can run on a node.IntegerminCount()Get the minCount property: The minimum number of nodes for auto-scaling.AgentPoolModemode()Get the mode property: The mode of an agent pool.Stringname()Get the name property: The name of the resource that is unique within a resource group.StringnodeImageVersion()Get the nodeImageVersion property: The version of node image.Map<String,String>nodeLabels()Get the nodeLabels property: The node labels to be persisted across all nodes in agent pool.StringnodePublicIpPrefixId()Get the nodePublicIpPrefixId property: The public IP prefix ID which VM nodes should use IPs from.List<String>nodeTaints()Get the nodeTaints property: The taints added to new nodes during node pool create and scale.StringorchestratorVersion()Get the orchestratorVersion property: The version of Kubernetes running on the Agent Pool.IntegerosDiskSizeGB()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.OSDiskTypeosDiskType()Get the osDiskType property: The OS disk type to be used for machines in the agent pool.OSSkuosSku()Get the osSku property: Specifies an OS SKU.OSTypeosType()Get the osType property: OsType to be used to specify os type.StringpodSubnetId()Get the podSubnetId property: The ID of the subnet which pods will join when launched.PowerStatepowerState()Get the powerState property: When an Agent Pool is first created it is initially Running.StringprovisioningState()Get the provisioningState property: The current deployment or provisioning state.StringproximityPlacementGroupId()Get the proximityPlacementGroupId property: The ID for Proximity Placement Group.ScaleDownModescaleDownMode()Get the scaleDownMode property: This also effects the cluster autoscaler behavior.ScaleSetEvictionPolicyscaleSetEvictionPolicy()Get the scaleSetEvictionPolicy property: The Virtual Machine Scale Set eviction policy.ScaleSetPriorityscaleSetPriority()Get the scaleSetPriority property: The Virtual Machine Scale Set priority.FloatspotMaxPrice()Get the spotMaxPrice property: The max price (in US Dollars) you are willing to pay for spot instances.Map<String,String>tags()Get the tags property: The tags to be persisted on the agent pool virtual machine scale set.Stringtype()Get the type property: Resource type.AgentPoolTypetypePropertiesType()Get the type property: The type of Agent Pool.AgentPoolUpgradeSettingsupgradeSettings()Get the upgradeSettings property: Settings for upgrading the agentpool.voidvalidate()Validates the instance.StringvmSize()Get the vmSize property: The size of the agent pool VMs.StringvnetSubnetId()Get the vnetSubnetId property: The ID of the subnet which agent pool nodes and optionally pods will join on startup.AgentPoolInnerwithAvailabilityZones(List<String> availabilityZones)Set the availabilityZones property: The list of Availability zones to use for nodes.AgentPoolInnerwithCount(Integer count)Set the count property: Number of agents (VMs) to host docker containers.AgentPoolInnerwithCreationData(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.AgentPoolInnerwithEnableAutoScaling(Boolean enableAutoScaling)Set the enableAutoScaling property: Whether to enable auto-scaler.AgentPoolInnerwithEnableEncryptionAtHost(Boolean enableEncryptionAtHost)Set the enableEncryptionAtHost property: Whether to enable host based OS and data drive encryption.AgentPoolInnerwithEnableFips(Boolean enableFips)Set the enableFips property: Whether to use a FIPS-enabled OS.AgentPoolInnerwithEnableNodePublicIp(Boolean enableNodePublicIp)Set the enableNodePublicIp property: Whether each node is allocated its own public IP.AgentPoolInnerwithEnableUltraSsd(Boolean enableUltraSsd)Set the enableUltraSsd property: Whether to enable UltraSSD.AgentPoolInnerwithGpuInstanceProfile(GpuInstanceProfile gpuInstanceProfile)Set the gpuInstanceProfile property: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.AgentPoolInnerwithId(String id)AgentPoolInnerwithKubeletConfig(KubeletConfig kubeletConfig)Set the kubeletConfig property: Kubelet configurations of agent nodes.AgentPoolInnerwithKubeletDiskType(KubeletDiskType kubeletDiskType)Set the kubeletDiskType property: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.AgentPoolInnerwithLinuxOSConfig(LinuxOSConfig linuxOSConfig)Set the linuxOSConfig property: OS configurations of Linux agent nodes.AgentPoolInnerwithMaxCount(Integer maxCount)Set the maxCount property: The maximum number of nodes for auto-scaling.AgentPoolInnerwithMaxPods(Integer maxPods)Set the maxPods property: The maximum number of pods that can run on a node.AgentPoolInnerwithMinCount(Integer minCount)Set the minCount property: The minimum number of nodes for auto-scaling.AgentPoolInnerwithMode(AgentPoolMode mode)Set the mode property: The mode of an agent pool.AgentPoolInnerwithNodeLabels(Map<String,String> nodeLabels)Set the nodeLabels property: The node labels to be persisted across all nodes in agent pool.AgentPoolInnerwithNodePublicIpPrefixId(String nodePublicIpPrefixId)Set the nodePublicIpPrefixId property: The public IP prefix ID which VM nodes should use IPs from.AgentPoolInnerwithNodeTaints(List<String> nodeTaints)Set the nodeTaints property: The taints added to new nodes during node pool create and scale.AgentPoolInnerwithOrchestratorVersion(String orchestratorVersion)Set the orchestratorVersion property: The version of Kubernetes running on the Agent Pool.AgentPoolInnerwithOsDiskSizeGB(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.AgentPoolInnerwithOsDiskType(OSDiskType osDiskType)Set the osDiskType property: The OS disk type to be used for machines in the agent pool.AgentPoolInnerwithOsSku(OSSku osSku)Set the osSku property: Specifies an OS SKU.AgentPoolInnerwithOsType(OSType osType)Set the osType property: OsType to be used to specify os type.AgentPoolInnerwithPodSubnetId(String podSubnetId)Set the podSubnetId property: The ID of the subnet which pods will join when launched.AgentPoolInnerwithPowerState(PowerState powerState)Set the powerState property: When an Agent Pool is first created it is initially Running.AgentPoolInnerwithProximityPlacementGroupId(String proximityPlacementGroupId)Set the proximityPlacementGroupId property: The ID for Proximity Placement Group.AgentPoolInnerwithScaleDownMode(ScaleDownMode scaleDownMode)Set the scaleDownMode property: This also effects the cluster autoscaler behavior.AgentPoolInnerwithScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)Set the scaleSetEvictionPolicy property: The Virtual Machine Scale Set eviction policy.AgentPoolInnerwithScaleSetPriority(ScaleSetPriority scaleSetPriority)Set the scaleSetPriority property: The Virtual Machine Scale Set priority.AgentPoolInnerwithSpotMaxPrice(Float spotMaxPrice)Set the spotMaxPrice property: The max price (in US Dollars) you are willing to pay for spot instances.AgentPoolInnerwithTags(Map<String,String> tags)Set the tags property: The tags to be persisted on the agent pool virtual machine scale set.AgentPoolInnerwithTypePropertiesType(AgentPoolType type)Set the type property: The type of Agent Pool.AgentPoolInnerwithUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)Set the upgradeSettings property: Settings for upgrading the agentpool.AgentPoolInnerwithVmSize(String vmSize)Set the vmSize property: The size of the agent pool VMs.AgentPoolInnerwithVnetSubnetId(String vnetSubnetId)Set the vnetSubnetId property: The ID of the subnet which agent pool nodes and optionally pods will join on startup.AgentPoolInnerwithWorkloadRuntime(WorkloadRuntime workloadRuntime)Set the workloadRuntime property: Determines the type of workload a node can run.WorkloadRuntimeworkloadRuntime()Get the workloadRuntime property: Determines the type of workload a node can run.
-
-
-
Method Detail
-
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:
withIdin classcom.azure.core.management.SubResource
-
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: 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.- Returns:
- the vmSize value.
-
withVmSize
public AgentPoolInner 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.- 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 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).- Returns:
- the osDiskType value.
-
withOsDiskType
public AgentPoolInner 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).- 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.
-
vnetSubnetId
public String vnetSubnetId()
Get 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}.- Returns:
- the vnetSubnetId value.
-
withVnetSubnetId
public AgentPoolInner 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}.- Parameters:
vnetSubnetId- the vnetSubnetId value to set.- Returns:
- the AgentPoolInner object itself.
-
podSubnetId
public String podSubnetId()
Get 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}.- Returns:
- the podSubnetId value.
-
withPodSubnetId
public AgentPoolInner 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}.- Parameters:
podSubnetId- the podSubnetId 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 an OS SKU. This value must not be specified if OSType is Windows.- Returns:
- the osSku value.
-
withOsSku
public AgentPoolInner withOsSku(OSSku osSku)
Set the osSku property: Specifies an OS SKU. This value must not be specified 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: 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.- Returns:
- the mode value.
-
withMode
public AgentPoolInner 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.- Parameters:
mode- the mode value to set.- Returns:
- the AgentPoolInner object itself.
-
orchestratorVersion
public String orchestratorVersion()
Get the orchestratorVersion property: The version of Kubernetes running on the Agent Pool. 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: The version of Kubernetes running on the Agent Pool. 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.
-
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: 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.- Returns:
- the enableNodePublicIp value.
-
withEnableNodePublicIp
public AgentPoolInner 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.- Parameters:
enableNodePublicIp- the enableNodePublicIp value to set.- Returns:
- the AgentPoolInner object itself.
-
nodePublicIpPrefixId
public String nodePublicIpPrefixId()
Get 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}.- Returns:
- the nodePublicIpPrefixId value.
-
withNodePublicIpPrefixId
public AgentPoolInner 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}.- 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: The Virtual Machine Scale Set eviction policy. 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: The Virtual Machine Scale Set eviction policy. 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: 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).- Returns:
- the spotMaxPrice value.
-
withSpotMaxPrice
public AgentPoolInner 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).- 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: Kubelet configurations of agent nodes. The Kubelet configuration on the agent pool nodes.- Returns:
- the kubeletConfig value.
-
withKubeletConfig
public AgentPoolInner withKubeletConfig(KubeletConfig kubeletConfig)
Set the kubeletConfig property: Kubelet configurations of agent nodes. 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: OS configurations of Linux agent nodes. The OS configuration of Linux agent nodes.- Returns:
- the linuxOSConfig value.
-
withLinuxOSConfig
public AgentPoolInner withLinuxOSConfig(LinuxOSConfig linuxOSConfig)
Set the linuxOSConfig property: OS configurations of Linux agent nodes. 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: 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.- Returns:
- the enableEncryptionAtHost value.
-
withEnableEncryptionAtHost
public AgentPoolInner 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.- 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: 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.- Returns:
- the enableFips value.
-
withEnableFips
public AgentPoolInner 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.- 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.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
-