你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Agent Pools - Get

参考

服务:: AKS

API 版本:: 2024-09-01

获取指定的托管群集代理池。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}?api-version=2024-09-01

URI 参数

名称	在	必需	类型	说明
agentPoolName	path	True	string	代理池的名称。正则表达式模式: `^[a-z][a-z0-9]{0,11}$`
resourceGroupName	path	True	string	资源组的名称。名称不区分大小写。
resourceName	path	True	string	托管群集资源的名称。正则表达式模式: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	AgentPool	还行
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python agent_pools_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.agent_pools.get(
        resource_group_name="rg1",
        resource_name="clustername1",
        agent_pool_name="agentpool1",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json
func ExampleAgentPoolsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAgentPoolsClient().Get(ctx, "rg1", "clustername1", "agentpool1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AgentPool = armcontainerservice.AgentPool{
	// 	Name: to.Ptr("agentpool1"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1"),
	// 	Properties: &armcontainerservice.ManagedClusterAgentPoolProfileProperties{
	// 		Count: to.Ptr[int32](3),
	// 		CurrentOrchestratorVersion: to.Ptr("1.9.6"),
	// 		ETag: to.Ptr("ebwiyfneowv"),
	// 		MaxPods: to.Ptr[int32](110),
	// 		NodeImageVersion: to.Ptr("AKSUbuntu:1604:2020.03.11"),
	// 		OrchestratorVersion: to.Ptr("1.9.6"),
	// 		OSType: to.Ptr(armcontainerservice.OSTypeLinux),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		UpgradeSettings: &armcontainerservice.AgentPoolUpgradeSettings{
	// 			MaxSurge: to.Ptr("33%"),
	// 		},
	// 		VMSize: to.Ptr("Standard_DS1_v2"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified managed cluster agent pool.
 *
 * @summary Gets the specified managed cluster agent pool.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/AgentPoolsGet.json
 */
async function getAgentPool() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const agentPoolName = "agentpool1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.agentPools.get(resourceGroupName, resourceName, agentPoolName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "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%"
    }
  }
}

定义

名称	说明
AgentPool	代理池。
AgentPoolMode	代理池的模式。
AgentPoolNetworkProfile	代理池的网络设置。
AgentPoolSecurityProfile	代理池的安全设置。
AgentPoolType	代理池的类型。
AgentPoolUpgradeSettings	用于升级代理池的设置
AgentPoolWindowsProfile	Windows 代理池的特定配置文件。
CloudError	容器服务的错误响应。
CloudErrorBody	容器服务的错误响应。
code	指示群集是正在运行还是已停止
CreationData	从源资源创建目标资源时使用的数据。
GPUInstanceProfile	用于为支持的 GPU VM SKU 指定 GPU MIG 实例配置文件的 GPUInstanceProfile。
IPTag	包含与对象关联的 IPTag。
KubeletConfig	代理节点的 Kubelet 配置。
KubeletDiskType	确定 emptyDir 卷、容器运行时数据根目录和 Kubelet 临时存储的位置。
LinuxOSConfig	Linux 代理节点的 OS 配置。
OSDiskType	要用于代理池中的计算机的 OS 磁盘类型。
OSSKU	指定代理池使用的 OS SKU。如果 OSType 为 Linux，则默认值为 Ubuntu。当 Kubernetes <= 1.24 或 Windows2022 时，Kubernetes >= 1.25（如果 OSType 为 Windows）时，默认值为 Windows2019。
OSType	操作系统类型。默认值为 Linux。
PortRange	端口范围。
PowerState	描述群集的电源状态
Protocol	端口的网络协议。
ScaleDownMode	介绍如何在代理池中添加或删除 VM。请参阅计费状态。
ScaleSetEvictionPolicy	虚拟机规模集逐出策略。
ScaleSetPriority	虚拟机规模集优先级。
SysctlConfig	Linux 代理节点的 Sysctl 设置。
WorkloadRuntime	确定节点可以运行的工作负荷的类型。

AgentPool

代理池。

