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

Agent Pools - Create Or Update

在指定的托管群集中创建或更新代理池。

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

URI 参数

Name In Required Type Description
agentPoolName
path True
  • string

代理池的名称。

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

resourceName
path True
  • string

托管群集资源的名称。

Regex pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Type Description
properties.availabilityZones
  • string[]

要用于节点的可用性区域列表。 仅当 AgentPoolType 属性为“VirtualMachineScaleSets”时,才能指定此值。

properties.count
  • integer

) 托管 docker 容器的 VM (代理数。 允许的值必须在用户池的 0 到 1000 (非独占) 范围内,并且对于系统池的 1 到 1000 (范围(包括非独占) )。 默认值为 1。

properties.creationData

如果节点池将使用快照创建/升级,则用于指定源快照 ID 的 CreationData。

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

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

properties.kubeletConfig

代理节点的 Kubelet 配置。
代理池节点上的 Kubelet 配置。

properties.kubeletDiskType

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

properties.linuxOSConfig

Linux 代理节点的 OS 配置。
Linux 代理节点的 OS 配置。

properties.maxCount
  • integer

自动缩放的最大节点数

properties.maxPods
  • integer

可在节点上运行的最大 Pod 数。

properties.minCount
  • integer

自动缩放的最小节点数

properties.mode

代理池的模式。
群集必须随时至少有一个“系统”代理池。 有关代理池限制和最佳做法的其他信息,请参阅: https://docs.microsoft.com/azure/aks/use-system-pools

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

要用于代理池中的计算机的 OS 磁盘类型。
如果 VM 支持它并且缓存磁盘大于请求的 OSDiskSizeGB,则默认值为“临时”。 否则,默认为“托管”。 创建后可能不会更改。 有关详细信息,请参阅 临时 OS

properties.osSKU

指定 OS SKU。 如果 OSType Windows,则不能指定此值。

properties.osType

操作系统类型。 默认值为 Linux。

properties.podSubnetID
  • string

启动时 Pod 将加入的子网的 ID。
如果省略,则会在节点子网上静态分配 Pod IP, (请参阅 vnetSubnetID,了解更多详细信息) 。 此格式为:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

properties.powerState

代理池是正在运行还是停止。
首次创建代理池时,它最初正在运行。 可以通过将此字段设置为“已停止”来停止代理池。 已停止的代理池会停止其所有 VM,并且不会产生计费费用。 仅当代理池正在运行且预配状态为“成功”时,才能停止代理池

properties.proximityPlacementGroupID
  • string

邻近放置组的 ID。

properties.scaleDownMode

缩放代理池时要使用的缩减模式。
这也会影响群集自动缩放程序行为。 如果未指定,则默认为“删除”。

properties.scaleSetEvictionPolicy

要使用的虚拟机规模集逐出策略。
除非 scaleSetPriority 为“Spot”,否则无法指定此值。 如果未指定,则默认值为“Delete”。

properties.scaleSetPriority

虚拟机规模集优先级。 如果未指定,则默认值为“Regular”。

properties.spotMaxPrice
  • number

) 你愿意为现成实例付费的最大价格 (美元。 可能的值是大于零或 -1 的任何十进制值,指示默认价格是按需价格。
可能的值是大于零或 -1 的任何十进制值,表示愿意支付任何按需价格。 有关现成定价的更多详细信息,请参阅 现成 VM 定价

properties.tags
  • object

要保留在代理池虚拟机规模集上的标记。

properties.type

代理池的类型。

properties.upgradeSettings

用于升级 Agentpool 的设置

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.workloadRuntime

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

响应

Name Type Description
200 OK

OK

201 Created

创建

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Create Agent Pool using an agent pool snapshot
Create Agent Pool with EncryptionAtHost enabled
Create Agent Pool with Ephemeral OS Disk
Create Agent Pool with FIPS enabled OS
Create Agent Pool with GPUMIG
Create Agent Pool with Krustlet and the WASI runtime
Create Agent Pool with KubeletConfig and LinuxOSConfig
Create Agent Pool with OSSKU
Create Agent Pool with PPG
Create Agent Pool with UltraSSD enabled
Create Spot Agent Pool
Create/Update Agent Pool
Start Agent Pool
Stop Agent Pool
Update Agent Pool

Create Agent Pool using an agent pool snapshot

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

Create Agent Pool with EncryptionAtHost enabled

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

Create Agent Pool with Ephemeral OS Disk

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "osDiskSizeGB": 64
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "osDiskSizeGB": 64
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "kubeletDiskType": "OS",
    "osDiskSizeGB": 64
  }
}

