AgentPool Interface

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

public interface AgentPool

An immutable client-side representation of AgentPool.

Method Summary

Modifier and Type Method and Description
abstract AdministratorConfiguration administratorConfiguration()

Gets the administratorConfiguration property: The administrator credentials to be used for the nodes in this agent pool.
abstract AgentOptions agentOptions()

Gets the agentOptions property: The configurations that will be applied to each agent in this agent pool.
abstract AttachedNetworkConfiguration attachedNetworkConfiguration()

Gets the attachedNetworkConfiguration property: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
abstract List<String> availabilityZones()

Gets the availabilityZones property: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool.
abstract long count()

Gets the count property: The number of virtual machines that use this configuration.
abstract AgentPoolDetailedStatus detailedStatus()

Gets the detailedStatus property: The current status of the agent pool.
abstract String detailedStatusMessage()

Gets the detailedStatusMessage property: The descriptive message about the current detailed status.
abstract String etag()

Gets the etag property: Resource ETag.
abstract ExtendedLocation extendedLocation()

Gets the extendedLocation property: The extended location of the cluster associated with the resource.
abstract String id()

Gets the id property: Fully qualified resource Id for the resource.
abstract AgentPoolInner innerModel()

Gets the inner com.azure.resourcemanager.networkcloud.fluent.models.AgentPoolInner object.
abstract String kubernetesVersion()

Gets the kubernetesVersion property: The Kubernetes version running in this agent pool.
abstract List<KubernetesLabel> labels()

Gets the labels property: The labels applied to the nodes in this agent pool.
abstract String location()

Gets the location property: The geo-location where the resource lives.
abstract AgentPoolMode mode()

Gets the mode property: The selection of how this agent pool is utilized, either as a system pool or a user pool.
abstract String name()

Gets the name property: The name of the resource.
abstract AgentPoolProvisioningState provisioningState()

Gets the provisioningState property: The provisioning state of the agent pool.
abstract AgentPool refresh()

Refreshes the resource to sync with Azure.
abstract AgentPool refresh(Context context)

Refreshes the resource to sync with Azure.
abstract Region region()

Gets the region of the resource.
abstract String regionName()

Gets the name of the resource region.
abstract String resourceGroupName()

Gets the name of the resource group.
abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String> tags()

Gets the tags property: Resource tags.
abstract List<KubernetesLabel> taints()

Gets the taints property: The taints applied to the nodes in this agent pool.
abstract String type()

Gets the type property: The type of the resource.
abstract Update update()

Begins update for the AgentPool resource.
abstract AgentPoolUpgradeSettings upgradeSettings()

Gets the upgradeSettings property: The configuration of the agent pool.
abstract String vmSkuName()

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

Method Details

administratorConfiguration

public abstract AdministratorConfiguration administratorConfiguration()

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

Returns:

the administratorConfiguration value.

agentOptions

public abstract AgentOptions agentOptions()

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

Returns:

the agentOptions value.

attachedNetworkConfiguration

public abstract AttachedNetworkConfiguration attachedNetworkConfiguration()

Gets 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 abstract List<String> availabilityZones()

Gets 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 abstract long count()

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

Returns:

the count value.

detailedStatus

public abstract AgentPoolDetailedStatus detailedStatus()

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

Returns:

the detailedStatus value.

detailedStatusMessage

public abstract String detailedStatusMessage()

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

Returns:

the detailedStatusMessage value.

etag

public abstract String etag()

Gets the etag property: Resource ETag.

Returns:

the etag value.

extendedLocation

public abstract ExtendedLocation extendedLocation()

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

Returns:

the extendedLocation value.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract AgentPoolInner innerModel()

Gets the inner com.azure.resourcemanager.networkcloud.fluent.models.AgentPoolInner object.

Returns:

the inner object.

kubernetesVersion

public abstract String kubernetesVersion()

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

Returns:

the kubernetesVersion value.

labels

public abstract List<KubernetesLabel> labels()

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

Returns:

the labels value.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

mode

public abstract AgentPoolMode mode()

Gets 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 abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

provisioningState

public abstract AgentPoolProvisioningState provisioningState()

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

Returns:

the provisioningState value.

refresh

public abstract AgentPool refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract AgentPool refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

systemData

public abstract SystemData systemData()

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

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

taints

public abstract List<KubernetesLabel> taints()

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

Returns:

the taints value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract AgentPool.Update update()

Begins update for the AgentPool resource.

Returns:

the stage of resource update.

upgradeSettings

public abstract AgentPoolUpgradeSettings upgradeSettings()

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

Returns:

the upgradeSettings value.

vmSkuName

public abstract String vmSkuName()

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

Returns:

the vmSkuName value.

Applies to