Agent Pools - Get
取得指定的受控叢集代理程式集區。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}?api-version=2024-09-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
agent
|
path | True |
string |
代理程式集區的名稱。 Regex 模式: |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
resource
|
path | True |
string |
受控叢集資源的名稱。 Regex 模式: |
subscription
|
path | True |
string uuid |
目標訂用帳戶的標識碼。 此值必須是 UUID。 |
api-version
|
query | True |
string |
要用於這項作業的 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
還行 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Get Agent Pool
範例要求
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2024-09-01
範例回覆
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
"name": "agentpool1",
"properties": {
"provisioningState": "Succeeded",
"count": 3,
"vmSize": "Standard_DS1_v2",
"maxPods": 110,
"osType": "Linux",
"eTag": "ebwiyfneowv",
"orchestratorVersion": "1.9.6",
"currentOrchestratorVersion": "1.9.6",
"nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
"upgradeSettings": {
"maxSurge": "33%"
}
}
}
定義
名稱 | Description |
---|---|
Agent |
代理程式集區。 |
Agent |
代理程式集區的模式。 |
Agent |
代理程式集區的網路設定。 |
Agent |
代理程式集區的安全性設定。 |
Agent |
Agent 集區的類型。 |
Agent |
升級代理程式集池的設定 |
Agent |
Windows 代理程式集區的特定配置檔。 |
Cloud |
來自容器服務的錯誤回應。 |
Cloud |
來自容器服務的錯誤回應。 |
code |
告知叢集是否正在執行或已停止 |
Creation |
從來源資源建立目標資源時所使用的數據。 |
GPUInstance |
要用來為支援的 GPU VM SKU 指定 GPU MIG 實例設定檔的 GPUInstanceProfile。 |
IPTag |
包含與 對象相關聯的IPTag。 |
Kubelet |
代理程序節點的 Kubelet 組態。 |
Kubelet |
決定 emptyDir 磁碟區、容器運行時間數據根目錄和 Kubelet 暫時記憶體的位置。 |
Linux |
Linux 代理程序節點的 OS 組態。 |
OSDisk |
要用於代理程式集區中機器的 OS 磁碟類型。 |
OSSKU |
指定代理程式集區所使用的 OS SKU。 如果OSType為Linux,則預設值為Ubuntu。 當 Kubernetes <= 1.24 或 Windows2022 時,當 Kubernetes >= 1.25 如果 OSType 為 Windows,則預設值為 Windows2019。 |
OSType |
操作系統類型。 預設值為Linux。 |
Port |
埠範圍。 |
Power |
描述叢集的電源狀態 |
Protocol |
埠的網路通訊協定。 |
Scale |
描述如何將 VM 新增至代理程式集區或從代理程式集區中移除。 請參閱 |
Scale |
虛擬機擴展集收回原則。 |
Scale |
虛擬機擴展集優先順序。 |
Sysctl |
Linux 代理程序節點的 Sysctl 設定。 |
Workload |
決定節點可執行的工作負載類型。 |
AgentPool
代理程式集區。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
id |
string |
資源標識碼。 |
|
name |
string |
資源群組內唯一的資源名稱。 此名稱可用來存取資源。 |
|
properties.availabilityZones |
string[] |
要用於節點的可用性區域清單。 只有在 AgentPoolType 屬性是 'VirtualMachineScaleSets' 時,才能指定這個值。 |
|
properties.capacityReservationGroupID |
string |
容量保留群組的完整資源標識符,可從保留的虛擬機群組提供虛擬機。 |
|
properties.count |
integer |
裝載 Docker 容器的代理程式 (VM) 數目。 允許的值必須介於使用者集區的 0 到 1000(含)範圍內,且系統集區的範圍為 1 到 1000(含)。 預設值為 1。 |
|
properties.creationData |
如果節點集區將會使用快照集建立/升級,則用來指定來源快照集標識符的 CreationData。 |
||
properties.currentOrchestratorVersion |
string |
Agent 集區正在執行的 Kubernetes 版本。 |
|
properties.eTag |
string |
用來實作開放式並行存取的唯一隻讀字串。 更新資源時,eTag 值將會變更。 針對後續要求指定 if-match 或 if-none-match 標頭,以針對後續要求指定 if-match 或 if-none-match 標頭,以根據一般 etag 慣例啟用開放式並行存取。 |
|
properties.enableAutoScaling |
boolean |
是否要啟用自動調整程式 |
|
properties.enableEncryptionAtHost |
boolean |
是否要啟用主機型 OS 和數據磁碟驅動器加密。 |
|
properties.enableFIPS |
boolean |
是否要使用已啟用 FIPS 的 OS。 |
|
properties.enableNodePublicIP |
boolean |
每個節點是否配置自己的公用IP。 |
|
properties.enableUltraSSD |
boolean |
是否要啟用 UltraSSD |
|
properties.gpuInstanceProfile |
要用來為支援的 GPU VM SKU 指定 GPU MIG 實例設定檔的 GPUInstanceProfile。 |
||
properties.hostGroupID |
string |
專用主機群組用來布建虛擬機的完整資源標識符,僅用於建立案例,且一旦設定后就不允許變更。 |
|
properties.kubeletConfig |
代理程序節點的 Kubelet 組態。 |
||
properties.kubeletDiskType |
決定 emptyDir 磁碟區、容器運行時間數據根目錄和 Kubelet 暫時記憶體的位置。 |
||
properties.linuxOSConfig |
Linux 代理程序節點的 OS 組態。 |
||
properties.maxCount |
integer |
自動調整的節點數目上限 |
|
properties.maxPods |
integer |
可在節點上執行的 Pod 數目上限。 |
|
properties.minCount |
integer |
自動調整的節點數目下限 |
|
properties.mode |
代理程式集區的模式。 |
||
properties.networkProfile |
代理程式集區的網路相關設定。 |
||
properties.nodeImageVersion |
string |
節點映像的版本 |
|
properties.nodeLabels |
object |
要跨代理程式集區中所有節點保存的節點標籤。 |
|
properties.nodePublicIPPrefixID |
string |
VM 節點應該使用IP的公用IP前置詞標識碼。 |
|
properties.nodeTaints |
string[] |
節點集區建立和調整期間新增至新節點的污點。 例如,key=value:NoSchedule。 |
|
properties.orchestratorVersion |
string |
使用者指定的 Kubernetes 版本。 |
|
properties.osDiskSizeGB |
integer |
OS 磁碟大小 GB,用來指定主要/代理程式集區中每部計算機的磁碟大小。 如果您指定 0,它會根據指定的 vmSize 套用預設 osDisk 大小。 |
|
properties.osDiskType |
要用於代理程式集區中機器的 OS 磁碟類型。 |
||
properties.osSKU |
指定代理程式集區所使用的 OS SKU。 如果OSType為Linux,則預設值為Ubuntu。 當 Kubernetes <= 1.24 或 Windows2022 時,當 Kubernetes >= 1.25 如果 OSType 為 Windows,則預設值為 Windows2019。 |
||
properties.osType | Linux |
操作系統類型。 預設值為Linux。 |
|
properties.podSubnetID |
string |
啟動時,Pod 會加入之子網的標識碼。 |
|
properties.powerState |
代理程式集區正在執行或停止。 |
||
properties.provisioningState |
string |
目前的部署或布建狀態。 |
|
properties.proximityPlacementGroupID |
string |
鄰近放置群組的標識碼。 |
|
properties.scaleDownMode |
調整代理程式集區時要使用的相應減少模式。 |
||
properties.scaleSetEvictionPolicy | Delete |
要使用的虛擬機擴展集收回原則。 |
|
properties.scaleSetPriority | Regular |
虛擬機擴展集優先順序。 如果未指定,則預設值為 『Regular』。 |
|
properties.securityProfile |
代理程式集區的安全性設定。 |
||
properties.spotMaxPrice |
number |
-1 |
您願意為現成實例支付的最高價格(以美元為單位)。 可能的值為大於零或 -1 的任何十進位值,表示依需求 up-to 默認價格。 |
properties.tags |
object |
要保存在代理程式集區虛擬機擴展集上的標記。 |
|
properties.type |
Agent 集區的類型。 |
||
properties.upgradeSettings |
升級代理程式集池的設定 |
||
properties.vmSize |
string |
代理程式集區 VM 的大小。 |
|
properties.vnetSubnetID |
string |
代理程式集區節點和選擇性 Pod 將在啟動時加入的子網標識碼。 |
|
properties.windowsProfile |
Windows 代理程式集區的特定配置檔。 |
||
properties.workloadRuntime |
決定節點可執行的工作負載類型。 |
||
type |
string |
資源類型 |
AgentPoolMode
代理程式集區的模式。
名稱 | 類型 | Description |
---|---|---|
System |
string |
系統代理程式集區主要是用來裝載重要的系統 Pod,例如 CoreDNS 和 metrics-server。 系統代理程式集區 osType 必須是 Linux。 系統代理程式集區 VM SKU 必須至少有 2vCPU 和 4 GB 的記憶體。 |
User |
string |
使用者代理程式集區主要是用來裝載應用程式Pod。 |
AgentPoolNetworkProfile
代理程式集區的網路設定。
名稱 | 類型 | Description |
---|---|---|
allowedHostPorts |
允許存取的埠範圍。 允許指定的範圍重疊。 |
|
applicationSecurityGroups |
string[] |
應用程式安全組的標識碼,代理程式集區會在建立時產生關聯。 |
nodePublicIPTags |
IPTag[] |
實例層級公用IP的IPTag。 |
AgentPoolSecurityProfile
代理程式集區的安全性設定。
名稱 | 類型 | Description |
---|---|---|
enableSecureBoot |
boolean |
安全開機是受信任的啟動功能,可確保只有已簽署的作業系統和驅動程式才能開機。 如需詳細資訊,請參閱 aka.ms/aks/trustedlaunch。 如果未指定,則預設值為 false。 |
enableVTPM |
boolean |
vTPM 是受信任的啟動功能,用於設定節點上本機所保留密鑰和度量的專用安全保存庫。 如需詳細資訊,請參閱 aka.ms/aks/trustedlaunch。 如果未指定,則預設值為 false。 |
AgentPoolType
Agent 集區的類型。
名稱 | 類型 | Description |
---|---|---|
AvailabilitySet |
string |
強烈建議不要使用此方式。 |
VirtualMachineScaleSets |
string |
建立虛擬機擴展集所支援的代理程式集區。 |
AgentPoolUpgradeSettings
升級代理程式集池的設定
名稱 | 類型 | Description |
---|---|---|
drainTimeoutInMinutes |
integer |
節點的清空逾時 |
maxSurge |
string |
升級期間激增的節點數目或百分比上限。 |
nodeSoakDurationInMinutes |
integer |
節點的浸泡持續時間 |
AgentPoolWindowsProfile
Windows 代理程式集區的特定配置檔。
名稱 | 類型 | Description |
---|---|---|
disableOutboundNat |
boolean |
是否要在 Windows 節點中停用輸出NAT |
CloudError
來自容器服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
錯誤的詳細數據。 |
CloudErrorBody
來自容器服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤的識別碼。 程序代碼是不變的,而且是要以程序設計方式取用。 |
details |
錯誤的其他詳細數據清單。 |
|
message |
string |
描述錯誤的訊息,適用於在使用者介面中顯示。 |
target |
string |
特定錯誤的目標。 例如,錯誤中的屬性名稱。 |
code
告知叢集是否正在執行或已停止
名稱 | 類型 | Description |
---|---|---|
Running |
string |
叢集正在執行。 |
Stopped |
string |
叢集已停止。 |
CreationData
從來源資源建立目標資源時所使用的數據。
名稱 | 類型 | Description |
---|---|---|
sourceResourceId |
string |
這是要用來建立目標物件的來源物件的 ARM 識別碼。 |
GPUInstanceProfile
要用來為支援的 GPU VM SKU 指定 GPU MIG 實例設定檔的 GPUInstanceProfile。
名稱 | 類型 | Description |
---|---|---|
MIG1g |
string |
|
MIG2g |
string |
|
MIG3g |
string |
|
MIG4g |
string |
|
MIG7g |
string |
IPTag
包含與 對象相關聯的IPTag。
名稱 | 類型 | Description |
---|---|---|
ipTagType |
string |
IP 標籤類型。 範例:RoutingPreference。 |
tag |
string |
與公用IP相關聯的IP標籤。 範例:因特網。 |
KubeletConfig
代理程序節點的 Kubelet 組態。
名稱 | 類型 | Description |
---|---|---|
allowedUnsafeSysctls |
string[] |
允許的不安全 sysctls 或 unsafe sysctl 模式清單(以 |
containerLogMaxFiles |
integer |
容器可存在的容器記錄檔數目上限。 數字必須≥ 2。 |
containerLogMaxSizeMB |
integer |
容器記錄檔的大小上限(例如 10Mi)在輪替之前。 |
cpuCfsQuota |
boolean |
如果針對指定 CPU 限制的容器啟用 CPU CFS 配額強制執行。 |
cpuCfsQuotaPeriod |
string |
CPU CFS 配額期間值。 |
cpuManagerPolicy |
string |
要使用的 CPU 管理員原則。 |
failSwapOn |
boolean |
如果設定為 true,當節點上啟用交換時,Kubelet 將無法啟動。 |
imageGcHighThreshold |
integer |
磁碟使用量的百分比,之後映射垃圾收集一律會執行。 |
imageGcLowThreshold |
integer |
永遠不會執行映射垃圾收集的磁碟使用量百分比。 |
podMaxPids |
integer |
每個 Pod 的進程數目上限。 |
topologyManagerPolicy |
string |
要使用的拓撲管理員原則。 |
KubeletDiskType
決定 emptyDir 磁碟區、容器運行時間數據根目錄和 Kubelet 暫時記憶體的位置。
名稱 | 類型 | Description |
---|---|---|
OS |
string |
Kubelet 會將 OS 磁碟用於其數據。 |
Temporary |
string |
Kubelet 會將其數據使用暫存磁碟。 |
LinuxOSConfig
Linux 代理程序節點的 OS 組態。
名稱 | 類型 | Description |
---|---|---|
swapFileSizeMB |
integer |
將在每個節點上建立之交換檔案 MB 的大小。 |
sysctls |
Linux 代理程序節點的 Sysctl 設定。 |
|
transparentHugePageDefrag |
string |
核心是否應該積極使用記憶體壓縮,讓更多的大量頁面可供使用。 |
transparentHugePageEnabled |
string |
是否啟用透明巨頁。 |
OSDiskType
要用於代理程式集區中機器的 OS 磁碟類型。
名稱 | 類型 | Description |
---|---|---|
Ephemeral |
string |
暫時 OS 磁碟只會儲存在主電腦上,就像暫存磁碟一樣。 這可提供較低的讀取/寫入延遲,以及更快的節點調整和叢集升級。 |
Managed |
string |
Azure 會將虛擬機的操作系統磁碟複寫至 Azure 記憶體,以避免數據遺失,如果 VM 需要重新放置至另一部主機。 由於容器並非設計為保存本機狀態,因此此行為會提供有限的值,同時提供一些缺點,包括較慢的節點布建和較高的讀取/寫入延遲。 |
OSSKU
指定代理程式集區所使用的 OS SKU。 如果OSType為Linux,則預設值為Ubuntu。 當 Kubernetes <= 1.24 或 Windows2022 時,當 Kubernetes >= 1.25 如果 OSType 為 Windows,則預設值為 Windows2019。
名稱 | 類型 | Description |
---|---|---|
AzureLinux |
string |
使用 AzureLinux 作為節點映像的 OS。 Azure Linux 是Microsoft所建置的容器優化Linux散發版本,如需詳細資訊,請造訪 https://aka.ms/azurelinux。 |
CBLMariner |
string |
已被取代的 OSSKU。 Microsoft建議新的部署改為選擇 『AzureLinux』。 |
Ubuntu |
string |
使用Ubuntu作為節點映像的OS。 |
Windows2019 |
string |
使用 Windows2019 作為節點映像的 OS。 不支援系統節點集區。 Windows2019 僅支援 Windows2019 容器;它無法執行 Windows2022 容器,反之亦然。 |
Windows2022 |
string |
使用 Windows2022 作為節點映像的 OS。 不支援系統節點集區。 Windows2022 僅支援 Windows2022 容器;它無法執行 Windows2019 容器,反之亦然。 |
OSType
操作系統類型。 預設值為Linux。
名稱 | 類型 | Description |
---|---|---|
Linux |
string |
使用 Linux。 |
Windows |
string |
使用 Windows。 |
PortRange
埠範圍。
名稱 | 類型 | Description |
---|---|---|
portEnd |
integer |
範圍中包含的最大埠。 它的範圍應從 1 到 65535,且大於或等於 portStart。 |
portStart |
integer |
範圍中包含的最小埠。 它的範圍應從 1 到 65535,且小於或等於 portEnd。 |
protocol |
埠的網路通訊協定。 |
PowerState
描述叢集的電源狀態
名稱 | 類型 | Description |
---|---|---|
code |
告知叢集是否正在執行或已停止 |
Protocol
埠的網路通訊協定。
名稱 | 類型 | Description |
---|---|---|
TCP |
string |
TCP 通訊協定。 |
UDP |
string |
UDP 通訊協定。 |
ScaleDownMode
描述如何將 VM 新增至代理程式集區或從代理程式集區中移除。 請參閱
名稱 | 類型 | Description |
---|---|---|
Deallocate |
string |
嘗試在相應增加期間啟動已解除分配的實例,並在相應減少期間解除分配實例。 |
Delete |
string |
在相應增加期間建立新的實例,並在相應減少期間移除實例。 |
ScaleSetEvictionPolicy
虛擬機擴展集收回原則。
名稱 | 類型 | Description |
---|---|---|
Deallocate |
string |
節點集區基礎擴展集中的節點會在收回時設定為已停止解除分配的狀態。 針對計算配額,停止解除分配狀態計數中的節點,並可能導致叢集調整或升級的問題。 |
Delete |
string |
節點集區基礎擴展集中的節點會在收回時刪除。 |
ScaleSetPriority
虛擬機擴展集優先順序。
名稱 | 類型 | Description |
---|---|---|
Regular |
string |
將會使用一般 VM。 |
Spot |
string |
將會使用現成優先順序 VM。 現成節點沒有 SLA。 如需詳細資訊,請參閱 AKS 上的 |
SysctlConfig
Linux 代理程序節點的 Sysctl 設定。
名稱 | 類型 | Description |
---|---|---|
fsAioMaxNr |
integer |
Sysctl 設定 fs.aio-max-nr。 |
fsFileMax |
integer |
Sysctl 設定 fs.file-max。 |
fsInotifyMaxUserWatches |
integer |
Sysctl 設定fs.inotify.max_user_watches。 |
fsNrOpen |
integer |
Sysctl 設定fs.nr_open。 |
kernelThreadsMax |
integer |
Sysctl 設定 kernel.threads-max。 |
netCoreNetdevMaxBacklog |
integer |
Sysctl 設定net.core.netdev_max_backlog。 |
netCoreOptmemMax |
integer |
Sysctl 設定net.core.optmem_max。 |
netCoreRmemDefault |
integer |
Sysctl 設定net.core.rmem_default。 |
netCoreRmemMax |
integer |
Sysctl 設定net.core.rmem_max。 |
netCoreSomaxconn |
integer |
Sysctl 設定 net.core.somaxconn。 |
netCoreWmemDefault |
integer |
Sysctl 設定net.core.wmem_default。 |
netCoreWmemMax |
integer |
Sysctl 設定net.core.wmem_max。 |
netIpv4IpLocalPortRange |
string |
Sysctl 設定net.ipv4.ip_local_port_range。 |
netIpv4NeighDefaultGcThresh1 |
integer |
Sysctl 設定net.ipv4.neigh.default.gc_thresh1。 |
netIpv4NeighDefaultGcThresh2 |
integer |
Sysctl 設定net.ipv4.neigh.default.gc_thresh2。 |
netIpv4NeighDefaultGcThresh3 |
integer |
Sysctl 設定net.ipv4.neigh.default.gc_thresh3。 |
netIpv4TcpFinTimeout |
integer |
Sysctl 設定net.ipv4.tcp_fin_timeout。 |
netIpv4TcpKeepaliveProbes |
integer |
Sysctl 設定net.ipv4.tcp_keepalive_probes。 |
netIpv4TcpKeepaliveTime |
integer |
Sysctl 設定net.ipv4.tcp_keepalive_time。 |
netIpv4TcpMaxSynBacklog |
integer |
Sysctl 設定net.ipv4.tcp_max_syn_backlog。 |
netIpv4TcpMaxTwBuckets |
integer |
Sysctl 設定net.ipv4.tcp_max_tw_buckets。 |
netIpv4TcpTwReuse |
boolean |
Sysctl 設定net.ipv4.tcp_tw_reuse。 |
netIpv4TcpkeepaliveIntvl |
integer |
Sysctl 設定net.ipv4.tcp_keepalive_intvl。 |
netNetfilterNfConntrackBuckets |
integer |
Sysctl 設定net.netfilter.nf_conntrack_buckets。 |
netNetfilterNfConntrackMax |
integer |
Sysctl 設定net.netfilter.nf_conntrack_max。 |
vmMaxMapCount |
integer |
Sysctl 設定vm.max_map_count。 |
vmSwappiness |
integer |
Sysctl 設定 vm.swappiness。 |
vmVfsCachePressure |
integer |
Sysctl 設定vm.vfs_cache_pressure。 |
WorkloadRuntime
決定節點可執行的工作負載類型。
名稱 | 類型 | Description |
---|---|---|
OCIContainer |
string |
節點會使用 Kubelet 來執行標準 OCI 容器工作負載。 |
WasmWasi |
string |
節點會使用 Krustlet 使用 WASI 提供者來執行 WASM 工作負載(預覽)。 |