Create Agent Pool with FIPS enabled OS

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableFIPS": true
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true
  }
}

Create Agent Pool with GPUMIG

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "maxPods": 110,
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "maxPods": 110,
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with Krustlet and the WASI runtime

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

Create Agent Pool with KubeletConfig and LinuxOSConfig

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with OSSKU

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osSKU": "CBLMariner",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osSKU": "CBLMariner",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osSKU": "CBLMariner",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with PPG

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

Create Agent Pool with UltraSSD enabled

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableUltraSSD": true
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

Create Spot Agent Pool

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "spotMaxPrice": -1
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "spotMaxPrice": -1
  }
}

Create/Update Agent Pool

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User"
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User",
    "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User"
  }
}

Start Agent Pool

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "powerState": {
      "code": "Running"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Starting",
    "count": 50,
    "enableAutoScaling": true,
    "minCount": 3,
    "maxCount": 55,
    "powerState": {
      "code": "Running"
    }
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Starting",
    "count": 50,
    "enableAutoScaling": true,
    "minCount": 3,
    "maxCount": 55,
    "powerState": {
      "code": "Running"
    }
  }
}

Stop Agent Pool

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "powerState": {
      "code": "Stopped"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Stopping",
    "count": 0,
    "enableAutoScaling": false,
    "minCount": null,
    "maxCount": null,
    "powerState": {
      "code": "Stopped"
    }
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Stopping",
    "count": 0,
    "enableAutoScaling": false,
    "minCount": null,
    "maxCount": null,
    "powerState": {
      "code": "Stopped"
    }
  }
}

Update Agent Pool

Sample Request

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2022-04-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

