REST Resource: projects.locations.azureClusters.azureNodePools

資源：AzureNodePool

在 Azure 上執行的 Anthos 節點集區。

JSON 表示法 
{
  "name": string,
  "version": string,
  "config": {
    object (AzureNodeConfig)
  },
  "subnetId": string,
  "autoscaling": {
    object (AzureNodePoolAutoscaling)
  },
  "state": enum (State),
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "maxPodsConstraint": {
    object (MaxPodsConstraint)
  },
  "azureAvailabilityZone": string,
  "errors": [
    {
      object (AzureNodePoolError)
    }
  ],
  "management": {
    object (AzureNodeManagement)
  }
}
欄位
name

string

這個資源的名稱。

節點集區名稱的格式為 projects/<project-number>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>。

如要進一步瞭解 Google Cloud 資源名稱，請參閱「資源名稱」
version

string

這是必要旗標，這個節點集區執行的 Kubernetes 版本 (例如 1.19.10-gke.1000)。
config

object (AzureNodeConfig)

這是必要旗標，節點集區的節點設定。
subnetId

string

這是必要旗標，節點集區 VM 執行的子網路 ARM ID。請確認這是叢集設定中虛擬網路下的子網路。
autoscaling

object (AzureNodePoolAutoscaling)

這是必要旗標，這個節點集區的自動調度資源設定。
state

enum (State)

僅供輸出。節點集區的目前狀態。
uid

string

僅供輸出。節點集區的全域專屬 ID。
reconciling

boolean

僅供輸出。如果已設定，節點集區目前有待處理的變更。
createTime

string (Timestamp format)

僅供輸出。這個節點集區的建立時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

僅供輸出。上次更新這個節點集區的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
etag

string

允許用戶端透過開放式並行控制執行一致的讀取-修改-寫入作業。

可在更新和刪除要求中傳送，確保用戶端在繼續操作前擁有最新值。
annotations

map (key: string, value: string)

(選用步驟) 節點集區的註解。

這個欄位與 Kubernetes 註解具有相同的限制。所有鍵值組合的總大小不得超過 256k。索引鍵可包含 2 個部分：前置字串 (選填) 和名稱 (必填)，兩者須以正斜線 (/) 分隔。前置字串必須是 DNS 子網域。名稱長度不得超過 63 個字元，開頭和結尾須為英數字元，中間須包含連字號 (-)、底線 (_)、點號 (.) 和英數字元。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
maxPodsConstraint

object (MaxPodsConstraint)

這是必要旗標，節點集區中節點可同時執行的 Pod 數量上限。
azureAvailabilityZone

string

(選用步驟) 這個節點集區中節點的 Azure 可用性區域。

如未指定，則預設為 1。
errors[]

object (AzureNodePoolError)

僅供輸出。節點集區中發現的一組錯誤。
management

object (AzureNodeManagement)

(選用步驟) 這個節點集區的管理設定。

AzureNodeConfig

描述特定節點集區中所有節點機器的設定參數。

JSON 表示法 
{
  "vmSize": string,
  "rootVolume": {
    object (AzureDiskTemplate)
  },
  "tags": {
    string: string,
    ...
  },
  "imageType": string,
  "sshConfig": {
    object (AzureSshConfig)
  },
  "proxyConfig": {
    object (AzureProxyConfig)
  },
  "configEncryption": {
    object (AzureConfigEncryption)
  },
  "taints": [
    {
      object (NodeTaint)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
欄位
vmSize

string

(選用步驟) Azure VM 大小名稱。範例：Standard_DS2_v2。

如需相關選項，請參閱「支援的 VM 大小」。

如未指定，則預設為 Standard_DS2_v2。
rootVolume

object (AzureDiskTemplate)

(選用步驟) 與為每個節點集區機器佈建的根磁碟區相關的設定。

如未指定，則預設為 32 GiB 的 Azure 磁碟。
tags

map (key: string, value: string)

(選用步驟) 要套用至這個節點集區所有基礎 Azure 資源的一組標記。目前僅包含虛擬機器規模集。

最多可指定 50 組英數字元、空格和符號 (.+-=_:@/)，金鑰最多可包含 127 個 Unicode 字元。值最多可包含 255 個 Unicode 字元。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
imageType

string

(選用步驟) 要在節點集區執行個體上使用的 OS 映像檔類型。可以未指定，或值為 ubuntu。

如未指定，則預設為 ubuntu。
sshConfig

object (AzureSshConfig)

這是必要旗標，存取節點集區機器的 SSH 設定。
proxyConfig

object (AzureProxyConfig)

(選用步驟) 用於輸出 HTTP(S) 流量的 Proxy 設定。
configEncryption

object (AzureConfigEncryption)

(選用步驟) 與 VM 設定加密相關的設定。
taints[]

object (NodeTaint)

(選用步驟) 指派給這個節點集區節點的初始 taint。
labels

map (key: string, value: string)

(選用步驟) 指派給這個節點集區節點的初始標籤。含有「鍵」/「值」組合清單的物件。例如：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

AzureNodePoolAutoscaling

與 Kubernetes 叢集自動調度資源相關的設定。

Kubernetes 叢集自動調度器會根據叢集負載，自動調整節點集區的大小。

JSON 表示法 
{
  "minNodeCount": integer,
  "maxNodeCount": integer
}
欄位
minNodeCount

integer

這是必要旗標，節點集區中的節點數量下限。必須大於或等於 1，且小於或等於 maxNodeCount。
maxNodeCount

integer

這是必要旗標，節點集區中的節點數量上限。必須大於或等於 minNodeCount，且小於或等於 50。

狀態

節點集區的生命週期狀態。

列舉
STATE_UNSPECIFIED 未設定。
PROVISIONING 「PROVISIONING」狀態表示節點集區正在建立中。
RUNNING RUNNING 狀態表示節點集區已建立完成，可完全使用。
RECONCILING 「RECONCILING」狀態表示節點集區正在協調。
STOPPING 「STOPPING」狀態表示節點集區正在刪除。
ERROR ERROR 狀態表示節點集區已損毀，無法復原。
DEGRADED 「DEGRADED」狀態表示節點集區需要使用者採取行動，才能恢復完整功能。

AzureNodePoolError

AzureNodePoolError 說明 Azure 節點集區中發現的錯誤。

JSON 表示法 
{
  "message": string
}
欄位
message

string

錯誤的易讀說明。

AzureNodeManagement

AzureNodeManagement 定義為 Azure 節點集區啟用的節點管理功能集。

JSON 表示法 
{
  "autoRepair": boolean
}
欄位
autoRepair

boolean

(選用步驟) 是否自動修復節點。如果設為 true，系統會監控這個節點集區中的節點，如果節點在一段時間內持續未通過健康狀態檢查，系統就會觸發自動修復動作，以新節點取代這些節點。

方法

create
(deprecated)

 建立新的 AzureNodePool，並附加至指定的 AzureCluster。

delete
(deprecated)

 刪除特定 AzureNodePool 資源。

get
(deprecated)

 說明特定 AzureNodePool 資源。

list
(deprecated)

 列出指定 AzureCluster 上的所有 AzureNodePool 資源。

patch
(deprecated)

 更新 AzureNodePool。