AgentPoolInner Class

Package:: com.azure.resourcemanager.networkcloud.fluent.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-networkcloud:2.1.0

java.lang.Object
- com.azure.core.management.ProxyResource
- - com.azure.core.management.Resource
  - - com.azure.resourcemanager.networkcloud.fluent.models.AgentPoolInner

public final class AgentPoolInner
extends Resource

AgentPool represents the agent pool of Kubernetes cluster.

Constructor Summary

Constructor	Description
AgentPoolInner()	Creates an instance of AgentPoolInner class.

Method Summary

Modifier and Type	Method and Description
AdministratorConfiguration	administratorConfiguration() Get the administratorConfiguration property: The administrator credentials to be used for the nodes in this agent pool.
AgentOptions	agentOptions() Get the agentOptions property: The configurations that will be applied to each agent in this agent pool.
AttachedNetworkConfiguration	attachedNetworkConfiguration() Get the attachedNetworkConfiguration property: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
List<String>	availabilityZones() Get the availabilityZones property: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool.
long	count() Get the count property: The number of virtual machines that use this configuration.
AgentPoolDetailedStatus	detailedStatus() Get the detailedStatus property: The current status of the agent pool.
String	detailedStatusMessage() Get the detailedStatusMessage property: The descriptive message about the current detailed status.
String	etag() Get the etag property: Resource ETag.
ExtendedLocation	extendedLocation() Get the extendedLocation property: The extended location of the cluster associated with the resource.
static AgentPoolInner	fromJson(JsonReader jsonReader) Reads an instance of AgentPoolInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
String	kubernetesVersion() Get the kubernetesVersion property: The Kubernetes version running in this agent pool.
List<KubernetesLabel>	labels() Get the labels property: The labels applied to the nodes in this agent pool.
AgentPoolMode	mode() Get the mode property: The selection of how this agent pool is utilized, either as a system pool or a user pool.
String	name() Get the name property: The name of the resource.
AgentPoolProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the agent pool.
SystemData	systemData() Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
List<KubernetesLabel>	taints() Get the taints property: The taints applied to the nodes in this agent pool.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
AgentPoolUpgradeSettings	upgradeSettings() Get the upgradeSettings property: The configuration of the agent pool.
void	validate() Validates the instance.
String	vmSkuName() Get the vmSkuName property: The name of the VM SKU that determines the size of resources allocated for node VMs.
AgentPoolInner	withAdministratorConfiguration(AdministratorConfiguration administratorConfiguration) Set the administratorConfiguration property: The administrator credentials to be used for the nodes in this agent pool.
AgentPoolInner	withAgentOptions(AgentOptions agentOptions) Set the agentOptions property: The configurations that will be applied to each agent in this agent pool.
AgentPoolInner	withAttachedNetworkConfiguration(AttachedNetworkConfiguration attachedNetworkConfiguration) Set the attachedNetworkConfiguration property: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
AgentPoolInner	withAvailabilityZones(List<String> availabilityZones) Set the availabilityZones property: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool.
AgentPoolInner	withCount(long count) Set the count property: The number of virtual machines that use this configuration.
AgentPoolInner	withExtendedLocation(ExtendedLocation extendedLocation) Set the extendedLocation property: The extended location of the cluster associated with the resource.
AgentPoolInner	withLabels(List<KubernetesLabel> labels) Set the labels property: The labels applied to the nodes in this agent pool.
AgentPoolInner	withLocation(String location)
AgentPoolInner	withMode(AgentPoolMode mode) Set the mode property: The selection of how this agent pool is utilized, either as a system pool or a user pool.
AgentPoolInner	withTags(Map<String,String> tags)
AgentPoolInner	withTaints(List<KubernetesLabel> taints) Set the taints property: The taints applied to the nodes in this agent pool.
AgentPoolInner	withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings) Set the upgradeSettings property: The configuration of the agent pool.
AgentPoolInner	withVmSkuName(String vmSkuName) Set the vmSkuName property: The name of the VM SKU that determines the size of resources allocated for node VMs.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AgentPoolInner

public AgentPoolInner()

Creates an instance of AgentPoolInner class.

Method Details

administratorConfiguration

public AdministratorConfiguration administratorConfiguration()

Get the administratorConfiguration property: The administrator credentials to be used for the nodes in this agent pool.

Returns:

the administratorConfiguration value.

agentOptions

public AgentOptions agentOptions()

Get the agentOptions property: The configurations that will be applied to each agent in this agent pool.

Returns:

the agentOptions value.

attachedNetworkConfiguration

public AttachedNetworkConfiguration attachedNetworkConfiguration()

Get the attachedNetworkConfiguration property: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.

Returns:

the attachedNetworkConfiguration value.

availabilityZones

public List<String> availabilityZones()

Get the availabilityZones property: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.

Returns:

the availabilityZones value.

count

public long count()

Get the count property: The number of virtual machines that use this configuration.

Returns:

the count value.

detailedStatus

public AgentPoolDetailedStatus detailedStatus()

Get the detailedStatus property: The current status of the agent pool.