Sample Response

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}
{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Updating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

定义

AgentPool

代理池。

AgentPoolMode

代理池的模式。

AgentPoolType

代理池的类型。

AgentPoolUpgradeSettings

用于升级代理池的设置

CloudError

来自容器服务的错误响应。

CloudErrorBody

来自容器服务的错误响应。

code

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

CreationData

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

GPUInstanceProfile

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

KubeletConfig

代理节点的 Kubelet 配置。

KubeletDiskType

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

LinuxOSConfig

Linux 代理节点的 OS 配置。

OSDiskType

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

OSSKU

指定 OS SKU。 如果 OSType Windows,则不能指定此值。

OSType

操作系统类型。 默认值为 Linux。

PowerState

描述群集的电源状态

ScaleDownMode

描述如何将 VM 添加到代理池或从代理池中删除。 请参阅 计费状态

ScaleSetEvictionPolicy

虚拟机规模集逐出策略。

ScaleSetPriority

虚拟机规模集优先级。

SysctlConfig

Linux 代理节点的 Sysctl 设置。

WorkloadRuntime

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

AgentPool

代理池。

Name Type Default Value Description
id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.availabilityZones
  • string[]

要用于节点的可用性区域列表。 仅当 AgentPoolType 属性为“VirtualMachineScaleSets”时,才能指定此值。

properties.count
  • integer

) 托管 docker 容器的 VM (代理数。 允许的值必须在用户池的 0 到 1000 (非独占) 范围内,并且对于系统池的 1 到 1000 (范围(包括非独占) )。 默认值为 1。

properties.creationData

如果节点池将使用快照创建/升级,则用于指定源快照 ID 的 CreationData。

properties.currentOrchestratorVersion
  • string

代理池运行的 Kubernetes 版本。
如果 orchestratorVersion 是完全指定的 major.minor.patch> 版本<,则此字段将完全等于它。 如果 orchestratorVersion 为 <major.minor>,则此字段将包含正在使用的完整 <major.minor.patch> 版本。

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

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

properties.kubeletConfig

代理节点的 Kubelet 配置。
代理池节点上的 Kubelet 配置。

properties.kubeletDiskType

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

properties.linuxOSConfig

Linux 代理节点的 OS 配置。
Linux 代理节点的 OS 配置。

properties.maxCount
  • integer

自动缩放的最大节点数

properties.maxPods
  • integer

可在节点上运行的最大 Pod 数。

properties.minCount
  • integer

自动缩放的最小节点数

properties.mode

代理池的模式。
群集必须随时至少有一个“系统”代理池。 有关代理池限制和最佳做法的其他信息,请参阅: https://docs.microsoft.com/azure/aks/use-system-pools

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

要用于代理池中的计算机的 OS 磁盘类型。
如果 VM 支持它并且缓存磁盘大于请求的 OSDiskSizeGB,则默认值为“临时”。 否则,默认为“托管”。 创建后可能不会更改。 有关详细信息,请参阅 临时 OS

properties.osSKU

指定 OS SKU。 如果 OSType Windows,则不能指定此值。

properties.osType Linux

操作系统类型。 默认值为 Linux。

properties.podSubnetID
  • string

启动时 Pod 将加入的子网的 ID。
如果省略,则会在节点子网上静态分配 Pod IP, (请参阅 vnetSubnetID,了解更多详细信息) 。 此格式为:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

properties.powerState

代理池是正在运行还是停止。
首次创建代理池时,它最初正在运行。 可以通过将此字段设置为“已停止”来停止代理池。 已停止的代理池会停止其所有 VM,并且不会产生计费费用。 仅当代理池正在运行且预配状态为“成功”时,才能停止代理池

properties.provisioningState
  • string

当前部署或预配状态。

properties.proximityPlacementGroupID
  • string

邻近放置组的 ID。

properties.scaleDownMode

缩放代理池时要使用的缩减模式。
这也会影响群集自动缩放程序行为。 如果未指定,则默认为“删除”。

properties.scaleSetEvictionPolicy Delete

要使用的虚拟机规模集逐出策略。
除非 scaleSetPriority 为“Spot”,否则无法指定此值。 如果未指定,则默认值为“Delete”。

properties.scaleSetPriority Regular

虚拟机规模集优先级。 如果未指定,则默认值为“Regular”。

properties.spotMaxPrice
  • number
-1

) 你愿意为现成实例付费的最大价格 (美元。 可能的值是大于零或 -1 的任何十进制值,指示默认价格是按需价格。
可能的值是大于零或 -1 的任何十进制值,表示愿意支付任何按需价格。 有关现成定价的更多详细信息,请参阅 现成 VM 定价

properties.tags
  • object

要保留在代理池虚拟机规模集上的标记。

properties.type

代理池的类型。

properties.upgradeSettings

用于升级 Agentpool 的设置

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.workloadRuntime

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

type
  • string

资源类型

AgentPoolMode

代理池的模式。

Name Type Description
System
  • string

系统代理池主要用于托管关键系统 Pod,例如 CoreDNS 和 metrics-server。 系统代理池 osType 必须是 Linux。 系统代理池 VM SKU 必须至少有 2vCPU 和 4GB 内存。

User
  • string

用户代理池主要用于托管应用程序 Pod。

AgentPoolType

代理池的类型。

Name Type Description
AvailabilitySet
  • string

强烈建议不要使用此功能。

VirtualMachineScaleSets
  • string

创建虚拟机规模集支持的代理池。

AgentPoolUpgradeSettings

用于升级代理池的设置

Name Type Description
maxSurge
  • string

升级期间激增的最大节点数或百分比。
这可以设置为整数 (,例如“5”) 或百分比 (,例如'50%') 。 如果指定了百分比,则它是升级时代理池大小总数的百分比。 对于百分比,小数节点向上舍入。 如果未指定,则默认值为 1。 有关详细信息,包括最佳做法,请参阅: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

CloudError

来自容器服务的错误响应。

Name Type Description
error

有关错误的详细信息。

CloudErrorBody

来自容器服务的错误响应。

Name Type Description
code
  • string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

有关错误的其他详细信息的列表。

message
  • string

描述错误的消息,旨在适合在用户界面中显示。

target
  • string

特定错误的目标。 例如,错误属性的名称。

code

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

Name Type Description
Running
  • string

群集正在运行。

Stopped
  • string

群集已停止。

CreationData

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

Name Type Description
sourceResourceId
  • string

这是用于创建目标对象的源对象的 ARM ID。

GPUInstanceProfile

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

Name Type Description
MIG1g
  • string
MIG2g
  • string
MIG3g
  • string
MIG4g
  • string
MIG7g
  • string

KubeletConfig

代理节点的 Kubelet 配置。

Name Type Description
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 临时存储的位置。

Name Type Description
OS
  • string

Kubelet 将对其数据使用 OS 磁盘。

Temporary
  • string

Kubelet 将对其数据使用临时磁盘。

LinuxOSConfig

Linux 代理节点的 OS 配置。

Name Type Description
swapFileSizeMB
  • integer

将在每个节点上创建的交换文件的大小(以 MB 为单位)。

sysctls

Linux 代理节点的 Sysctl 设置。

transparentHugePageDefrag
  • string

内核是否应积极利用内存压缩,使更多的大页可用。
有效值为“always”、“defer”、“defer+madvise”、“madvise”和“never”。 默认值为“madvise”。 有关详细信息,请参阅 透明巨页

transparentHugePageEnabled
  • string

是否启用透明巨页。
有效值为“always”、“madvise”和“never”。 默认值为“always”。 有关详细信息,请参阅 透明巨页

OSDiskType

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

Name Type Description
Ephemeral
  • string

临时 OS 磁盘仅存储在主机上,就像临时磁盘一样。 这样的读/写延迟较低,且节点缩放和群集升级速度较快。

Managed
  • string

如果 VM 需要重新定位到另一台主机,Azure 会将虚拟机的操作系统磁盘复制到 Azure 存储,以避免数据丢失。 由于容器不设计为保留本地状态,因此此行为提供有限的值,同时提供一些缺点,包括节点预配速度较慢和读取/写入延迟较高。

OSSKU

指定 OS SKU。 如果 OSType Windows,则不能指定此值。

Name Type Description
CBLMariner
  • string
Ubuntu
  • string

OSType

操作系统类型。 默认值为 Linux。

Name Type Description
Linux
  • string

使用 Linux。

Windows
  • string

使用Windows。

PowerState

描述群集的电源状态

Name Type Description
code

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

ScaleDownMode

描述如何将 VM 添加到代理池或从代理池中删除。 请参阅 计费状态

Name Type Description
Deallocate
  • string

如果实例在纵向扩展期间存在) ,并在纵向缩减期间解除分配实例,则尝试启动已解除分配的实例 (。

Delete
  • string

在纵向扩展期间创建新实例,并在纵向缩减期间删除实例。

ScaleSetEvictionPolicy

虚拟机规模集逐出策略。

Name Type Description
Deallocate
  • string

节点池的基础规模集中的节点在逐出时设置为已停止解除分配的状态。 处于 stopped-deallocated 状态的节点会根据计算配额进行计数,可能会导致群集缩放或升级问题。

Delete
  • string

在逐出节点池的基础规模集中的节点时,将删除这些节点。

ScaleSetPriority

虚拟机规模集优先级。

Name Type Description
Regular
  • string

将使用常规 VM。

Spot
  • string

将使用现成优先级 VM。 现成节点没有 SLA。 有关详细信息 ,请参阅 AKS 上的现成位置

SysctlConfig

Linux 代理节点的 Sysctl 设置。

Name Type Description
fsAioMaxNr
  • integer

Sysctl setting 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 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

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

Name Type Description
OCIContainer
  • string

节点将使用 Kubelet 运行标准 OCI 容器工作负荷。

WasmWasi
  • string

节点将使用 Krustlet 通过 WASI 提供程序 (预览版) 运行 WASM 工作负荷。