Package com.microsoft.azure.management.containerservice

Class ManagedClusterAgentPoolProfileProperties

java.lang.Object
com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties
Direct Known Subclasses:
ManagedClusterAgentPoolProfile
public class ManagedClusterAgentPoolProfileProperties extends Object
Properties for the container service agent pool profile.

  • Constructor Details

    • ManagedClusterAgentPoolProfileProperties

      public ManagedClusterAgentPoolProfileProperties()

  • Method Details

    • count

      public Integer count()
      Get 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 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 size of agent VMs. Possible values include: 'Standard_A1', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', 'Standard_A2', 'Standard_A2_v2', 'Standard_A2m_v2', 'Standard_A3', 'Standard_A4', 'Standard_A4_v2', 'Standard_A4m_v2', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A8_v2', 'Standard_A8m_v2', 'Standard_A9', 'Standard_B2ms', 'Standard_B2s', 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1', 'Standard_D11', 'Standard_D11_v2', 'Standard_D11_v2_Promo', 'Standard_D12', 'Standard_D12_v2', 'Standard_D12_v2_Promo', 'Standard_D13', 'Standard_D13_v2', 'Standard_D13_v2_Promo', 'Standard_D14', 'Standard_D14_v2', 'Standard_D14_v2_Promo', 'Standard_D15_v2', 'Standard_D16_v3', 'Standard_D16s_v3', 'Standard_D1_v2', 'Standard_D2', 'Standard_D2_v2', 'Standard_D2_v2_Promo', 'Standard_D2_v3', 'Standard_D2s_v3', 'Standard_D3', 'Standard_D32_v3', 'Standard_D32s_v3', 'Standard_D3_v2', 'Standard_D3_v2_Promo', 'Standard_D4', 'Standard_D4_v2', 'Standard_D4_v2_Promo', 'Standard_D4_v3', 'Standard_D4s_v3', 'Standard_D5_v2', 'Standard_D5_v2_Promo', 'Standard_D64_v3', 'Standard_D64s_v3', 'Standard_D8_v3', 'Standard_D8s_v3', 'Standard_DS1', 'Standard_DS11', 'Standard_DS11_v2', 'Standard_DS11_v2_Promo', 'Standard_DS12', 'Standard_DS12_v2', 'Standard_DS12_v2_Promo', 'Standard_DS13', 'Standard_DS13-2_v2', 'Standard_DS13-4_v2', 'Standard_DS13_v2', 'Standard_DS13_v2_Promo', 'Standard_DS14', 'Standard_DS14-4_v2', 'Standard_DS14-8_v2', 'Standard_DS14_v2', 'Standard_DS14_v2_Promo', 'Standard_DS15_v2', 'Standard_DS1_v2', 'Standard_DS2', 'Standard_DS2_v2', 'Standard_DS2_v2_Promo', 'Standard_DS3', 'Standard_DS3_v2', 'Standard_DS3_v2_Promo', 'Standard_DS4', 'Standard_DS4_v2', 'Standard_DS4_v2_Promo', 'Standard_DS5_v2', 'Standard_DS5_v2_Promo', 'Standard_E16_v3', 'Standard_E16s_v3', 'Standard_E2_v3', 'Standard_E2s_v3', 'Standard_E32-16s_v3', 'Standard_E32-8s_v3', 'Standard_E32_v3', 'Standard_E32s_v3', 'Standard_E4_v3', 'Standard_E4s_v3', 'Standard_E64-16s_v3', 'Standard_E64-32s_v3', 'Standard_E64_v3', 'Standard_E64s_v3', 'Standard_E8_v3', 'Standard_E8s_v3', 'Standard_F1', 'Standard_F16', 'Standard_F16s', 'Standard_F16s_v2', 'Standard_F1s', 'Standard_F2', 'Standard_F2s', 'Standard_F2s_v2', 'Standard_F32s_v2', 'Standard_F4', 'Standard_F4s', 'Standard_F4s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_F8', 'Standard_F8s', 'Standard_F8s_v2', 'Standard_G1', 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS4-4', 'Standard_GS4-8', 'Standard_GS5', 'Standard_GS5-16', 'Standard_GS5-8', 'Standard_H16', 'Standard_H16m', 'Standard_H16mr', 'Standard_H16r', 'Standard_H8', 'Standard_H8m', 'Standard_L16s', 'Standard_L32s', 'Standard_L4s', 'Standard_L8s', 'Standard_M128-32ms', 'Standard_M128-64ms', 'Standard_M128ms', 'Standard_M128s', 'Standard_M64-16ms', 'Standard_M64-32ms', 'Standard_M64ms', 'Standard_M64s', 'Standard_NC12', 'Standard_NC12s_v2', 'Standard_NC12s_v3', 'Standard_NC24', 'Standard_NC24r', 'Standard_NC24rs_v2', 'Standard_NC24rs_v3', 'Standard_NC24s_v2', 'Standard_NC24s_v3', 'Standard_NC6', 'Standard_NC6s_v2', 'Standard_NC6s_v3', 'Standard_ND12s', 'Standard_ND24rs', 'Standard_ND24s', 'Standard_ND6s', 'Standard_NV12', 'Standard_NV24', 'Standard_NV6'.
      Returns:
      the vmSize value

    • withVmSize

      public ManagedClusterAgentPoolProfileProperties withVmSize(ContainerServiceVMSizeTypes vmSize)
      Set size of agent VMs. Possible values include: 'Standard_A1', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', 'Standard_A2', 'Standard_A2_v2', 'Standard_A2m_v2', 'Standard_A3', 'Standard_A4', 'Standard_A4_v2', 'Standard_A4m_v2', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A8_v2', 'Standard_A8m_v2', 'Standard_A9', 'Standard_B2ms', 'Standard_B2s', 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1', 'Standard_D11', 'Standard_D11_v2', 'Standard_D11_v2_Promo', 'Standard_D12', 'Standard_D12_v2', 'Standard_D12_v2_Promo', 'Standard_D13', 'Standard_D13_v2', 'Standard_D13_v2_Promo', 'Standard_D14', 'Standard_D14_v2', 'Standard_D14_v2_Promo', 'Standard_D15_v2', 'Standard_D16_v3', 'Standard_D16s_v3', 'Standard_D1_v2', 'Standard_D2', 'Standard_D2_v2', 'Standard_D2_v2_Promo', 'Standard_D2_v3', 'Standard_D2s_v3', 'Standard_D3', 'Standard_D32_v3', 'Standard_D32s_v3', 'Standard_D3_v2', 'Standard_D3_v2_Promo', 'Standard_D4', 'Standard_D4_v2', 'Standard_D4_v2_Promo', 'Standard_D4_v3', 'Standard_D4s_v3', 'Standard_D5_v2', 'Standard_D5_v2_Promo', 'Standard_D64_v3', 'Standard_D64s_v3', 'Standard_D8_v3', 'Standard_D8s_v3', 'Standard_DS1', 'Standard_DS11', 'Standard_DS11_v2', 'Standard_DS11_v2_Promo', 'Standard_DS12', 'Standard_DS12_v2', 'Standard_DS12_v2_Promo', 'Standard_DS13', 'Standard_DS13-2_v2', 'Standard_DS13-4_v2', 'Standard_DS13_v2', 'Standard_DS13_v2_Promo', 'Standard_DS14', 'Standard_DS14-4_v2', 'Standard_DS14-8_v2', 'Standard_DS14_v2', 'Standard_DS14_v2_Promo', 'Standard_DS15_v2', 'Standard_DS1_v2', 'Standard_DS2', 'Standard_DS2_v2', 'Standard_DS2_v2_Promo', 'Standard_DS3', 'Standard_DS3_v2', 'Standard_DS3_v2_Promo', 'Standard_DS4', 'Standard_DS4_v2', 'Standard_DS4_v2_Promo', 'Standard_DS5_v2', 'Standard_DS5_v2_Promo', 'Standard_E16_v3', 'Standard_E16s_v3', 'Standard_E2_v3', 'Standard_E2s_v3', 'Standard_E32-16s_v3', 'Standard_E32-8s_v3', 'Standard_E32_v3', 'Standard_E32s_v3', 'Standard_E4_v3', 'Standard_E4s_v3', 'Standard_E64-16s_v3', 'Standard_E64-32s_v3', 'Standard_E64_v3', 'Standard_E64s_v3', 'Standard_E8_v3', 'Standard_E8s_v3', 'Standard_F1', 'Standard_F16', 'Standard_F16s', 'Standard_F16s_v2', 'Standard_F1s', 'Standard_F2', 'Standard_F2s', 'Standard_F2s_v2', 'Standard_F32s_v2', 'Standard_F4', 'Standard_F4s', 'Standard_F4s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_F8', 'Standard_F8s', 'Standard_F8s_v2', 'Standard_G1', 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS4-4', 'Standard_GS4-8', 'Standard_GS5', 'Standard_GS5-16', 'Standard_GS5-8', 'Standard_H16', 'Standard_H16m', 'Standard_H16mr', 'Standard_H16r', 'Standard_H8', 'Standard_H8m', 'Standard_L16s', 'Standard_L32s', 'Standard_L4s', 'Standard_L8s', 'Standard_M128-32ms', 'Standard_M128-64ms', 'Standard_M128ms', 'Standard_M128s', 'Standard_M64-16ms', 'Standard_M64-32ms', 'Standard_M64ms', 'Standard_M64s', 'Standard_NC12', 'Standard_NC12s_v2', 'Standard_NC12s_v3', 'Standard_NC24', 'Standard_NC24r', 'Standard_NC24rs_v2', 'Standard_NC24rs_v3', 'Standard_NC24s_v2', 'Standard_NC24s_v3', 'Standard_NC6', 'Standard_NC6s_v2', 'Standard_NC6s_v3', 'Standard_ND12s', 'Standard_ND24rs', 'Standard_ND24s', 'Standard_ND6s', 'Standard_NV12', 'Standard_NV24', 'Standard_NV6'.
      Parameters:
      vmSize - the vmSize value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • osDiskSizeGB

      public Integer osDiskSizeGB()
      Get 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 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.

    • osDiskType

      public OSDiskType osDiskType()
      Get oS disk type to be used for machines in a given agent pool. Allowed values are 'Ephemeral' and 'Managed'. Defaults to 'Managed'. May not be changed after creation. Possible values include: 'Managed', 'Ephemeral'.
      Returns:
      the osDiskType value

    • withOsDiskType

      public ManagedClusterAgentPoolProfileProperties withOsDiskType(OSDiskType osDiskType)
      Set oS disk type to be used for machines in a given agent pool. Allowed values are 'Ephemeral' and 'Managed'. Defaults to 'Managed'. May not be changed after creation. Possible values include: 'Managed', 'Ephemeral'.
      Parameters:
      osDiskType - the osDiskType value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • vnetSubnetID

      public String vnetSubnetID()
      Get vNet SubnetID specifies the VNet's subnet identifier.
      Returns:
      the vnetSubnetID value

    • withVnetSubnetID

      public ManagedClusterAgentPoolProfileProperties withVnetSubnetID(String vnetSubnetID)
      Set 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 maximum number of pods that can run on a node.
      Returns:
      the maxPods value

    • withMaxPods

      public ManagedClusterAgentPoolProfileProperties withMaxPods(Integer maxPods)
      Set 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 osType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'.
      Returns:
      the osType value

    • withOsType

      public ManagedClusterAgentPoolProfileProperties withOsType(OSType osType)
      Set osType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'.
      Parameters:
      osType - the osType value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • maxCount

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

    • withMaxCount

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

    • minCount

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

    • withMinCount

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

    • enableAutoScaling

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

    • withEnableAutoScaling

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

    • type

      public AgentPoolType type()
      Get agentPoolType represents types of an agent pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet'.
      Returns:
      the type value

    • withType

      public ManagedClusterAgentPoolProfileProperties withType(AgentPoolType type)
      Set agentPoolType represents types of an agent pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet'.
      Parameters:
      type - the type value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • mode

      public AgentPoolMode mode()
      Get agentPoolMode represents mode of an agent pool. Possible values include: 'System', 'User'.
      Returns:
      the mode value

    • withMode

      public ManagedClusterAgentPoolProfileProperties withMode(AgentPoolMode mode)
      Set agentPoolMode represents mode of an agent pool. Possible values include: 'System', 'User'.
      Parameters:
      mode - the mode value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • orchestratorVersion

      public String orchestratorVersion()
      Get version of orchestrator specified when creating the managed cluster.
      Returns:
      the orchestratorVersion value

    • withOrchestratorVersion

      public ManagedClusterAgentPoolProfileProperties withOrchestratorVersion(String orchestratorVersion)
      Set 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 version of node image.
      Returns:
      the nodeImageVersion value

    • upgradeSettings

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

    • withUpgradeSettings

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

    • provisioningState

      public String provisioningState()
      Get the current deployment or provisioning state, which only appears in the response.
      Returns:
      the provisioningState value

    • powerState

      public PowerState powerState()
      Get describes whether the Agent Pool is Running or Stopped.
      Returns:
      the powerState value

    • availabilityZones

      public List<String> availabilityZones()
      Get availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.
      Returns:
      the availabilityZones value

    • withAvailabilityZones

      public ManagedClusterAgentPoolProfileProperties withAvailabilityZones(List<String> availabilityZones)
      Set 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 enable public IP for nodes.
      Returns:
      the enableNodePublicIP value

    • withEnableNodePublicIP

      public ManagedClusterAgentPoolProfileProperties withEnableNodePublicIP(Boolean enableNodePublicIP)
      Set enable public IP for nodes.
      Parameters:
      enableNodePublicIP - the enableNodePublicIP value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • scaleSetPriority

      public ScaleSetPriority scaleSetPriority()
      Get scaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. Possible values include: 'Spot', 'Regular'.
      Returns:
      the scaleSetPriority value

    • withScaleSetPriority

      public ManagedClusterAgentPoolProfileProperties withScaleSetPriority(ScaleSetPriority scaleSetPriority)
      Set scaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. Possible values include: 'Spot', 'Regular'.
      Parameters:
      scaleSetPriority - the scaleSetPriority value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • scaleSetEvictionPolicy

      public ScaleSetEvictionPolicy scaleSetEvictionPolicy()
      Get scaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. Possible values include: 'Delete', 'Deallocate'.
      Returns:
      the scaleSetEvictionPolicy value

    • withScaleSetEvictionPolicy

      public ManagedClusterAgentPoolProfileProperties withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)
      Set scaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. Possible values include: 'Delete', 'Deallocate'.
      Parameters:
      scaleSetEvictionPolicy - the scaleSetEvictionPolicy value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.

    • spotMaxPrice

      public Double spotMaxPrice()
      Get 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(Double spotMaxPrice)
      Set 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 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 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 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 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 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 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 ID for Proximity Placement Group.
      Returns:
      the proximityPlacementGroupID value

    • withProximityPlacementGroupID

      public ManagedClusterAgentPoolProfileProperties withProximityPlacementGroupID(String proximityPlacementGroupID)
      Set the ID for Proximity Placement Group.
      Parameters:
      proximityPlacementGroupID - the proximityPlacementGroupID value to set
      Returns:
      the ManagedClusterAgentPoolProfileProperties object itself.