Returns:

the detailedStatus value.

detailedStatusMessage

public String detailedStatusMessage()

Get the detailedStatusMessage property: The descriptive message about the current detailed status.

Returns:

the detailedStatusMessage value.

etag

public String etag()

Get the etag property: Resource ETag.

Returns:

the etag value.

extendedLocation

public ExtendedLocation extendedLocation()

Get the extendedLocation property: The extended location of the cluster associated with the resource.

Returns:

the extendedLocation value.

fromJson

public static AgentPoolInner fromJson(JsonReader jsonReader)

Reads an instance of AgentPoolInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AgentPoolInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

AgentPoolInner.id()

Returns:

the id value.

kubernetesVersion

public String kubernetesVersion()

Get the kubernetesVersion property: The Kubernetes version running in this agent pool.

Returns:

the kubernetesVersion value.

labels

public List<KubernetesLabel> labels()

Get the labels property: The labels applied to the nodes in this agent pool.

Returns:

the labels value.

mode

public AgentPoolMode mode()

Get the mode property: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.

Returns:

the mode value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

AgentPoolInner.name()

Returns:

the name value.

provisioningState

public AgentPoolProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the agent pool.

Returns:

the provisioningState value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

taints

public List<KubernetesLabel> taints()

Get the taints property: The taints applied to the nodes in this agent pool.

Returns:

the taints value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AgentPoolInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

AgentPoolInner.type()

Returns:

the type value.

upgradeSettings

public AgentPoolUpgradeSettings upgradeSettings()

Get the upgradeSettings property: The configuration of the agent pool.

Returns:

the upgradeSettings value.

validate

public void validate()

Validates the instance.

vmSkuName

public String vmSkuName()

Get the vmSkuName property: The name of the VM SKU that determines the size of resources allocated for node VMs.

Returns:

the vmSkuName value.

withAdministratorConfiguration

public AgentPoolInner withAdministratorConfiguration(AdministratorConfiguration administratorConfiguration)

Set the administratorConfiguration property: The administrator credentials to be used for the nodes in this agent pool.

Parameters:

administratorConfiguration - the administratorConfiguration value to set.

Returns:

the AgentPoolInner object itself.

withAgentOptions

public AgentPoolInner withAgentOptions(AgentOptions agentOptions)

Set the agentOptions property: The configurations that will be applied to each agent in this agent pool.

Parameters:

agentOptions - the agentOptions value to set.

Returns:

the AgentPoolInner object itself.

withAttachedNetworkConfiguration

public AgentPoolInner withAttachedNetworkConfiguration(AttachedNetworkConfiguration attachedNetworkConfiguration)

Set the attachedNetworkConfiguration property: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.

Parameters:

attachedNetworkConfiguration - the attachedNetworkConfiguration value to set.

Returns:

the AgentPoolInner object itself.

withAvailabilityZones

public AgentPoolInner withAvailabilityZones(List<String> availabilityZones)

Set the availabilityZones property: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.

Parameters:

availabilityZones - the availabilityZones value to set.

Returns:

the AgentPoolInner object itself.

withCount

public AgentPoolInner withCount(long count)

Set the count property: The number of virtual machines that use this configuration.

Parameters:

count - the count value to set.

Returns:

the AgentPoolInner object itself.

withExtendedLocation

public AgentPoolInner withExtendedLocation(ExtendedLocation extendedLocation)

Set the extendedLocation property: The extended location of the cluster associated with the resource.

Parameters:

extendedLocation - the extendedLocation value to set.

Returns:

the AgentPoolInner object itself.

withLabels

public AgentPoolInner withLabels(List<KubernetesLabel> labels)

Set the labels property: The labels applied to the nodes in this agent pool.

Parameters:

labels - the labels value to set.

Returns:

the AgentPoolInner object itself.

withLocation

public AgentPoolInner withLocation(String location)

Overrides:

AgentPoolInner.withLocation(String location)

Parameters:

location

withMode

public AgentPoolInner withMode(AgentPoolMode mode)

Set the mode property: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.

Parameters:

mode - the mode value to set.

Returns:

the AgentPoolInner object itself.

withTags

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

Overrides:

AgentPoolInner.withTags(Map<String,String> tags)

Parameters:

withTaints

public AgentPoolInner withTaints(List<KubernetesLabel> taints)

Set the taints property: The taints applied to the nodes in this agent pool.

Parameters:

taints - the taints value to set.

Returns:

the AgentPoolInner object itself.

withUpgradeSettings

public AgentPoolInner withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)

Set the upgradeSettings property: The configuration of the agent pool.

Parameters:

upgradeSettings - the upgradeSettings value to set.

Returns:

the AgentPoolInner object itself.

withVmSkuName

public AgentPoolInner withVmSkuName(String vmSkuName)

Set the vmSkuName property: The name of the VM SKU that determines the size of resources allocated for node VMs.

Parameters:

vmSkuName - the vmSkuName value to set.

Returns:

the AgentPoolInner object itself.

Applies to

Feedback

Was this page helpful?