共用方式為


Machines - Create Or Update

在指定的代理程式集區中建立或更新電腦。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}?api-version=2026-01-02-preview

URI 參數

名稱 位於 必要 類型 Description
agentPoolName
path True

string

minLength: 1
maxLength: 12
pattern: ^[a-z][a-z0-9]{0,11}$

代理程式集區的名稱。

machineName
path True

string

pattern: ^[a-z][a-z0-9]{0,11}$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$

機器的主機名稱。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

資源群組的名稱。 名稱不區分大小寫。

resourceName
path True

string

minLength: 1
maxLength: 63
pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$

受管理叢集資源的名稱。

subscriptionId
path True

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

minLength: 1

用於此作業的 API 版本。

要求標頭

名稱 必要 類型 Description
if-match

string

只有在實體符合此字串時,才應該繼續要求。

if-none-match

string

只有在沒有實體符合此字串時,才應該繼續要求。

要求本文

名稱 類型 Description
properties

MachineProperties

機器的屬性

回應

名稱 類型 Description
200 OK

Machine

資源「機器」更新操作成功

201 Created

Machine

資源「機器」創建操作成功

標題

  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Create/Update Machine

範例要求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/machines/machine1?api-version=2026-01-02-preview

{
  "properties": {
    "hardware": {
      "vmSize": "Standard_DS1_v2"
    },
    "kubernetes": {
      "kubeletDiskType": "OS",
      "maxPods": 110,
      "nodeLabels": {
        "key1": "val1"
      },
      "nodeTaints": [
        "Key1=Value1:NoSchedule"
      ],
      "orchestratorVersion": "1.30"
    },
    "mode": "User",
    "operatingSystem": {
      "enableFIPS": false,
      "osSKU": "Ubuntu",
      "osType": "Linux"
    },
    "priority": "Spot",
    "tags": {
      "name1": "val1"
    }
  }
}

範例回覆

{
  "name": "machine1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools/machines",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/machines/machine1",
  "properties": {
    "hardware": {
      "vmSize": "Standard_DS1_v2"
    },
    "kubernetes": {
      "currentOrchestratorVersion": "1.30.6",
      "kubeletDiskType": "OS",
      "maxPods": 110,
      "nodeLabels": {
        "key1": "val1"
      },
      "nodeName": "aks-nodepool1-machine1-25481572-vm0",
      "nodeTaints": [
        "Key1=Value1:NoSchedule"
      ],
      "orchestratorVersion": "1.30"
    },
    "mode": "User",
    "nodeImageVersion": "AKSUbuntu:1604:2023.03.11",
    "operatingSystem": {
      "enableFIPS": false,
      "osSKU": "Ubuntu",
      "osType": "Linux"
    },
    "priority": "Spot",
    "provisioningState": "Succeeded",
    "status": {
      "creationTimestamp": "2025-04-02T12:00:00Z",
      "driftAction": "Synced",
      "vmState": "Running"
    },
    "tags": {
      "name1": "val1"
    }
  },
  "zones": [
    "1"
  ]
}
{
  "name": "machine1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools/machines",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/machines/machine1",
  "properties": {
    "hardware": {
      "vmSize": "Standard_DS1_v2"
    },
    "kubernetes": {
      "currentOrchestratorVersion": "1.30.6",
      "kubeletDiskType": "OS",
      "maxPods": 110,
      "nodeLabels": {
        "key1": "val1"
      },
      "nodeName": "aks-nodepool1-machine1-25481572-vm0",
      "nodeTaints": [
        "Key1=Value1:NoSchedule"
      ],
      "orchestratorVersion": "1.30"
    },
    "mode": "User",
    "nodeImageVersion": "AKSUbuntu:1604:2023.03.11",
    "operatingSystem": {
      "enableFIPS": false,
      "osSKU": "Ubuntu",
      "osType": "Linux"
    },
    "priority": "Spot",
    "provisioningState": "Creating",
    "status": {
      "creationTimestamp": "2025-04-02T12:00:00Z",
      "driftAction": "Synced",
      "vmState": "Running"
    },
    "tags": {
      "name1": "val1"
    }
  },
  "zones": [
    "1"
  ]
}

定義

名稱 Description
AgentPoolArtifactStreamingProfile

代理池的 Artifact 串流設定檔。

AgentPoolMode

代理程式集區的模式。 叢集必須隨時至少有一個「系統」代理程式集區。 如需代理程式集區限制和最佳做法的其他資訊,請參閱:https://docs.microsoft.com/azure/aks/use-system-pools

AgentPoolSSHAccess

代理池的 SSH access 方法。

AgentPoolWindowsProfile

Windows 代理程式集區的特定配置檔。

createdByType

建立資源的身分識別類型。

DriftAction

機器的漂移動作。 指出機器是否因受管理叢集內容變更而偏離其預期狀態,需要採取更正動作。

DriverType

指定建立 Windows 代理程式集區時要安裝的 GPU 驅動程式類型。 如果未提供,AKS 會根據系統相容性選取驅動程式。 建立 AgentPool 之後,就無法變更此專案。 這無法在Linux AgentPools上設定。 針對Linux AgentPools,會根據系統相容性來選取驅動程式。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

GPUDriver

是否要安裝 GPU 驅動程式。 未指定時,預設值為 [安裝]。

GPUInstanceProfile

要用來為支援的 GPU VM SKU 指定 GPU MIG 實例設定檔的 GPUInstanceProfile。

GPUProfile

代理程式集區的 GPU 設定。

