ContainerServiceAgentPoolProfile (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.resourcemanager.containerservice.models.ContainerServiceAgentPoolProfile

public final class ContainerServiceAgentPoolProfile
extends Object

Profile for the container service agent pool.

Constructor Summary

Constructors
Constructor and Description

ContainerServiceAgentPoolProfile()

Constructors
Constructor and Description
`ContainerServiceAgentPoolProfile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`count()` Get the count property: Number of agents (VMs) to host docker containers.
`String`	`dnsPrefix()` Get the dnsPrefix property: DNS prefix to be used to create the FQDN for the agent pool.
`String`	`fqdn()` Get the fqdn property: FQDN for the agent pool.
`String`	`name()` Get the name property: Unique name of the agent pool profile in the context of the subscription and resource group.
`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.
`List<Integer>`	`ports()` Get the ports property: Ports number array used to expose on this agent pool.
`ContainerServiceStorageProfileTypes`	`storageProfile()` Get the storageProfile property: Storage profile specifies what kind of storage used.
`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.
`ContainerServiceAgentPoolProfile`	`withCount(Integer count)` Set the count property: Number of agents (VMs) to host docker containers.
`ContainerServiceAgentPoolProfile`	`withDnsPrefix(String dnsPrefix)` Set the dnsPrefix property: DNS prefix to be used to create the FQDN for the agent pool.
`ContainerServiceAgentPoolProfile`	`withName(String name)` Set the name property: Unique name of the agent pool profile in the context of the subscription and resource group.
`ContainerServiceAgentPoolProfile`	`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.
`ContainerServiceAgentPoolProfile`	`withOsType(OSType osType)` Set the osType property: OsType to be used to specify os type.
`ContainerServiceAgentPoolProfile`	`withPorts(List<Integer> ports)` Set the ports property: Ports number array used to expose on this agent pool.
`ContainerServiceAgentPoolProfile`	`withStorageProfile(ContainerServiceStorageProfileTypes storageProfile)` Set the storageProfile property: Storage profile specifies what kind of storage used.
`ContainerServiceAgentPoolProfile`	`withVmSize(ContainerServiceVMSizeTypes vmSize)` Set the vmSize property: Size of agent VMs.
`ContainerServiceAgentPoolProfile`	`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
  - ContainerServiceAgentPoolProfile
```
public ContainerServiceAgentPoolProfile()
```
- Method Detail
  - name
```
public String name()
```
    Get the name property: Unique name of the agent pool profile in the context of the subscription and resource group.
    
    Returns:
    
    the name value.
  - withName
```
public ContainerServiceAgentPoolProfile withName(String name)
```
    Set the name property: 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.
  - count
```
public Integer count()
```
    Get the count property: 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.
  - withCount
```
public ContainerServiceAgentPoolProfile withCount(Integer count)
```
    Set the count property: 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.
  - vmSize
```
public ContainerServiceVMSizeTypes vmSize()
```
    Get the vmSize property: Size of agent VMs.
    
    Returns:
    
    the vmSize value.
  - withVmSize
```
public ContainerServiceAgentPoolProfile withVmSize(ContainerServiceVMSizeTypes vmSize)
```
    Set the vmSize property: Size of agent VMs.
    
    Parameters:
    
    vmSize - the vmSize value to set.
    
    Returns:
    
    the ContainerServiceAgentPoolProfile 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 ContainerServiceAgentPoolProfile 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 ContainerServiceAgentPoolProfile object itself.
  - dnsPrefix
```
public String dnsPrefix()
```
    Get the dnsPrefix property: DNS prefix to be used to create the FQDN for the agent pool.
    
    Returns:
    
    the dnsPrefix value.
  - withDnsPrefix
```
public ContainerServiceAgentPoolProfile withDnsPrefix(String dnsPrefix)
```
    Set the dnsPrefix property: 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.
  - fqdn
```
public String fqdn()
```
    Get the fqdn property: FQDN for the agent pool.
    
    Returns:
    
    the fqdn value.
  - ports
```
public List<Integer> ports()
```
    Get the ports property: 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.
  - withPorts
```
public ContainerServiceAgentPoolProfile withPorts(List<Integer> ports)
```
    Set the ports property: 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.
  - storageProfile
```
public ContainerServiceStorageProfileTypes storageProfile()
```
    Get the storageProfile property: 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.
    
    Returns:
    
    the storageProfile value.
  - withStorageProfile
```
public ContainerServiceAgentPoolProfile withStorageProfile(ContainerServiceStorageProfileTypes storageProfile)
```
    Set the storageProfile property: 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.
    
    Parameters:
    
    storageProfile - the storageProfile value to set.
    
    Returns:
    
    the ContainerServiceAgentPoolProfile object itself.
  - vnetSubnetId
```
public String vnetSubnetId()
```
    Get the vnetSubnetId property: VNet SubnetID specifies the VNet's subnet identifier.
    
    Returns:
    
    the vnetSubnetId value.
  - withVnetSubnetId
```
public ContainerServiceAgentPoolProfile withVnetSubnetId(String vnetSubnetId)
```
    Set the vnetSubnetId property: VNet SubnetID specifies the VNet's subnet identifier.
    
    Parameters:
    
    vnetSubnetId - the vnetSubnetId value to set.
    
    Returns:
    
    the ContainerServiceAgentPoolProfile 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 ContainerServiceAgentPoolProfile 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 ContainerServiceAgentPoolProfile object itself.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Class ContainerServiceAgentPoolProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerServiceAgentPoolProfile

Method Detail

name

withName

count

withCount

vmSize

withVmSize

osDiskSizeGB

withOsDiskSizeGB

dnsPrefix

withDnsPrefix

fqdn

ports

withPorts

storageProfile

withStorageProfile

vnetSubnetId

withVnetSubnetId

osType

withOsType

validate