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. NOTE: This property will not be serialized. It can only be populated by the server. |
availability |
The availability zone this node is running within. NOTE: This property will not be serialized. It can only be populated by the server. |
bare |
The resource ID of the bare metal machine that hosts this node. NOTE: This property will not be serialized. It can only be populated by the server. |
cpu |
The number of CPU cores configured for this node, derived from the VM SKU specified. NOTE: This property will not be serialized. It can only be populated by the server. |
detailed |
The detailed state of this node. NOTE: This property will not be serialized. It can only be populated by the server. |
detailed |
The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server. |
disk |
The size of the disk configured for this node. NOTE: This property will not be serialized. It can only be populated by the server. |
image | The machine image used to deploy this node. NOTE: This property will not be serialized. It can only be populated by the server. |
kubernetes |
The currently running version of Kubernetes and bundled features running on this node. NOTE: This property will not be serialized. It can only be populated by the server. |
labels | The list of labels on this node that have been assigned to the agent pool containing this node. NOTE: This property will not be serialized. It can only be populated by the server. |
memory |
The amount of memory configured for this node, derived from the vm SKU specified. NOTE: This property will not be serialized. It can only be populated by the server. |
mode | The mode of the agent pool containing this node. Not applicable for control plane nodes. NOTE: This property will not be serialized. It can only be populated by the server. |
name | The name of this node, as realized in the Kubernetes cluster. NOTE: This property will not be serialized. It can only be populated by the server. |
network |
The NetworkAttachments made to this node. NOTE: This property will not be serialized. It can only be populated by the server. |
power |
The power state of this node. NOTE: This property will not be serialized. It can only be populated by the server. |
role | The role of this node in the cluster. NOTE: This property will not be serialized. It can only be populated by the server. |
taints | The list of taints that have been assigned to the agent pool containing this node. NOTE: This property will not be serialized. It can only be populated by the server. |
vm |
The VM SKU name that was used to create this cluster node. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
agentPoolId
The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. NOTE: This property will not be serialized. It can only be populated by the server.
agentPoolId?: string
Property Value
string
availabilityZone
The availability zone this node is running within. NOTE: This property will not be serialized. It can only be populated by the server.
availabilityZone?: string
Property Value
string
bareMetalMachineId
The resource ID of the bare metal machine that hosts this node. NOTE: This property will not be serialized. It can only be populated by the server.
bareMetalMachineId?: string
Property Value
string
cpuCores
The number of CPU cores configured for this node, derived from the VM SKU specified. NOTE: This property will not be serialized. It can only be populated by the server.
cpuCores?: number
Property Value
number
detailedStatus
The detailed state of this node. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatus?: string
Property Value
string
detailedStatusMessage
The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage?: string
Property Value
string
diskSizeGB
The size of the disk configured for this node. NOTE: This property will not be serialized. It can only be populated by the server.
diskSizeGB?: number
Property Value
number
image
The machine image used to deploy this node. NOTE: This property will not be serialized. It can only be populated by the server.
image?: string
Property Value
string
kubernetesVersion
The currently running version of Kubernetes and bundled features running on this node. NOTE: This property will not be serialized. It can only be populated by the server.
kubernetesVersion?: string
Property Value
string
labels
The list of labels on this node that have been assigned to the agent pool containing this node. NOTE: This property will not be serialized. It can only be populated by the server.
labels?: KubernetesLabel[]
Property Value
memorySizeGB
The amount of memory configured for this node, derived from the vm SKU specified. NOTE: This property will not be serialized. It can only be populated by the server.
memorySizeGB?: number
Property Value
number
mode
The mode of the agent pool containing this node. Not applicable for control plane nodes. NOTE: This property will not be serialized. It can only be populated by the server.
mode?: string
Property Value
string
name
The name of this node, as realized in the Kubernetes cluster. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
networkAttachments
The NetworkAttachments made to this node. NOTE: This property will not be serialized. It can only be populated by the server.
networkAttachments?: NetworkAttachment[]
Property Value
powerState
The power state of this node. NOTE: This property will not be serialized. It can only be populated by the server.
powerState?: string
Property Value
string
role
The role of this node in the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
role?: string
Property Value
string
taints
The list of taints that have been assigned to the agent pool containing this node. NOTE: This property will not be serialized. It can only be populated by the server.
taints?: KubernetesLabel[]
Property Value
vmSkuName
The VM SKU name that was used to create this cluster node. NOTE: This property will not be serialized. It can only be populated by the server.
vmSkuName?: string
Property Value
string