IPFamily

判斷位址是否屬於 IPv4 或 IPv6 系列

IPTag

包含與 對象相關聯的IPTag。

KubeletConfig

代理程序節點的 Kubelet 組態。 如需詳細資訊,請參閱 AKS 自定義節點組態

KubeletDiskType

決定空 Dir 卷的放置位置、容器執行時資料根,以及 Kubelet 臨時儲存(ephemeral storage)。

LinuxOSConfig

Linux 代理程序節點的 OS 組態。 如需詳細資訊,請參閱 AKS 自定義節點組態

LocalDNSForwardDestination

要從 localDNS 轉發的 DNS 查詢的目標伺服器。

LocalDNSForwardPolicy

用於選擇上游 DNS 伺服器的轉發策略。 有關更多資訊,請參閱 forward plugin

LocalDNSMode

localDNS 的啟用模式。

LocalDNSOverride

localDNS 設定檔的覆蓋。

LocalDNSProfile

使用 VnetDNS 和 KubeDNS 覆蓋配置每個節點的本地 DNS。 LocalDNS 有助於提高 AKS 群集中 DNS 解析的性能和可靠性。 有關更多詳細資訊,請參閱 aka.ms/aks/localdns。

LocalDNSProtocol

對於從 localDNS 到上游 DNS 伺服器的連接,強制執行 TCP 或首選 UDP 協定。

LocalDNSQueryLogging

localDNS 中 DNS 查詢的日誌級別。

LocalDNSServeStale

用於提供過時數據的策略。 有關更多資訊,請參閱 緩存外掛程式

LocalDNSState

系統產生的 localDNS 狀態。

Machine

一台機器。 包含基礎虛擬機的詳細數據。 計算機可能在這裡可見,但無法在 kubectl 取得節點中顯示;如果是,可能是因為計算機尚未向 Kubernetes API Server 註冊。

MachineBillingProfile

這些屬性與機器計費有關。

MachineHardwareProfile

計算機的硬體和 GPU 設置。

MachineIpAddress

計算機IP位址詳細數據。

MachineKubernetesProfile

計算機使用的 Kubernetes 配置。

MachineNetworkProperties

計算機的網路屬性

MachineOSProfile

計算機使用的作系統和磁碟。

MachineOSProfileLinuxProfile

Linux 電腦的特定配置檔。

MachineProperties

機器的屬性

MachineSecurityProfile

計算機的安全設置。

MachineStatus

包含有關計算機的唯讀資訊。

ManagementMode

管理式GPU體驗會在GPU驅動程式之上安裝額外元件,例如資料中心GPU管理器(DCGM)指標以監控。 想了解更多安裝內容,請參考 aka.ms/aks/managed-gpu。

MigStrategy

設定用於管理型 MIG 支援的 MIG(多實例 GPU)策略。 欲了解更多不同策略資訊,請造訪 aka.ms/aks/managed-gpu。 未指定時,預設為無。

NvidiaGPUProfile

NVIDIA 專用的 GPU 設定

OSDiskType

要用於代理程式集區中機器的 OS 磁碟類型。 如果 VM 支援,且快取磁碟大於要求的 OSDiskSizeGB,則預設值為 「暫時」。 否則,預設為 「受控」。 建立之後可能不會變更。 更多資訊請參見 Ephemeral OS

OSSKU

指定代理程式集區所使用的 OS SKU。 如果OSType為Linux,則預設值為Ubuntu。 當 Kubernetes <= 1.24 或 Windows2022 時,如果 OSType >為 Windows,則預設值為 Windows2019。

OSType

作系統類型。 預設值為Linux。

ScaleSetEvictionPolicy

虛擬機器擴展集收回原則。 驅逐政策會明確說明當虛擬機被驅逐時to do什麼。 預設值為刪除。 欲了解更多驅逐資訊,請參見 spot VMs

ScaleSetPriority

虛擬機擴展集優先順序。

SeccompDefault

指定套用至所有工作負載的預設 seccomp 設定檔。 如果未指定,預設會使用 『Unconfined』。

SysctlConfig

Linux 代理程序節點的 Sysctl 設定。

systemData

與建立和上次修改資源相關的元數據。

VmState

虛擬機器狀態。 指出基礎虛擬機器的目前狀態。

WorkloadRuntime

決定節點可執行的工作負載類型。

AgentPoolArtifactStreamingProfile

代理池的 Artifact 串流設定檔。

名稱 類型 Description
enabled

boolean

成品串流可透過隨選映射載入,加速節點上容器的冷啟動。 若要使用這項功能,容器映像也必須在 ACR 上啟用成品串流。 如果未指定,則預設值為 false。

AgentPoolMode

代理程式集區的模式。 叢集必須隨時至少有一個「系統」代理程式集區。 如需代理程式集區限制和最佳做法的其他資訊,請參閱:https://docs.microsoft.com/azure/aks/use-system-pools

Description
System

系統代理程式集區主要用於裝載重要系統網繭,例如 CoreDNS 和 metrics-server。 系統代理程式集區 osType 必須是 Linux。 系統代理程式集區 VM SKU 必須至少有 2vCPU 和 4 GB 的記憶體。

User

使用者代理程式集區主要用於代管應用程式網繭。

Gateway

閘道代理程式集區專用於提供靜態輸出 IP 給網繭。 如需詳細資訊,請參閱 https://aka.ms/aks/static-egress-gateway

ManagedSystem