名称	类型	默认值	说明
id	string		资源 ID。
name	string		资源组中唯一的资源的名称。此名称可用于访问资源。
properties.availabilityZones	string[]		要用于节点的可用性区域列表。仅当 AgentPoolType 属性为“VirtualMachineScaleSets”时，才能指定此值。
properties.capacityReservationGroupID	string		容量预留组的完全限定资源 ID，用于从虚拟机的保留组提供虚拟机。 AKS 会将指定的代理池与容量预留组相关联。
properties.count	integer		用于托管 docker 容器的代理数（VM）。允许的值必须在用户池的 0 到 1000（含）范围内，系统池的范围为 1 到 1000（含）。默认值为 1。
properties.creationData	CreationData		如果使用快照创建/升级节点池，则用于指定源快照 ID 的 CreationData。
properties.currentOrchestratorVersion	string		代理池运行的 Kubernetes 版本。如果 orchestratorVersion 是一个完全指定的版本，<major.minor.patch>，则此字段将完全等于它。如果 orchestratorVersion <major.minor>，则此字段将包含正在使用的完整 <major.minor.patch> 版本。
properties.eTag	string		用于实现乐观并发的唯一只读字符串。更新资源时，eTag 值将更改。使用后续请求的 eTag 值指定 if-match 或 if-none-match 标头，以便根据正常的 etag 约定启用乐观并发。
properties.enableAutoScaling	boolean		是否启用自动缩放程序
properties.enableEncryptionAtHost	boolean		是否启用基于主机的 OS 和数据驱动器加密。这仅在某些 VM 大小和某些 Azure 区域中受支持。有关详细信息，请参阅：https://docs.microsoft.com/azure/aks/enable-host-encryption
properties.enableFIPS	boolean		是否使用已启用 FIPS 的 OS。有关详细信息，请参阅添加启用了 FIPS 的节点池。
properties.enableNodePublicIP	boolean		是否为每个节点分配自己的公共 IP。某些方案可能需要节点池中的节点接收其自己的专用公共 IP 地址。一种常见方案适用于游戏工作负载，其中主机需要与云虚拟机建立直接连接，以最大程度地减少跃点。有关详细信息，请参阅为每个节点分配公共 IP。默认值为 false。
properties.enableUltraSSD	boolean		是否启用 UltraSSD
properties.gpuInstanceProfile	GPUInstanceProfile		用于为支持的 GPU VM SKU 指定 GPU MIG 实例配置文件的 GPUInstanceProfile。
properties.hostGroupID	string		专用主机组的完全限定资源 ID，用于预配虚拟机，仅在创建方案中使用，不允许在设置后更改。此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}。有关详细信息，请参阅 Azure 专用主机。
properties.kubeletConfig	KubeletConfig		代理节点的 Kubelet 配置。代理池节点上的 Kubelet 配置。
properties.kubeletDiskType	KubeletDiskType		确定 emptyDir 卷、容器运行时数据根目录和 Kubelet 临时存储的位置。
properties.linuxOSConfig	LinuxOSConfig		Linux 代理节点的 OS 配置。 Linux 代理节点的 OS 配置。
properties.maxCount	integer		自动缩放的最大节点数
properties.maxPods	integer		可在节点上运行的 Pod 的最大数目。
properties.minCount	integer		自动缩放的最小节点数
properties.mode	AgentPoolMode		代理池的模式。群集必须随时至少有一个“系统”代理池。有关代理池限制和最佳做法的其他信息，请参阅：https://docs.microsoft.com/azure/aks/use-system-pools
properties.networkProfile	AgentPoolNetworkProfile		代理池的网络相关设置。
properties.nodeImageVersion	string		节点映像的版本
properties.nodeLabels	object		要跨代理池中的所有节点保留的节点标签。
properties.nodePublicIPPrefixID	string		VM 节点应使用 IP 的公共 IP 前缀 ID。此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
properties.nodeTaints	string[]		在节点池创建和缩放期间添加到新节点的污点。例如，key=value：NoSchedule。
properties.orchestratorVersion	string		用户指定的 Kubernetes 版本。支持两个修补程序版本 <major.minor.patch>（例如 1.20.13）和 <major.minor>（例如 1.20）。指定 <major.minor> 时，会自动选择最新的受支持的 GA 修补程序版本。创建群集后使用相同的 <major.minor>（例如 1.14.x -> 1.14）更新群集不会触发升级，即使更新的修补程序版本可用也是如此。最佳做法是，应将 AKS 群集中的所有节点池升级到同一 Kubernetes 版本。节点池版本必须与控制平面具有相同的主版本。节点池次要版本必须位于控制平面版本的两个次要版本中。节点池版本不能大于控制平面版本。有关详细信息，请参阅升级节点池。
properties.osDiskSizeGB	integer		OS 磁盘大小（以 GB 为单位）用于为主/代理池中的每个计算机指定磁盘大小。如果指定 0，它将根据指定的 vmSize 应用默认 osDisk 大小。
properties.osDiskType	OSDiskType		要用于代理池中的计算机的 OS 磁盘类型。如果 VM 支持该 VM 并且缓存磁盘大于请求的 OSDiskSizeGB，则默认值为“临时”。否则，默认为“Managed”。创建后可能不会更改。有关详细信息，请参阅临时 OS。
properties.osSKU	OSSKU		指定代理池使用的 OS SKU。如果 OSType 为 Linux，则默认值为 Ubuntu。当 Kubernetes <= 1.24 或 Windows2022 时，Kubernetes >= 1.25（如果 OSType 为 Windows）时，默认值为 Windows2019。
properties.osType	OSType	Linux	操作系统类型。默认值为 Linux。
properties.podSubnetID	string		启动时 Pod 将加入的子网的 ID。如果省略，则会在节点子网上静态分配 Pod IP（有关详细信息，请参阅 vnetSubnetID）。此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.powerState	PowerState		代理池是正在运行还是已停止。首次创建代理池时，它最初正在运行。可以通过将此字段设置为“已停止”来停止代理池。已停止的代理池会停止其所有 VM，不会产生计费费用。仅当代理池正在运行并且预配状态为“成功”时，才能停止代理池
properties.provisioningState	string		当前部署或预配状态。
properties.proximityPlacementGroupID	string		邻近放置组的 ID。
properties.scaleDownMode	ScaleDownMode		缩放代理池时要使用的缩减模式。这也会影响群集自动缩放程序的行为。如果未指定，则默认为 Delete。
properties.scaleSetEvictionPolicy	ScaleSetEvictionPolicy	Delete	要使用的虚拟机规模集逐出策略。除非 scaleSetPriority 为“Spot”，否则无法指定此项。如果未指定，则默认值为“Delete”。
properties.scaleSetPriority	ScaleSetPriority	Regular	虚拟机规模集优先级。如果未指定，则默认值为“Regular”。
properties.securityProfile	AgentPoolSecurityProfile		代理池的安全设置。
properties.spotMaxPrice	number	-1	你愿意支付现成实例的最大价格（以美元为单位）。可能的值是大于零或 -1 的任何小数值，指示要按需 up-to 的默认价格。可能的值是大于零或 -1 的任何小数值，表示愿意支付任何按需价格。有关现成定价的更多详细信息，请参阅现成 VM 定价
properties.tags	object		要保留在代理池虚拟机规模集上的标记。
properties.type	AgentPoolType		代理池的类型。
properties.upgradeSettings	AgentPoolUpgradeSettings		用于升级代理池的设置
properties.vmSize	string		代理池 VM 的大小。 VM 大小可用性因区域而异。如果节点包含的计算资源（内存、cpu 等）Pod 不足，可能无法正常运行。有关受限 VM 大小的更多详细信息，请参阅：https://docs.microsoft.com/azure/aks/quotas-skus-regions
properties.vnetSubnetID	string		代理池节点和（可选）Pod 将在启动时加入的子网的 ID。如果未指定，将生成和使用 VNET 和子网。如果未指定 podSubnetID，则这适用于节点和 Pod，否则它仅适用于节点。此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
properties.windowsProfile	AgentPoolWindowsProfile		Windows 代理池的特定配置文件。
properties.workloadRuntime	WorkloadRuntime		确定节点可以运行的工作负荷的类型。
type	string		资源类型

