ContainerServiceAgentPoolProfile Class

  • Reference
Package:
com.microsoft.azure.management.containerservice
Maven Artifact:
com.microsoft.azure:azure-mgmt-containerservice:1.41.4
  • java.lang.Object
    • com.microsoft.azure.management.containerservice.ContainerServiceAgentPoolProfile

public class ContainerServiceAgentPoolProfile

Profile for the container service agent pool.

Constructor Summary

Constructor Description
ContainerServiceAgentPoolProfile()

Method Summary

Modifier and Type Method and Description
java.lang.Integer count()

Get number of agents (VMs) to host docker containers.
java.lang.String dnsPrefix()

Get dNS prefix to be used to create the FQDN for the agent pool.
java.lang.String fqdn()

Get fQDN for the agent pool.
java.lang.String name()

Get unique name of the agent pool profile in the context of the subscription and resource group.
java.lang.Integer osDiskSizeGB()

Get oS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool.
OSType osType()

Get osType to be used to specify os type.
java.util.List<java.lang.Integer> ports()

Get ports number array used to expose on this agent pool.
ContainerServiceStorageProfileTypes storageProfile()

Get storage profile specifies what kind of storage used.
ContainerServiceVMSizeTypes vmSize()

Get size of agent VMs.
java.lang.String vnetSubnetID()

Get vNet SubnetID specifies the VNet's subnet identifier.
ContainerServiceAgentPoolProfile withCount(Integer count)

Set number of agents (VMs) to host docker containers.
ContainerServiceAgentPoolProfile withDnsPrefix(String dnsPrefix)

Set dNS prefix to be used to create the FQDN for the agent pool.
ContainerServiceAgentPoolProfile withName(String name)

Set unique name of the agent pool profile in the context of the subscription and resource group.
ContainerServiceAgentPoolProfile 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.
ContainerServiceAgentPoolProfile withOsType(OSType osType)

Set osType to be used to specify os type.
ContainerServiceAgentPoolProfile withPorts(List<Integer> ports)

Set ports number array used to expose on this agent pool.
ContainerServiceAgentPoolProfile withStorageProfile(ContainerServiceStorageProfileTypes storageProfile)

Set storage profile specifies what kind of storage used.
ContainerServiceAgentPoolProfile withVmSize(ContainerServiceVMSizeTypes vmSize)

Set size of agent VMs.
ContainerServiceAgentPoolProfile withVnetSubnetID(String vnetSubnetID)

Set vNet SubnetID specifies the VNet's subnet identifier.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ContainerServiceAgentPoolProfile

public ContainerServiceAgentPoolProfile()

Method Details

count

public Integer count()

Get number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

Returns:

the count value

dnsPrefix

public String dnsPrefix()

Get dNS prefix to be used to create the FQDN for the agent pool.

Returns:

the dnsPrefix value

fqdn

public String fqdn()

Get fQDN for the agent pool.

Returns:

the fqdn value

name

public String name()

Get unique name of the agent pool profile in the context of the subscription and resource group.

Returns:

the name value

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

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

ports

public List ports()

Get ports number array used to expose on this agent pool. The default opened ports are different based on your choice of orchestrator.

Returns:

the ports value

storageProfile

public ContainerServiceStorageProfileTypes storageProfile()

Get storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice. Possible values include: 'StorageAccount', 'ManagedDisks'.

Returns:

the storageProfile value

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

vnetSubnetID

public String vnetSubnetID()

Get vNet SubnetID specifies the VNet's subnet identifier.

Returns:

the vnetSubnetID value

withCount

public ContainerServiceAgentPoolProfile withCount(Integer count)

Set number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

Parameters:

count - the count value to set

Returns:

the ContainerServiceAgentPoolProfile object itself.

withDnsPrefix

public ContainerServiceAgentPoolProfile withDnsPrefix(String dnsPrefix)

Set dNS prefix to be used to create the FQDN for the agent pool.

Parameters:

dnsPrefix - the dnsPrefix value to set

Returns:

the ContainerServiceAgentPoolProfile object itself.

withName

public ContainerServiceAgentPoolProfile withName(String name)

Set unique name of the agent pool profile in the context of the subscription and resource group.

Parameters:

name - the name value to set

Returns:

the ContainerServiceAgentPoolProfile object itself.

withOsDiskSizeGB

public ContainerServiceAgentPoolProfile 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 ContainerServiceAgentPoolProfile object itself.

withOsType

public ContainerServiceAgentPoolProfile 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 ContainerServiceAgentPoolProfile object itself.

withPorts

public ContainerServiceAgentPoolProfile withPorts(List ports)

Set ports number array used to expose on this agent pool. The default opened ports are different based on your choice of orchestrator.

Parameters:

ports - the ports value to set

Returns:

the ContainerServiceAgentPoolProfile object itself.

withStorageProfile

public ContainerServiceAgentPoolProfile withStorageProfile(ContainerServiceStorageProfileTypes storageProfile)

Set storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice. Possible values include: 'StorageAccount', 'ManagedDisks'.

Parameters:

storageProfile - the storageProfile value to set

Returns:

the ContainerServiceAgentPoolProfile object itself.

withVmSize

public ContainerServiceAgentPoolProfile 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 ContainerServiceAgentPoolProfile object itself.

withVnetSubnetID

public ContainerServiceAgentPoolProfile withVnetSubnetID(String vnetSubnetID)

Set vNet SubnetID specifies the VNet's subnet identifier.

Parameters:

vnetSubnetID - the vnetSubnetID value to set

Returns:

the ContainerServiceAgentPoolProfile object itself.

Applies to