ManagedSystem 是由 AKS 管理的系統集區。 該池根據集群使用方式動態擴展,並具有額外的自動監控和修復功能。 只能有一個 ManagedSystem 池,建議刪除所有其他系統池以獲得最佳體驗。

Machines

機器代理程式集區專用於裝載機器。 在池級別只允許執行有限的作,例如創建和刪除。 請使用電腦 API 來管理整個電腦生命週期。

AgentPoolSSHAccess

代理池的 SSH access 方法。

Description
LocalUser

可以使用私鑰以本機使用者身分透過 SSH 連線到節點。

Disabled

SSH 服務將會在節點上關閉。

EntraId

SSH 至具有 EntraId 整合的節點。 更多信息可以在以下位置找到 https://aka.ms/aks/ssh/aad

AgentPoolWindowsProfile

Windows 代理程式集區的特定配置檔。

名稱 類型 Description
disableOutboundNat

boolean

是否在 Windows 節點中禁用 OutboundNAT。 預設值為 false。 只有在叢集 outboundType 是 NAT 閘道,且 Windows 代理程式集區未啟用節點公用 IP 時,才能停用輸出 NAT。

createdByType

建立資源的身分識別類型。

Description
User
Application
ManagedIdentity
Key

DriftAction

機器的漂移動作。 指出機器是否因受管理叢集內容變更而偏離其預期狀態,需要採取更正動作。

Description
Synced

機器是最新的。

Recreate

機器已漂移,需要刪除並重新建立。

DriverType

指定建立 Windows 代理程式集區時要安裝的 GPU 驅動程式類型。 如果未提供,AKS 會根據系統相容性選取驅動程式。 建立 AgentPool 之後,就無法變更此專案。 這無法在Linux AgentPools上設定。 針對Linux AgentPools,會根據系統相容性來選取驅動程式。

Description
GRID

安裝GPU的GRID驅動程式,適用於需要虛擬化支援的應用程式。

CUDA

安裝 GPU 的 CUDA 驅動程序,針對科學計算和數據密集型應用中的計算任務進行了優化。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳情

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

GPUDriver

是否要安裝 GPU 驅動程式。 未指定時,預設值為 [安裝]。

Description
Install

安裝驅動程式。

None

略過驅動程式安裝。

GPUInstanceProfile

要用來為支援的 GPU VM SKU 指定 GPU MIG 實例設定檔的 GPUInstanceProfile。

Description
MIG1g

MIG 1g GPU 實例設定檔。

MIG2g

MIG 2G GPU 實例設定檔。

MIG3g

MIG 3G GPU 實例設定。

MIG4g

MIG 4G GPU 實例設定檔。

MIG7g

MIG 7g GPU 實例設定。

GPUProfile

代理程式集區的 GPU 設定。

名稱 類型 Description
driver

GPUDriver

是否要安裝 GPU 驅動程式。 未指定時,預設值為 [安裝]。

driverType

DriverType

指定建立 Windows 代理程式集區時要安裝的 GPU 驅動程式類型。 如果未提供,AKS 會根據系統相容性選取驅動程式。 建立 AgentPool 之後,就無法變更此專案。 這無法在Linux AgentPools上設定。 針對Linux AgentPools,會根據系統相容性來選取驅動程式。

nvidia

NvidiaGPUProfile

NVIDIA 專用的 GPU 設定。

IPFamily

判斷位址是否屬於 IPv4 或 IPv6 系列

Description
IPv4

IPv4 系列

IPv6

IPv6 系列

IPTag

包含與 對象相關聯的IPTag。

名稱 類型 Description
ipTagType

string

IP 標籤類型。 範例:RoutingPreference。

tag

string

與公用IP相關聯的IP標籤。 範例:因特網。

KubeletConfig

代理程序節點的 Kubelet 組態。 如需詳細資訊,請參閱 AKS 自定義節點組態

名稱 類型 Description
allowedUnsafeSysctls

string[]

允許的不安全 sysctls 或 unsafe sysctl 模式清單(結尾為 *)。

containerLogMaxFiles

integer (int32)

minimum: 2

容器可存在的容器記錄檔數目上限。 數字必須≥ 2。

containerLogMaxSizeMB

integer (int32)

容器記錄檔的大小上限(例如 10Mi)在輪替之前。

cpuCfsQuota

boolean

如果針對指定 CPU 限制的容器啟用 CPU CFS 配額強制執行。 預設值為 True。

cpuCfsQuotaPeriod

string

CPU CFS 配額期間值。 默認值為 『100 毫秒』。 有效值是具有選擇性分數和單位後綴的十進位數序列。 例如:『300ms』、『2h45m』。 支持的單位為 『ns』、『us』、『ms』、『s』、'm'和 'h'。

cpuManagerPolicy

string

要使用的 CPU 管理員原則。 預設值為 『none』。 如需詳細資訊 ,請參閱 Kubernetes CPU 管理原則 。 允許的值為 『none』 和 『static』。

failSwapOn

boolean

如果設定為 true,當節點上啟用交換時,Kubelet 將無法啟動。

imageGcHighThreshold

integer (int32)

磁碟使用量的百分比,之後映射垃圾收集一律會執行。 若要停用映射垃圾收集,請將 設定為100。 預設值為85%

imageGcLowThreshold

integer (int32)

永遠不會執行映射垃圾收集的磁碟使用量百分比。 這無法設定高於 imageGcHighThreshold。 預設值為 80%

podMaxPids

integer (int32)

每個 Pod 的進程數目上限。

seccompDefault

SeccompDefault

