com.azure.resourcemanager.containerservice.models

Class ManagedClusterAgentPoolProfileProperties

java.lang.Object

com.azure.resourcemanager.containerservice.models.ManagedClusterAgentPoolProfileProperties

Direct Known Subclasses:

ManagedClusterAgentPoolProfile

public class ManagedClusterAgentPoolProfileProperties
extends Object

Properties for the container service agent pool profile.

Constructor Summary

Constructors

Constructor and Description
ManagedClusterAgentPoolProfileProperties()

Method Summary

Modifier and Type	Method and Description
List<String>	availabilityZones() Get the availabilityZones property: Availability zones for nodes.
Integer	count() Get the count property: Number of agents (VMs) to host docker containers.
Boolean	enableAutoScaling() Get the enableAutoScaling property: Whether to enable auto-scaler.
Boolean	enableNodePublicIp() Get the enableNodePublicIp property: Enable public IP for nodes.
Integer	maxCount() Get the maxCount property: Maximum number of nodes for auto-scaling.
Integer	maxPods() Get the maxPods property: Maximum number of pods that can run on a node.
Integer	minCount() Get the minCount property: Minimum number of nodes for auto-scaling.
AgentPoolMode	mode() Get the mode property: AgentPoolMode represents mode of an agent pool.
String	nodeImageVersion() Get the nodeImageVersion property: Version of node image.
Map<String,String>	nodeLabels() Get the nodeLabels property: Agent pool node labels to be persisted across all nodes in agent pool.
List<String>	nodeTaints() Get the nodeTaints property: Taints added to new nodes during node pool create and scale.
String	orchestratorVersion() Get the orchestratorVersion property: Version of orchestrator specified when creating the managed cluster.
Integer	osDiskSizeGB() Get the osDiskSizeGB property: OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool.
OSType	osType() Get the osType property: OsType to be used to specify os type.
String	provisioningState() Get the provisioningState property: The current deployment or provisioning state, which only appears in the response.
String	proximityPlacementGroupId() Get the proximityPlacementGroupId property: The ID for Proximity Placement Group.
ScaleSetEvictionPolicy	scaleSetEvictionPolicy() Get the scaleSetEvictionPolicy property: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set.
ScaleSetPriority	scaleSetPriority() Get the scaleSetPriority property: ScaleSetPriority to be used to specify virtual machine scale set priority.
Float	spotMaxPrice() Get the spotMaxPrice property: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars.
Map<String,String>	tags() Get the tags property: Agent pool tags to be persisted on the agent pool virtual machine scale set.
AgentPoolType	type() Get the type property: AgentPoolType represents types of an agent pool.
AgentPoolUpgradeSettings	upgradeSettings() Get the upgradeSettings property: Settings for upgrading the agentpool.
void	validate() Validates the instance.
ContainerServiceVMSizeTypes	vmSize() Get the vmSize property: Size of agent VMs.
String	vnetSubnetId() Get the vnetSubnetId property: VNet SubnetID specifies the VNet's subnet identifier.
ManagedClusterAgentPoolProfileProperties	withAvailabilityZones(List<String> availabilityZones) Set the availabilityZones property: Availability zones for nodes.
ManagedClusterAgentPoolProfileProperties	withCount(Integer count) Set the count property: Number of agents (VMs) to host docker containers.
ManagedClusterAgentPoolProfileProperties	withEnableAutoScaling(Boolean enableAutoScaling) Set the enableAutoScaling property: Whether to enable auto-scaler.
ManagedClusterAgentPoolProfileProperties	withEnableNodePublicIp(Boolean enableNodePublicIp) Set the enableNodePublicIp property: Enable public IP for nodes.
ManagedClusterAgentPoolProfileProperties	withMaxCount(Integer maxCount) Set the maxCount property: Maximum number of nodes for auto-scaling.
ManagedClusterAgentPoolProfileProperties	withMaxPods(Integer maxPods) Set the maxPods property: Maximum number of pods that can run on a node.
ManagedClusterAgentPoolProfileProperties	withMinCount(Integer minCount) Set the minCount property: Minimum number of nodes for auto-scaling.
ManagedClusterAgentPoolProfileProperties	withMode(AgentPoolMode mode) Set the mode property: AgentPoolMode represents mode of an agent pool.
ManagedClusterAgentPoolProfileProperties	withNodeImageVersion(String nodeImageVersion) Set the nodeImageVersion property: Version of node image.
ManagedClusterAgentPoolProfileProperties	withNodeLabels(Map<String,String> nodeLabels) Set the nodeLabels property: Agent pool node labels to be persisted across all nodes in agent pool.
ManagedClusterAgentPoolProfileProperties	withNodeTaints(List<String> nodeTaints) Set the nodeTaints property: Taints added to new nodes during node pool create and scale.
ManagedClusterAgentPoolProfileProperties	withOrchestratorVersion(String orchestratorVersion) Set the orchestratorVersion property: Version of orchestrator specified when creating the managed cluster.
ManagedClusterAgentPoolProfileProperties	withOsDiskSizeGB(Integer osDiskSizeGB) Set the osDiskSizeGB property: OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool.
ManagedClusterAgentPoolProfileProperties	withOsType(OSType osType) Set the osType property: OsType to be used to specify os type.
ManagedClusterAgentPoolProfileProperties	withProximityPlacementGroupId(String proximityPlacementGroupId) Set the proximityPlacementGroupId property: The ID for Proximity Placement Group.
ManagedClusterAgentPoolProfileProperties	withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy) Set the scaleSetEvictionPolicy property: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set.
ManagedClusterAgentPoolProfileProperties	withScaleSetPriority(ScaleSetPriority scaleSetPriority) Set the scaleSetPriority property: ScaleSetPriority to be used to specify virtual machine scale set priority.
ManagedClusterAgentPoolProfileProperties	withSpotMaxPrice(Float spotMaxPrice) Set the spotMaxPrice property: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars.
ManagedClusterAgentPoolProfileProperties	withTags(Map<String,String> tags) Set the tags property: Agent pool tags to be persisted on the agent pool virtual machine scale set.
ManagedClusterAgentPoolProfileProperties	withType(AgentPoolType type) Set the type property: AgentPoolType represents types of an agent pool.
ManagedClusterAgentPoolProfileProperties	withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings) Set the upgradeSettings property: Settings for upgrading the agentpool.
ManagedClusterAgentPoolProfileProperties	withVmSize(ContainerServiceVMSizeTypes vmSize) Set the vmSize property: Size of agent VMs.
ManagedClusterAgentPoolProfileProperties	withVnetSubnetId(String vnetSubnetId) Set the vnetSubnetId property: VNet SubnetID specifies the VNet's subnet identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagedClusterAgentPoolProfileProperties

public ManagedClusterAgentPoolProfileProperties()

Method Detail

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 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1.

Returns:

the count value.

withCount

public ManagedClusterAgentPoolProfileProperties 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 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1.

Parameters:

count - the count value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

vmSize

public ContainerServiceVMSizeTypes vmSize()

Get the vmSize property: Size of agent VMs.

Returns:

the vmSize value.

withVmSize

public ManagedClusterAgentPoolProfileProperties withVmSize(ContainerServiceVMSizeTypes vmSize)

Set the vmSize property: Size of agent VMs.

Parameters:

vmSize - the vmSize value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties 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 this 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 ManagedClusterAgentPoolProfileProperties withOsDiskSizeGB(Integer osDiskSizeGB)

Set the osDiskSizeGB property: OS Disk Size in GB to be used to specify the disk size for every machine in this 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 ManagedClusterAgentPoolProfileProperties object itself.

vnetSubnetId

public String vnetSubnetId()

Get the vnetSubnetId property: VNet SubnetID specifies the VNet's subnet identifier.

Returns:

the vnetSubnetId value.

withVnetSubnetId

public ManagedClusterAgentPoolProfileProperties withVnetSubnetId(String vnetSubnetId)

Set the vnetSubnetId property: VNet SubnetID specifies the VNet's subnet identifier.

