AgentPool interface
AgentPool represents the agent pool of Kubernetes cluster.
- Extends
Properties
| administrator |
The administrator credentials to be used for the nodes in this agent pool. |
| agent |
The configurations that will be applied to each agent in this agent pool. |
| attached |
The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. |
| availability |
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. |
| count | The number of virtual machines that use this configuration. |
| detailed |
The current status of the agent pool. |
| detailed |
The descriptive message about the current detailed status. |
| etag | "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") |
| extended |
|
| kubernetes |
The Kubernetes version running in this agent pool. |
| labels | The labels applied to the nodes in this agent pool. |
| mode | 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. |
| provisioning |
The provisioning state of the agent pool. |
| taints | The taints applied to the nodes in this agent pool. |
| upgrade |
The configuration of the agent pool. |
| vm |
The name of the VM SKU that determines the size of resources allocated for node VMs. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | The geo-location where the resource lives |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
administratorConfiguration
The administrator credentials to be used for the nodes in this agent pool.
administratorConfiguration?: AdministratorConfigurationProperty Value
agentOptions
The configurations that will be applied to each agent in this agent pool.
agentOptions?: AgentOptionsProperty Value
attachedNetworkConfiguration
The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
attachedNetworkConfiguration?: AttachedNetworkConfigurationProperty Value
availabilityZones
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.
availabilityZones?: string[]Property Value
string[]
count
The number of virtual machines that use this configuration.
count: numberProperty Value
number
detailedStatus
The current status of the agent pool.
detailedStatus?: stringProperty Value
string
detailedStatusMessage
The descriptive message about the current detailed status.
detailedStatusMessage?: stringProperty Value
string
etag
"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
etag?: stringProperty Value
string
extendedLocation
kubernetesVersion
The Kubernetes version running in this agent pool.
kubernetesVersion?: stringProperty Value
string
labels
The labels applied to the nodes in this agent pool.
labels?: KubernetesLabel[]Property Value
mode
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.
mode: stringProperty Value
string
provisioningState
The provisioning state of the agent pool.
provisioningState?: stringProperty Value
string
taints
The taints applied to the nodes in this agent pool.
taints?: KubernetesLabel[]Property Value
upgradeSettings
The configuration of the agent pool.
upgradeSettings?: AgentPoolUpgradeSettingsProperty Value
vmSkuName
The name of the VM SKU that determines the size of resources allocated for node VMs.
vmSkuName: stringProperty Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: stringProperty Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: stringProperty Value
string
Inherited From TrackedResource.location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemDataProperty Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: Record<string, string>Property Value
Record<string, string>
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: stringProperty Value
string
Inherited From TrackedResource.type