指定套用至所有工作負載的預設 seccomp 設定檔。 如果未指定,預設會使用 『Unconfined』。

topologyManagerPolicy

string

要使用的拓撲管理員原則。 如需詳細資訊,請參閱 Kubernetes 拓撲管理員。 預設值為 『none』。 允許的值為 'none'、'best-effort'、'restricted'和 'single-numa-node'。

KubeletDiskType

決定空 Dir 卷的放置位置、容器執行時資料根,以及 Kubelet 臨時儲存(ephemeral storage)。

Description
OS

Kubelet 將使用操作系統磁盤作為其數據。

Temporary

Kubelet 將使用臨時磁碟來儲存其資料。

LinuxOSConfig

Linux 代理程序節點的 OS 組態。 如需詳細資訊,請參閱 AKS 自定義節點組態

名稱 類型 Description
swapFileSizeMB

integer (int32)

將在每個節點上建立之交換檔案 MB 的大小。

sysctls

SysctlConfig

Linux 代理程序節點的 Sysctl 設定。

transparentHugePageDefrag

string

核心是否應該積極使用記憶體壓縮,讓更多的大量頁面可供使用。 有效值為 'always'、'defer'、'defer+madvise'、'madvise' 和 'never'。 默認值為 「瘋狂」。 如需詳細資訊,請參閱 Transparent Hugepages

transparentHugePageEnabled

string

是否啟用透明巨頁。 有效值為 『always』、『madvise』和 『never』。 默認值為 『always』。 如需詳細資訊,請參閱 Transparent Hugepages

LocalDNSForwardDestination

要從 localDNS 轉發的 DNS 查詢的目標伺服器。

Description
ClusterCoreDNS

將 DNS 查詢從 localDNS 轉送至叢集 CoreDNS。

VnetDNS

將 DNS 查詢從 localDNS 轉送至 VNET 中設定的 DNS 伺服器。 一個 VNET 可以配置多個 DNS 伺服器。

LocalDNSForwardPolicy

用於選擇上游 DNS 伺服器的轉發策略。 有關更多資訊,請參閱 forward plugin

Description
Sequential

實作循序上游 DNS 伺服器選取。 有關更多資訊,請參閱 forward plugin

RoundRobin

實作循環資源上游 DNS 伺服器選取。 有關更多資訊,請參閱 forward plugin

Random

實現隨機上游DNS伺服器選擇。 有關更多資訊,請參閱 forward plugin

LocalDNSMode

localDNS 的啟用模式。

Description
Preferred

如果目前的 Orchestrator 版本支援此功能,請最好啟用 localDNS。

Required

啟用 localDNS。

Disabled

停用 localDNS。

LocalDNSOverride

localDNS 設定檔的覆蓋。

名稱 類型 預設值 Description
cacheDurationInSeconds

integer (int32)

3600

緩存最大 TTL(以秒為單位)。 有關更多資訊,請參閱 緩存外掛程式

forwardDestination

LocalDNSForwardDestination

ClusterCoreDNS

要從 localDNS 轉發的 DNS 查詢的目標伺服器。

forwardPolicy

LocalDNSForwardPolicy

Sequential

用於選擇上游 DNS 伺服器的轉發策略。 有關更多資訊,請參閱 forward plugin

maxConcurrent

integer (int32)

1000

最大併發查詢數。 有關更多資訊,請參閱 forward plugin

protocol

LocalDNSProtocol

PreferUDP

對於從 localDNS 到上游 DNS 伺服器的連接,強制執行 TCP 或首選 UDP 協定。

queryLogging

LocalDNSQueryLogging

Error

localDNS 中 DNS 查詢的日誌級別。

serveStale

LocalDNSServeStale

Immediate

用於提供過時數據的策略。 有關更多資訊,請參閱 緩存外掛程式

serveStaleDurationInSeconds

integer (int32)

3600

提供過時的持續時間(以秒為單位)。 有關更多資訊,請參閱 緩存外掛程式

LocalDNSProfile

使用 VnetDNS 和 KubeDNS 覆蓋配置每個節點的本地 DNS。 LocalDNS 有助於提高 AKS 群集中 DNS 解析的性能和可靠性。 有關更多詳細資訊,請參閱 aka.ms/aks/localdns。

名稱 類型 預設值 Description
kubeDNSOverrides

<string,  LocalDNSOverride>

KubeDNS 覆蓋適用於來自 dnsPolicy:ClusterFirst 的 Pod 的 DNS 流量(稱為 KubeDNS 流量)。

mode

LocalDNSMode

Preferred

localDNS 的啟用模式。

state

LocalDNSState

系統產生的 localDNS 狀態。

vnetDNSOverrides

<string,  LocalDNSOverride>

VnetDNS 覆蓋適用於來自 dnsPolicy:default 或 kubelet 的 Pod 的 DNS 流量(稱為 VnetDNS 流量)。

LocalDNSProtocol

對於從 localDNS 到上游 DNS 伺服器的連接,強制執行 TCP 或首選 UDP 協定。

Description
PreferUDP

偏好從 localDNS 連線到上游 DNS 伺服器的 UDP 通訊協定。

ForceTCP

強制執行從 localDNS 到上游 DNS 伺服器的連線的 TCP 通訊協定。

LocalDNSQueryLogging

localDNS 中 DNS 查詢的日誌級別。

Description
Error

在localDNS中啟用錯誤記錄。 有關更多資訊,請參閱 errors 外掛程式

Log

在localDNS中啟用查詢記錄。 有關更多資訊,請參閱 log外掛程式