Parameters:

vnetSubnetId - the vnetSubnetId value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

maxPods

public Integer maxPods()

Get the maxPods property: Maximum number of pods that can run on a node.

Returns:

the maxPods value.

withMaxPods

public ManagedClusterAgentPoolProfileProperties withMaxPods(Integer maxPods)

Set the maxPods property: Maximum number of pods that can run on a node.

Parameters:

maxPods - the maxPods value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties 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 ManagedClusterAgentPoolProfileProperties 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 ManagedClusterAgentPoolProfileProperties object itself.

maxCount

public Integer maxCount()

Get the maxCount property: Maximum number of nodes for auto-scaling.

Returns:

the maxCount value.

withMaxCount

public ManagedClusterAgentPoolProfileProperties withMaxCount(Integer maxCount)

Set the maxCount property: Maximum number of nodes for auto-scaling.

Parameters:

maxCount - the maxCount value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

minCount

public Integer minCount()

Get the minCount property: Minimum number of nodes for auto-scaling.

Returns:

the minCount value.

withMinCount

public ManagedClusterAgentPoolProfileProperties withMinCount(Integer minCount)

Set the minCount property: Minimum number of nodes for auto-scaling.

Parameters:

minCount - the minCount value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

enableAutoScaling

public Boolean enableAutoScaling()

Get the enableAutoScaling property: Whether to enable auto-scaler.

Returns:

the enableAutoScaling value.

withEnableAutoScaling

public ManagedClusterAgentPoolProfileProperties withEnableAutoScaling(Boolean enableAutoScaling)

Set the enableAutoScaling property: Whether to enable auto-scaler.

Parameters:

enableAutoScaling - the enableAutoScaling value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

type

public AgentPoolType type()

Get the type property: AgentPoolType represents types of an agent pool.

Returns:

the type value.

withType

public ManagedClusterAgentPoolProfileProperties withType(AgentPoolType type)

Set the type property: AgentPoolType represents types of an agent pool.

Parameters:

type - the type value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

mode

public AgentPoolMode mode()

Get the mode property: AgentPoolMode represents mode of an agent pool.

Returns:

the mode value.

withMode

public ManagedClusterAgentPoolProfileProperties withMode(AgentPoolMode mode)

Set the mode property: AgentPoolMode represents mode of an agent pool.

Parameters:

mode - the mode value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

orchestratorVersion

public String orchestratorVersion()

Get the orchestratorVersion property: Version of orchestrator specified when creating the managed cluster.

Returns:

the orchestratorVersion value.

withOrchestratorVersion

public ManagedClusterAgentPoolProfileProperties withOrchestratorVersion(String orchestratorVersion)

Set the orchestratorVersion property: Version of orchestrator specified when creating the managed cluster.

Parameters:

orchestratorVersion - the orchestratorVersion value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

nodeImageVersion

public String nodeImageVersion()

Get the nodeImageVersion property: Version of node image.

Returns:

the nodeImageVersion value.

withNodeImageVersion

public ManagedClusterAgentPoolProfileProperties withNodeImageVersion(String nodeImageVersion)

Set the nodeImageVersion property: Version of node image.

Parameters:

nodeImageVersion - the nodeImageVersion value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

upgradeSettings

public AgentPoolUpgradeSettings upgradeSettings()

Get the upgradeSettings property: Settings for upgrading the agentpool.

Returns:

the upgradeSettings value.

withUpgradeSettings

public ManagedClusterAgentPoolProfileProperties withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)

Set the upgradeSettings property: Settings for upgrading the agentpool.

Parameters:

upgradeSettings - the upgradeSettings value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

provisioningState

public String provisioningState()

