KubernetesClusterNode interface
KubernetesClusterNode represents the details of a node in a Kubernetes cluster.
Properties
| agent |
The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. |
| availability |
The availability zone this node is running within. |
| bare |
The resource ID of the bare metal machine that hosts this node. |
| cpu |
The number of CPU cores configured for this node, derived from the VM SKU specified. |
| detailed |
The detailed state of this node. |
| detailed |
The descriptive message about the current detailed status. |
| disk |
The size of the disk configured for this node. Allocations are measured in gibibytes. |
| image | The machine image used to deploy this node. |
| kubernetes |
The currently running version of Kubernetes and bundled features running on this node. |
| labels | The list of labels on this node that have been assigned to the agent pool containing this node. |
| memory |
The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. |
| mode | The mode of the agent pool containing this node. Not applicable for control plane nodes. |
| name | The name of this node, as realized in the Kubernetes cluster. |
| network |
The NetworkAttachments made to this node. |
| power |
The power state of this node. |
| role | The role of this node in the cluster. |
| taints | The list of taints that have been assigned to the agent pool containing this node. |
| vm |
The VM SKU name that was used to create this cluster node. |
Property Details
agentPoolId
The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes.
agentPoolId?: stringProperty Value
string
availabilityZone
The availability zone this node is running within.
availabilityZone?: stringProperty Value
string
bareMetalMachineId
The resource ID of the bare metal machine that hosts this node.
bareMetalMachineId?: stringProperty Value
string
cpuCores
The number of CPU cores configured for this node, derived from the VM SKU specified.
cpuCores?: numberProperty Value
number
detailedStatus
The detailed state of this node.
detailedStatus?: stringProperty Value
string
detailedStatusMessage
The descriptive message about the current detailed status.
detailedStatusMessage?: stringProperty Value
string
diskSizeGB
The size of the disk configured for this node. Allocations are measured in gibibytes.
diskSizeGB?: numberProperty Value
number
image
The machine image used to deploy this node.
image?: stringProperty Value
string
kubernetesVersion
The currently running version of Kubernetes and bundled features running on this node.
kubernetesVersion?: stringProperty Value
string
labels
The list of labels on this node that have been assigned to the agent pool containing this node.
labels?: KubernetesLabel[]Property Value
memorySizeGB
The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes.
memorySizeGB?: numberProperty Value
number
mode
The mode of the agent pool containing this node. Not applicable for control plane nodes.
mode?: stringProperty Value
string
name
The name of this node, as realized in the Kubernetes cluster.
name?: stringProperty Value
string
networkAttachments
The NetworkAttachments made to this node.
networkAttachments?: NetworkAttachment[]Property Value
powerState
The power state of this node.
powerState?: stringProperty Value
string
role
The role of this node in the cluster.
role?: stringProperty Value
string
taints
The list of taints that have been assigned to the agent pool containing this node.
taints?: KubernetesLabel[]Property Value
vmSkuName
The VM SKU name that was used to create this cluster node.
vmSkuName?: stringProperty Value
string