LocalDNSServeStale

用於提供過時數據的策略。 有關更多資訊,請參閱 緩存外掛程式

Description
Verify

透過驗證提供過時的資料。 首先驗證源中的條目是否仍然不可用,然後再將過期的條目發送到用戶端。 有關更多資訊,請參閱 緩存外掛程式

Immediate

立即提供過時的資料。 將過期的條目發送到客戶端,然後檢查該條目是否可從源獲得。 有關更多資訊,請參閱 緩存外掛程式

Disable

停用提供過時的資料。

LocalDNSState

系統產生的 localDNS 狀態。

Description
Enabled

localDNS 已啟用。

Disabled

localDNS 已停用。

Machine

一台機器。 包含基礎虛擬機的詳細數據。 計算機可能在這裡可見,但無法在 kubectl 取得節點中顯示;如果是,可能是因為計算機尚未向 Kubernetes API Server 註冊。

名稱 類型 Description
id

string (arm-id)

資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

name

string

資源的名稱

properties

MachineProperties

機器的屬性

systemData

systemData

Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。

type

string

資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

zones

string[]

計算機所在的可用區。

MachineBillingProfile

這些屬性與機器計費有關。

名稱 類型 預設值 Description
spotMaxPrice

number (float)

-1

您願意為現成實例支付的最高價格(以美元為單位)。 可能的值為大於零或 -1 的任何十進位值,表示依需求 up-to 默認價格。 欲了解更多現貨價格,請參閱 spot VMs 價格

MachineHardwareProfile

計算機的硬體和 GPU 設置。

名稱 類型 Description
gpuInstanceProfile

GPUInstanceProfile

要用來為支援的 GPU VM SKU 指定 GPU MIG 實例設定檔的 GPUInstanceProfile。

gpuProfile

GPUProfile

計算機的 GPU 設置。

ultraSsdEnabled

boolean

是否要啟用 UltraSSD

vmSize

string

VM 的大小。 VM 大小可用性會因區域而異。 如果節點包含計算資源不足(記憶體、cpu 等)Pod 可能無法正確執行。 如需受限制 VM 大小的詳細資訊,請參閱:https://docs.microsoft.com/azure/aks/quotas-skus-regions

MachineIpAddress

計算機IP位址詳細數據。

名稱 類型 Description
family

IPFamily

判斷位址是否屬於 IPv4 或 IPv6 系列

ip

string

本機的 IPv4 或 IPv6 位址

MachineKubernetesProfile

計算機使用的 Kubernetes 配置。

名稱 類型 Description
artifactStreamingProfile

AgentPoolArtifactStreamingProfile

在 AKS 上使用成品串流的設定。

currentOrchestratorVersion

string

機器上執行的 Kubernetes 版本。 如果 orchestratorVersion 是完整指定的 major.minor.patch< 版本>,此字段會完全等於它。 如果 orchestratorVersion 是 <major.minor>,此欄位將會包含使用的完整 <major.minor.patch> 版本。

kubeletConfig

KubeletConfig

計算機上的 Kubelet 配置。

kubeletDiskType

KubeletDiskType

決定空 Dir 卷的放置位置、容器執行時資料根,以及 Kubelet 臨時儲存(ephemeral storage)。

maxPods

integer (int32)

可在節點上執行的 Pod 數目上限。

nodeInitializationTaints

string[]

在創建期間在節點上添加的污點,AKS 不會對這些污點進行協調。 這些污點不會由 AKS 協調,而且可以使用 kubectl 呼叫移除。 這些污點允許在節點準備好接受工作負載之前執行必要的設定,例如 『key1=value1:NoSchedule』,然後可以使用 移除 kubectl taint nodes node1 key1=value1:NoSchedule-

nodeLabels

object

計算機上的節點標籤。

nodeName

string

Kubernetes 叢集中的節點名稱。

nodeTaints

string[]

在機器創建期間添加到新節點的污點。 例如,key=value:NoSchedule。

orchestratorVersion

string

使用者指定的 Kubernetes 版本。 支持 patch version <major.minor.patch> 和 <major.minor> 。 指定 major.minor< 時>,會自動選擇最新的支援修補程式版本。

workloadRuntime

WorkloadRuntime

決定節點可執行的工作負載類型。

MachineNetworkProperties

計算機的網路屬性

名稱 類型 Description
enableNodePublicIP

boolean

是否為計算機分配了自己的公有IP。 某些方案可能需要電腦接收自己的專用公有IP位址。 常見的案例是遊戲工作負載,其中控制台需要直接連線到雲端虛擬機,以將躍點降到最低。 預設值為 false。

ipAddresses

MachineIpAddress[]

本機的 IPv4、IPv6 位址

nodePublicIPPrefixID

string (arm-id)

公共IP前置碼 ID,VM 節點應使用其IP。 格式如下:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPTags

IPTag[]

實例層級公用IP的IPTag。

podSubnetID

string (arm-id)

啟動時,Pod 會加入之子網的標識碼。 如果省略,則會在節點子網上靜態指派 Pod IP(如需詳細資訊,請參閱 vnetSubnetID)。 格式如下:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

vnetSubnetID

string (arm-id)

節點和 Pod 在啟動時將加入的子網的 ID。 如果未指定此專案,則會產生及使用 VNET 和子網。 如果未指定 podSubnetID,這會套用至節點和 Pod,否則只會套用至節點。 格式如下:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

MachineOSProfile

計算機使用的作系統和磁碟。