Get the provisioningState property: The current deployment or provisioning state, which only appears in the response.

Returns:

the provisioningState value.

availabilityZones

public List<String> availabilityZones()

Get the availabilityZones property: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.

Returns:

the availabilityZones value.

withAvailabilityZones

public ManagedClusterAgentPoolProfileProperties withAvailabilityZones(List<String> availabilityZones)

Set the availabilityZones property: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.

Parameters:

availabilityZones - the availabilityZones value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

enableNodePublicIp

public Boolean enableNodePublicIp()

Get the enableNodePublicIp property: Enable public IP for nodes.

Returns:

the enableNodePublicIp value.

withEnableNodePublicIp

public ManagedClusterAgentPoolProfileProperties withEnableNodePublicIp(Boolean enableNodePublicIp)

Set the enableNodePublicIp property: Enable public IP for nodes.

Parameters:

enableNodePublicIp - the enableNodePublicIp value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

scaleSetPriority

public ScaleSetPriority scaleSetPriority()

Get the scaleSetPriority property: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular.

Returns:

the scaleSetPriority value.

withScaleSetPriority

public ManagedClusterAgentPoolProfileProperties withScaleSetPriority(ScaleSetPriority scaleSetPriority)

Set the scaleSetPriority property: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular.

Parameters:

scaleSetPriority - the scaleSetPriority value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

scaleSetEvictionPolicy

public ScaleSetEvictionPolicy scaleSetEvictionPolicy()

Get the scaleSetEvictionPolicy property: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete.

Returns:

the scaleSetEvictionPolicy value.

withScaleSetEvictionPolicy

public ManagedClusterAgentPoolProfileProperties withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)

Set the scaleSetEvictionPolicy property: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete.

Parameters:

scaleSetEvictionPolicy - the scaleSetEvictionPolicy value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

spotMaxPrice

public Float spotMaxPrice()

Get the spotMaxPrice property: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.

Returns:

the spotMaxPrice value.

withSpotMaxPrice

public ManagedClusterAgentPoolProfileProperties withSpotMaxPrice(Float spotMaxPrice)

Set the spotMaxPrice property: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.

Parameters:

spotMaxPrice - the spotMaxPrice value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

tags

public Map<String,String> tags()

Get the tags property: Agent pool tags to be persisted on the agent pool virtual machine scale set.

Returns:

the tags value.

withTags

public ManagedClusterAgentPoolProfileProperties withTags(Map<String,String> tags)

Set the tags property: Agent pool tags to be persisted on the agent pool virtual machine scale set.

Parameters:

tags - the tags value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

nodeLabels

public Map<String,String> nodeLabels()

Get the nodeLabels property: Agent pool node labels to be persisted across all nodes in agent pool.

Returns:

the nodeLabels value.

withNodeLabels

public ManagedClusterAgentPoolProfileProperties withNodeLabels(Map<String,String> nodeLabels)

Set the nodeLabels property: Agent pool node labels to be persisted across all nodes in agent pool.

Parameters:

nodeLabels - the nodeLabels value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

nodeTaints

public List<String> nodeTaints()

Get the nodeTaints property: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

Returns:

the nodeTaints value.

withNodeTaints

public ManagedClusterAgentPoolProfileProperties withNodeTaints(List<String> nodeTaints)

Set the nodeTaints property: 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 ManagedClusterAgentPoolProfileProperties object itself.

proximityPlacementGroupId

public String proximityPlacementGroupId()

Get the proximityPlacementGroupId property: The ID for Proximity Placement Group.

Returns:

the proximityPlacementGroupId value.

withProximityPlacementGroupId

public ManagedClusterAgentPoolProfileProperties withProximityPlacementGroupId(String proximityPlacementGroupId)

Set the proximityPlacementGroupId property: The ID for Proximity Placement Group.

Parameters:

proximityPlacementGroupId - the proximityPlacementGroupId value to set.

Returns:

the ManagedClusterAgentPoolProfileProperties object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.