AgentPoolMode

代理池的模式。

名称	类型	说明
System	string	系统代理池主要用于托管关键系统 Pod，例如 CoreDNS 和 metrics-server。系统代理池 osType 必须是 Linux。系统代理池 VM SKU 必须至少具有 2vCPU 和 4GB 内存。
User	string	用户代理池主要用于托管应用程序 Pod。

AgentPoolNetworkProfile

代理池的网络设置。

名称	类型	说明
allowedHostPorts	PortRange[]	允许访问的端口范围。允许指定的范围重叠。
applicationSecurityGroups	string[]	创建代理池时将关联的应用程序安全组的 ID。
nodePublicIPTags	IPTag[]	实例级公共 IP 的 IPTag。

AgentPoolSecurityProfile

代理池的安全设置。

名称	类型	说明
enableSecureBoot	boolean	安全启动是受信任的启动的一项功能，可确保只有已签名的操作系统和驱动程序才能启动。有关详细信息，请参阅 aka.ms/aks/trustedlaunch。如果未指定，则默认值为 false。
enableVTPM	boolean	vTPM 是一项受信任的启动功能，用于为节点上本地保留的密钥和度量配置专用安全保管库。有关详细信息，请参阅 aka.ms/aks/trustedlaunch。如果未指定，则默认值为 false。