名稱 類型 預設值 Description
enableFIPS

boolean

是否要使用已啟用 FIPS 的 OS。

linuxProfile

MachineOSProfileLinuxProfile

Linux 電腦的特定配置檔。

osDiskSizeGB

integer (int32)

minimum: 0
maximum: 2048

OS 磁碟大小 GB,用來指定主要/代理程式集區中每部計算機的磁碟大小。 如果您指定 0,它會根據指定的 vmSize 套用預設 osDisk 大小。

osDiskType

OSDiskType

要用於代理程式集區中機器的 OS 磁碟類型。 如果 VM 支援,且快取磁碟大於要求的 OSDiskSizeGB,則預設值為 「暫時」。 否則,預設為 「受控」。 建立之後可能不會變更。 更多資訊請參見 Ephemeral OS

osSKU

OSSKU

指定代理程式集區所使用的 OS SKU。 如果未指定,如果OSType=Linux或 Windows2019 OSType=Windows,則預設值為Ubuntu。 在 Windows2019 淘汰之後,預設的 Windows OSSKU 將會變更為 Windows2022。

osType

OSType

Linux

作系統類型。 預設值為Linux。

windowsProfile

AgentPoolWindowsProfile

Windows 電腦的特定配置檔。

MachineOSProfileLinuxProfile

Linux 電腦的特定配置檔。

名稱 類型 Description
linuxOSConfig

LinuxOSConfig

Linux 電腦的作系統配置。

messageOfTheDay

string

Linux 節點當天的訊息,base64 編碼。 base64 編碼的字串,將在譯碼之後寫入 /etc/motd。 這允許自定義 Linux 節點當天的訊息。 Windows 節點不得指定此參數。 它必須是靜態字串(也就是將列印為未經處理,而不是以腳本的形式執行)。

MachineProperties

機器的屬性

名稱 類型 預設值 Description
billing

MachineBillingProfile

這些屬性與機器計費有關。

eTag

string

用來實作開放式並行存取的唯一隻讀字串。 更新資源時,eTag 值將會變更。 指定 if-match 或 if-none-match 標頭,其中包含後續請求的 eTag 值,以根據一般 eTag 慣例啟用樂觀並行。

evictionPolicy

ScaleSetEvictionPolicy

Delete

機器的驅逐政策。 除非優先順序是「Spot」,否則無法指定。 如果未指定,則預設值為 『Delete』。

hardware

MachineHardwareProfile

計算機的硬體和 GPU 設置。

kubernetes

MachineKubernetesProfile

計算機使用的 Kubernetes 配置。

localDNSProfile

LocalDNSProfile

使用 VnetDNS 和 KubeDNS 覆蓋配置每個節點的本地 DNS。 LocalDNS 有助於提高 AKS 群集中 DNS 解析的性能和可靠性。 有關更多詳細資訊,請參閱 aka.ms/aks/localdns。

mode

AgentPoolMode

機器只允許 『System』 和 『User』 模式。

network

MachineNetworkProperties

計算機的網路屬性

nodeImageVersion

string

節點映像的版本。

operatingSystem

MachineOSProfile

計算機使用的作系統和磁碟。

priority

ScaleSetPriority

Regular

計算機的優先順序。 如果未指定,則預設值為 『Regular』。

provisioningState

string

目前的部署或布建狀態。

resourceId

string (arm-id)

機器的 Azure 資源識別碼。 它可用來取得基礎 VM 執行個體

security

MachineSecurityProfile

計算機的安全設置。

status

MachineStatus

包含有關計算機的唯讀資訊。

tags

object

要保留在電腦上的標記。

MachineSecurityProfile

計算機的安全設置。

名稱 類型 Description
enableEncryptionAtHost

boolean

是否要啟用主機型 OS 和數據磁碟驅動器加密。 這只支援特定虛擬機大小和特定 Azure 區域。 欲了解更多資訊,請參閱: https://docs.microsoft.com/azure/aks/enable-host-encryption

enableSecureBoot

boolean

安全開機是受信任的啟動功能,可確保只有已簽署的作系統和驅動程式才能開機。 如需詳細資訊,請參閱 aka.ms/aks/trustedlaunch。 如果未指定,則預設值為 false。

enableVTPM

boolean

vTPM 是受信任的啟動功能,用於設定節點上本機所保留密鑰和度量的專用安全保存庫。 如需詳細資訊,請參閱 aka.ms/aks/trustedlaunch。 如果未指定,則預設值為 false。

sshAccess

AgentPoolSSHAccess

代理池的 SSH access 方法。

MachineStatus

包含有關計算機的唯讀資訊。

名稱 類型 Description
creationTimestamp

string (date-time)

指定建立機器的時間。

driftAction

DriftAction

機器的漂移動作。 指出機器是否因受管理叢集內容變更而偏離其預期狀態,需要採取更正動作。

driftReason

string

機器漂移的原因。 提供有關機器漂移原因的詳細資訊。 如果機器是最新的,則會省略此欄位。

provisioningError

ErrorDetail

錯誤會詳細說明本機的資訊。 保留失敗的詳細資訊。 如果沒有錯誤,則省略此欄位。

vmState

VmState

虛擬機器狀態。 指出基礎虛擬機器的目前狀態。

ManagementMode

管理式GPU體驗會在GPU驅動程式之上安裝額外元件,例如資料中心GPU管理器(DCGM)指標以監控。 想了解更多安裝內容,請參考 aka.ms/aks/managed-gpu。

Description
Unmanaged

NVIDIA GPU 的管理型 GPU 體驗是被關閉的。

Managed

NVIDIA GPU 已啟用管理型 GPU 體驗。

MigStrategy

設定用於管理型 MIG 支援的 MIG(多實例 GPU)策略。 欲了解更多不同策略資訊,請造訪 aka.ms/aks/managed-gpu。 未指定時,預設為無。

Description
None

不要設定MIG策略。 如果你之前有一個 SET,這會覆蓋它並移除 set MIG 策略。

Single

將管理式 MIG 策略設為單機。

Mixed

將管理MIG的MIG策略設為混合型。

NvidiaGPUProfile

NVIDIA 專用的 GPU 設定

名稱 類型 Description
managementMode

ManagementMode

管理式GPU體驗會在GPU驅動程式之上安裝額外元件,例如資料中心GPU管理器(DCGM)指標以監控。 想了解更多安裝內容,請參考 aka.ms/aks/managed-gpu。

migStrategy

MigStrategy

設定用於管理型 MIG 支援的 MIG(多實例 GPU)策略。 欲了解更多不同策略資訊,請造訪 aka.ms/aks/managed-gpu。 未指定時,預設為無。

OSDiskType

要用於代理程式集區中機器的 OS 磁碟類型。 如果 VM 支援,且快取磁碟大於要求的 OSDiskSizeGB,則預設值為 「暫時」。 否則,預設為 「受控」。 建立之後可能不會變更。 更多資訊請參見 Ephemeral OS

Description
Managed

Azure 會將虛擬機器的作業系統磁碟複寫至 Azure 儲存體,以避免在 VM 需要重新定位至另一部主機時遺失資料。 由於容器並非設計為保存本機狀態,因此此行為會提供有限的值,同時提供一些缺點,包括較慢的節點布建和較高的讀取/寫入延遲。

Ephemeral

暫時性 OS 磁碟只會儲存在主機上,就像暫存磁碟一樣。 這可提供較低的讀取/寫入延遲,以及更快的節點調整和叢集升級。

OSSKU

指定代理程式集區所使用的 OS SKU。 如果OSType為Linux,則預設值為Ubuntu。 當 Kubernetes <= 1.24 或 Windows2022 時,如果 OSType >為 Windows,則預設值為 Windows2019。

Description
Ubuntu

使用Ubuntu作為節點映像的OS。

AzureLinux

使用 AzureLinux 作為節點映像的 OS。 Azure Linux 是Microsoft所建置的容器優化Linux散發版本,如需詳細資訊,請造訪 https://aka.ms/azurelinux

AzureLinux3

使用 AzureLinux3 作為節點映像的 OS。 Azure Linux 是Microsoft所建置的容器優化Linux散發版本,如需詳細資訊,請造訪 https://aka.ms/azurelinux。 有關限制,請訪問 https://aka.ms/aks/node-images。 如需作業系統移轉指引,請參閱 https://aka.ms/aks/upgrade-os-version

Mariner

已被取代的 OSSKU。 Microsoft建議新的部署改為選擇 『AzureLinux』。

Flatcar

使用 Flatcar Container Linux 作為節點映像的作業系統。 Flatcar 是一個容器優化、注重安全的 Linux 操作系統,具有不可變的文件系統和雲原生計算基金會 (CNCF) 的一部分。 如需適用於 AKS 的 Flatcar 容器 Linux 的詳細資訊,請參閱 aka.ms/aks/flatcar-container-linux-for-aks

CBLMariner

已被取代的 OSSKU。 Microsoft建議新的部署改為選擇 『AzureLinux』。

Windows2019

使用 Windows2019 作為節點映像的 OS。 不支援系統節點集區。 Windows2019 僅支援 Windows2019 容器;它無法執行 Windows2022 容器,反之亦然。

Windows2022

使用 Windows2022 作為節點映像的 OS。 不支援系統節點集區。 Windows2022 僅支援 Windows2022 容器;它無法執行 Windows2019 容器,反之亦然。

Ubuntu2204

使用Ubuntu2204作為節點映像的作系統,但是,並非所有節點池都支援Ubuntu 22.04。 如需限制和支援的 Kubernetes 版本,請參閱 https://aka.ms/aks/supported-ubuntu-versions

Windows2025

使用 Windows2025 作為節點映像的作業系統。 不支援系統節點集區。 Windows2025 支援 Windows2022 和 Windows 2025 容器;它無法運行 Windows2019 容器,反之亦然。

WindowsAnnual

使用 Windows 年度通道版本作為節點映像的 OS。 不支援系統節點集區。 如需不同 AKS 年度通道版本下支援的容器映像和 kubernetes 版本的詳細數據,請參閱 https://aka.ms/aks/windows-annual-channel-details

Ubuntu2404

使用Ubuntu2404作為節點映像的作系統,但是,並非所有節點池都支援Ubuntu 24.04。 有關限制和支援的 kubernetes 版本,請參閱 https://aka.ms/aks/supported-ubuntu-versions

OSType

作系統類型。 預設值為Linux。

Description
Linux

使用 Linux。

Windows

使用 Windows。

ScaleSetEvictionPolicy

虛擬機器擴展集收回原則。 驅逐政策會明確說明當虛擬機被驅逐時to do什麼。 預設值為刪除。 欲了解更多驅逐資訊,請參見 spot VMs

Description
Delete

節點集區基礎擴展集中的節點會在收回時刪除。

Deallocate