AgentPoolType

代理池的类型。

名称	类型	说明
AvailabilitySet	string	强烈建议不要使用此功能。
VirtualMachineScaleSets	string	创建虚拟机规模集支持的代理池。

AgentPoolUpgradeSettings

用于升级代理池的设置

名称	类型	说明
drainTimeoutInMinutes	integer	节点的清空超时在逐出 Pod 时等待的时间量（以分钟为单位），以及每个节点的正常终止时间。此逐出等待时间遵循等待 Pod 中断预算。如果超过此时间，升级将失败。如果未指定，则默认值为 30 分钟。
maxSurge	string	升级期间激增的最大节点数或百分比。这可以设置为整数（例如'5'）或百分比（例如'50%'）。如果指定了百分比，则它是升级时代理池大小总数的百分比。对于百分比，小数节点向上舍入。如果未指定，则默认值为 1。有关详细信息，包括最佳做法，请参阅：https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade
nodeSoakDurationInMinutes	integer	节点的浸泡持续时间清空节点后以及重新映像节点并转到下一个节点之前等待的时间（以分钟为单位）。如果未指定，则默认值为 0 分钟。

AgentPoolWindowsProfile

Windows 代理池的特定配置文件。

名称	类型	说明
disableOutboundNat	boolean	是否在 Windows 节点中禁用出站NAT 默认值为 false。仅当群集 outboundType 为 NAT 网关且 Windows 代理池未启用节点公共 IP 时，才能禁用出站 NAT。

CloudError

容器服务的错误响应。

名称	类型	说明
error	CloudErrorBody	有关错误的详细信息。

CloudErrorBody

容器服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

code

指示群集是正在运行还是已停止

名称	类型	说明
Running	string	群集正在运行。
Stopped	string	群集已停止。

CreationData

从源资源创建目标资源时使用的数据。

名称	类型	说明
sourceResourceId	string	这是用于创建目标对象的源对象的 ARM ID。

GPUInstanceProfile

用于为支持的 GPU VM SKU 指定 GPU MIG 实例配置文件的 GPUInstanceProfile。

名称	类型	说明
MIG1g	string
MIG2g	string
MIG3g	string
MIG4g	string
MIG7g	string

IPTag

包含与对象关联的 IPTag。

名称	类型	说明
ipTagType	string	IP 标记类型。示例：RoutingPreference。
tag	string	与公共 IP 关联的 IP 标记的值。示例：Internet。

KubeletConfig

代理节点的 Kubelet 配置。

名称	类型	说明
allowedUnsafeSysctls	string[]	允许的不安全 sysctls 或不安全的 sysctl 模式列表（以 `*`结尾）。
containerLogMaxFiles	integer	容器日志文件的最大数目。该数字必须≥ 2。
containerLogMaxSizeMB	integer	在轮换容器日志文件之前，容器日志文件的最大大小（例如 10Mi）。
cpuCfsQuota	boolean	如果为指定 CPU 限制的容器启用了 CPU CFS 配额强制实施。默认值为 true。
cpuCfsQuotaPeriod	string	CPU CFS 配额周期值。默认值为“100ms”。有效值是包含可选分数和单位后缀的小数序列。例如：“300ms”、“2h45m”。支持的单位为“ns”、“us”、“ms”、“s”、“m”和“h”。
cpuManagerPolicy	string	要使用的 CPU 管理器策略。默认值为“none”。有关详细信息，请参阅 Kubernetes CPU 管理策略。允许的值为“none”和“static”。
failSwapOn	boolean	如果设置为 true，则如果在节点上启用了交换，则 Kubelet 将无法启动。
imageGcHighThreshold	integer	磁盘使用率的百分比，之后映像垃圾回收始终运行。若要禁用映像垃圾回收，请设置为 100。默认值为 85%
imageGcLowThreshold	integer	从不运行映像垃圾回收之前磁盘使用量的百分比。这不能设置为高于 imageGcHighThreshold。默认值为 80%
podMaxPids	integer	每个 Pod 的最大进程数。
topologyManagerPolicy	string	要使用的拓扑管理器策略。有关详细信息，请参阅 Kubernetes 拓扑管理器。默认值为“none”。允许的值为“none”、“best-effort”、“restricted”和“single-numa-node”。

KubeletDiskType

确定 emptyDir 卷、容器运行时数据根目录和 Kubelet 临时存储的位置。

名称	类型	说明
OS	string	Kubelet 将对其数据使用 OS 磁盘。
Temporary	string	Kubelet 会将临时磁盘用于其数据。