節點集區基礎擴展集中的節點會在收回時設定為已停止解除配置狀態。 針對計算配額,停止解除分配狀態計數中的節點,並可能導致叢集調整或升級的問題。

ScaleSetPriority

虛擬機擴展集優先順序。

Description
Spot

將使用Spot優先順序VM。 現成節點沒有 SLA。 如需詳細資訊,請參閱 AKS 上的 位置。

Regular

將使用常規虛擬機器。

SeccompDefault

指定套用至所有工作負載的預設 seccomp 設定檔。 如果未指定,預設會使用 『Unconfined』。

Description
Unconfined

未套用 seccomp 設定檔,允許所有系統呼叫。

RuntimeDefault

會套用儲存器執行時期的預設 seccomp 設定檔,以限制某些系統呼叫以加強安全性。

SysctlConfig

Linux 代理程序節點的 Sysctl 設定。

名稱 類型 Description
fsAioMaxNr

integer (int32)

Sysctl 設定 fs.aio-max-nr。

fsFileMax

integer (int32)

Sysctl 設定 fs.file-max。

fsInotifyMaxUserWatches

integer (int32)

Sysctl 設定fs.inotify.max_user_watches。

fsNrOpen

integer (int32)

Sysctl 設定fs.nr_open。

kernelThreadsMax

integer (int32)

Sysctl 設定 kernel.threads-max。

netCoreNetdevMaxBacklog

integer (int32)

Sysctl 設定net.core.netdev_max_backlog。

netCoreOptmemMax

integer (int32)

Sysctl 設定net.core.optmem_max。

netCoreRmemDefault

integer (int32)

Sysctl 設定net.core.rmem_default。

netCoreRmemMax

integer (int32)

Sysctl 設定net.core.rmem_max。

netCoreSomaxconn

integer (int32)

Sysctl 設定 net.core.somaxconn。

netCoreWmemDefault

integer (int32)

Sysctl 設定net.core.wmem_default。

netCoreWmemMax

integer (int32)

Sysctl 設定net.core.wmem_max。

netIpv4IpLocalPortRange

string

Sysctl 設定net.ipv4.ip_local_port_range。

netIpv4NeighDefaultGcThresh1

integer (int32)

Sysctl 設定net.ipv4.neigh.default.gc_thresh1。

netIpv4NeighDefaultGcThresh2

integer (int32)

Sysctl 設定net.ipv4.neigh.default.gc_thresh2。

netIpv4NeighDefaultGcThresh3

integer (int32)

Sysctl 設定net.ipv4.neigh.default.gc_thresh3。

netIpv4TcpFinTimeout

integer (int32)

Sysctl 設定net.ipv4.tcp_fin_timeout。

netIpv4TcpKeepaliveProbes

integer (int32)

Sysctl 設定net.ipv4.tcp_keepalive_probes。

netIpv4TcpKeepaliveTime

integer (int32)

Sysctl 設定net.ipv4.tcp_keepalive_time。

netIpv4TcpMaxSynBacklog

integer (int32)

Sysctl 設定net.ipv4.tcp_max_syn_backlog。

netIpv4TcpMaxTwBuckets

integer (int32)

Sysctl 設定net.ipv4.tcp_max_tw_buckets。

netIpv4TcpTwReuse

boolean

Sysctl 設定net.ipv4.tcp_tw_reuse。

netIpv4TcpkeepaliveIntvl

integer (int32)

minimum: 10
maximum: 90

Sysctl 設定net.ipv4.tcp_keepalive_intvl。

netNetfilterNfConntrackBuckets

integer (int32)

minimum: 65536
maximum: 524288

Sysctl 設定net.netfilter.nf_conntrack_buckets。

netNetfilterNfConntrackMax

integer (int32)

minimum: 131072
maximum: 2097152

Sysctl 設定net.netfilter.nf_conntrack_max。

vmMaxMapCount

integer (int32)

Sysctl 設定vm.max_map_count。

vmSwappiness

integer (int32)

Sysctl 設定 vm.swappiness。

vmVfsCachePressure

integer (int32)

Sysctl 設定vm.vfs_cache_pressure。

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string (date-time)

資源建立的時間戳(UTC)。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string (date-time)

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。

VmState

虛擬機器狀態。 指出基礎虛擬機器的目前狀態。

Description
Running

虛擬機器目前正在執行中。

Deleted

虛擬機器已被使用者刪除或由於 Spot 收回。

WorkloadRuntime

決定節點可執行的工作負載類型。

Description
OCIContainer

節點會使用 Kubelet 來執行標準 OCI 容器工作負載。

WasmWasi

節點會使用 Krustlet 使用 WASI 提供者來執行 WASM 工作負載(預覽)。

KataMshvVmIsolation

節點可以使用 (Kata + Cloud Hypervisor + Hyper-V) 來啟用巢狀 VM 型 Pod(預覽)。 由於使用 Hyper-V,AKS 節點 OS 本身是 Hyper-V 的巢狀 VM(根 OS)。 因此,它只能與支援巢狀虛擬化的 VM 系列搭配使用,例如 Dv3 系列。 此命名慣例將在未來的版本中被取代,以支持 KataVmIsolation。

KataVmIsolation

節點可以使用 (Kata + Cloud Hypervisor + Hyper-V) 來啟用巢狀虛擬機器型網繭。 由於使用 Hyper-V,AKS 節點 OS 本身是 Hyper-V 的巢狀 VM(根 OS)。 因此,它只能與支援巢狀虛擬化的 VM 系列搭配使用,例如 Dv3 系列。