LinuxOSConfig

Linux 代理节点的 OS 配置。

名称	类型	说明
swapFileSizeMB	integer	将在每个节点上创建的交换文件的大小（以 MB 为单位）。
sysctls	SysctlConfig	Linux 代理节点的 Sysctl 设置。
transparentHugePageDefrag	string	内核是否应积极利用内存压缩，使更多的大页可用。有效值为“always”、“defer”、“defer+madvise”、“madvise”和“never”。默认值为“madvise”。有关详细信息，请参阅透明巨页。
transparentHugePageEnabled	string	是否启用透明巨页。有效值为“always”、“madvise”和“never”。默认值为“always”。有关详细信息，请参阅透明巨页。

OSDiskType

要用于代理池中的计算机的 OS 磁盘类型。

名称	类型	说明
Ephemeral	string	临时 OS 磁盘仅存储在主机上，就像临时磁盘一样。这样可以降低读取/写入延迟，以及更快的节点缩放和群集升级。
Managed	string	如果 VM 需要重新定位到另一台主机，Azure 会将虚拟机的操作系统磁盘复制到 Azure 存储，以避免数据丢失。由于容器未设计为保留本地状态，因此此行为提供有限的值，同时提供一些缺点，包括节点预配速度较慢以及读取/写入延迟较高。

OSSKU

指定代理池使用的 OS SKU。如果 OSType 为 Linux，则默认值为 Ubuntu。当 Kubernetes <= 1.24 或 Windows2022 时，Kubernetes >= 1.25（如果 OSType 为 Windows）时，默认值为 Windows2019。

名称	类型	说明
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。

名称	类型	说明
Linux	string	使用 Linux。
Windows	string	使用 Windows。

PortRange

端口范围。

名称	类型	说明
portEnd	integer	范围中包含的最大端口。它的范围应从 1 到 65535，并且大于或等于 portStart。
portStart	integer	范围中包含的最小端口。它的范围应从 1 到 65535，并且小于或等于 portEnd。
protocol	Protocol	端口的网络协议。

PowerState

描述群集的电源状态

名称	类型	说明
code	code	指示群集是正在运行还是已停止

Protocol

端口的网络协议。

名称	类型	说明
TCP	string	TCP 协议。
UDP	string	UDP 协议。

ScaleDownMode

介绍如何在代理池中添加或删除 VM。请参阅计费状态。

名称	类型	说明
Deallocate	string	尝试在纵向扩展期间启动已解除分配的实例（如果存在），并在纵向缩减期间解除分配实例。
Delete	string	在纵向扩展期间创建新实例，并在纵向缩减期间删除实例。

ScaleSetEvictionPolicy

虚拟机规模集逐出策略。

名称	类型	说明
Deallocate	string	节点池的基础规模集中的节点在逐出时设置为已停止解除分配的状态。针对计算配额的已停止解除分配状态计数中的节点，并可能导致群集缩放或升级出现问题。
Delete	string	在逐出节点池的基础规模集中的节点时，将删除这些节点。

ScaleSetPriority

虚拟机规模集优先级。

名称	类型	说明
Regular	string	将使用常规 VM。
Spot	string	将使用现成优先级 VM。没有现成节点的 SLA。有关详细信息，请参阅 AKS 上的位置。

SysctlConfig

Linux 代理节点的 Sysctl 设置。

名称	类型	说明
fsAioMaxNr	integer	Sysctl setting fs.aio-max-nr.
fsFileMax	integer	Sysctl setting 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 setting 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

确定节点可以运行的工作负荷的类型。

名称	类型	说明
OCIContainer	string	节点将使用 Kubelet 运行标准 OCI 容器工作负荷。
WasmWasi	string	节点将使用 Krustlet 通过 WASI 提供程序运行 WASM 工作负荷（预览版）。

通过

Agent Pools - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

Get Agent Pool

示例请求

示例响应

定义

AgentPool

AgentPoolMode

AgentPoolNetworkProfile

AgentPoolSecurityProfile

AgentPoolType

AgentPoolUpgradeSettings

AgentPoolWindowsProfile

CloudError

CloudErrorBody

code

CreationData

GPUInstanceProfile

IPTag

KubeletConfig

KubeletDiskType

LinuxOSConfig

OSDiskType

OSSKU

OSType

PortRange

PowerState

Protocol

ScaleDownMode

ScaleSetEvictionPolicy

ScaleSetPriority

SysctlConfig

WorkloadRuntime

其他资源