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

Managed Clusters - Get

获取托管群集。

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

URI 参数

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

ManagedCluster

还行

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Get Managed Cluster

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1?api-version=2024-09-01

示例响应

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
  "location": "location1",
  "name": "clustername1",
  "tags": {
    "archv2": "",
    "tier": "production"
  },
  "type": "Microsoft.ContainerService/ManagedClusters",
  "eTag": "beywbwei",
  "properties": {
    "provisioningState": "Succeeded",
    "maxAgentPools": 1,
    "kubernetesVersion": "1.9.6",
    "currentKubernetesVersion": "1.9.6",
    "dnsPrefix": "dnsprefix1",
    "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
    "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io",
    "agentPoolProfiles": [
      {
        "name": "nodepool1",
        "count": 3,
        "vmSize": "Standard_DS1_v2",
        "maxPods": 110,
        "osType": "Linux",
        "eTag": "nvewbvoi",
        "provisioningState": "Succeeded",
        "orchestratorVersion": "1.9.6",
        "currentOrchestratorVersion": "1.9.6",
        "availabilityZones": [
          "1",
          "2",
          "3"
        ],
        "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
        "upgradeSettings": {
          "maxSurge": "33%"
        }
      }
    ],
    "linuxProfile": {
      "adminUsername": "azureuser",
      "ssh": {
        "publicKeys": [
          {
            "keyData": "keydata"
          }
        ]
      }
    },
    "servicePrincipalProfile": {
      "clientId": "clientid"
    },
    "nodeResourceGroup": "MC_rg1_clustername1_location1",
    "enableRBAC": false,
    "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
    "networkProfile": {
      "networkPlugin": "kubenet",
      "podCidr": "10.244.0.0/16",
      "serviceCidr": "10.0.0.0/16",
      "dnsServiceIP": "10.0.0.10",
      "loadBalancerSku": "standard",
      "outboundType": "loadBalancer",
      "podCidrs": [
        "10.244.0.0/16"
      ],
      "serviceCidrs": [
        "10.0.0.0/16"
      ],
      "ipFamilies": [
        "IPv4"
      ],
      "loadBalancerProfile": {
        "allocatedOutboundPorts": 2000,
        "idleTimeoutInMinutes": 10,
        "outboundIPs": {
          "publicIPs": [
            {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1"
            },
            {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2"
            }
          ]
        },
        "effectiveOutboundIPs": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
          }
        ]
      }
    },
    "upgradeSettings": {
      "overrideSettings": {
        "forceUpgrade": true,
        "until": "2022-11-01T13:00:00Z"
      }
    }
  }
}

定义

名称 说明
AdvancedNetworking

用于在群集上启用可观测性和安全功能套件的高级网络配置文件。 有关详细信息,请参阅 aka.ms/aksadvancednetworking。

AdvancedNetworkingObservability

可观测性配置文件,用于启用具有历史上下文的高级网络指标和流日志。

AdvancedNetworkingSecurity

用于在基于 cilium 的群集上启用安全功能的安全配置文件。

AgentPoolMode

代理池的模式。

AgentPoolNetworkProfile

代理池的网络设置。

AgentPoolSecurityProfile

代理池的安全设置。

AgentPoolType

代理池的类型。

AgentPoolUpgradeSettings

用于升级代理池的设置

AgentPoolWindowsProfile

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

AutoScalerProfile

启用时要应用于群集自动缩放程序的参数

AzureKeyVaultKms

安全配置文件的 Azure Key Vault 密钥管理服务设置。

BackendPoolType

托管入站负载均衡器 BackendPool 的类型。

CloudError

容器服务的错误响应。

CloudErrorBody

容器服务的错误响应。

ClusterUpgradeSettings

用于升级群集的设置。

code

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

ContainerServiceLinuxProfile

容器服务群集中 Linux VM 的配置文件。

ContainerServiceNetworkProfile

网络配置的配置文件。

ContainerServiceSshConfiguration

在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置。

ContainerServiceSshPublicKey

包含有关 SSH 证书公钥数据的信息。

createdByType

创建资源的标识的类型。

CreationData

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

DelegatedResource

委派的资源属性 - 仅供内部使用。

expander

纵向扩展时要使用的扩展器

ExtendedLocation

扩展位置的复杂类型。

ExtendedLocationTypes

扩展位置的类型。

GPUInstanceProfile

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

Identity

资源的标识。

ipFamily

用于指定群集可用的 IP 版本的 IP 系列。

IPTag

包含与对象关联的 IPTag。

IstioCertificateAuthority

Istio 服务网格证书颁发机构 (CA) 配置。 目前,我们仅支持插件证书,如此处 https://aka.ms/asm-plugin-ca

IstioComponents

Istio 组件配置。

IstioEgressGateway

Istio 出口网关配置。

IstioIngressGateway

Istio 入口网关配置。 目前,我们最多支持一个名为 aks-istio-ingressgateway-external 的外部入口网关和一个名为 aks-istio-ingressgateway-internal的内部入口网关。

IstioIngressGatewayMode

入口网关的模式。

IstioPluginCertificateAuthority

服务网格的插件证书信息。

IstioServiceMesh

Istio 服务网格配置。

KeyVaultNetworkAccessTypes

密钥保管库的网络访问

KubeletConfig

代理节点的 Kubelet 配置。

KubeletDiskType

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

KubernetesSupportPlan

AKS 托管群集的不同支持层

licenseType

用于 Windows VM 的许可证类型。 有关更多详细信息,请参阅 Azure 混合用户权益

LinuxOSConfig

Linux 代理节点的 OS 配置。

loadBalancerSku

托管群集的负载均衡器 SKU。

ManagedCluster

托管群集。

ManagedClusterAADProfile

AADProfile 指定 Azure Active Directory 集成的属性。

ManagedClusterAddonProfile

托管群集的 Kubernetes 加载项配置文件。

ManagedClusterAgentPoolProfile

容器服务代理池的配置文件。

ManagedClusterAPIServerAccessProfile

托管群集 API 服务器的访问配置文件。

ManagedClusterAutoUpgradeProfile

托管群集的自动升级配置文件。

ManagedClusterAzureMonitorProfile

用于监视托管群集的 Azure Monitor 加载项配置文件。

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure 托管 Prometheus 加载项的 Kube 状态指标配置文件。 这些可选设置适用于使用加载项部署的 kube-state-metrics Pod。 有关详细信息,请参阅 aka.ms/AzureManagedPrometheus-optional-parameters。

ManagedClusterAzureMonitorProfileMetrics

适用于 Prometheus 加载项的 Azure Monitor 托管服务的指标配置文件。 收集现装的 Kubernetes 基础结构指标,以发送到 Azure Monitor 工作区,并为自定义目标配置额外的擦除。 有关概述,请参阅 aka.ms/AzureManagedPrometheus。

ManagedClusterCostAnalysis

群集的成本分析配置

ManagedClusterHTTPProxyConfig

群集 HTTP 代理配置。

ManagedClusterIdentity

托管群集的标识。

ManagedClusterIngressProfile

容器服务群集的入口配置文件。

ManagedClusterIngressProfileWebAppRouting

入口配置文件的应用程序路由加载项设置。

ManagedClusterLoadBalancerProfile

托管群集负载均衡器的配置文件。

ManagedClusterManagedOutboundIPProfile

托管群集的托管出站 IP 资源的配置文件。

ManagedClusterMetricsProfile

ManagedCluster 的指标配置文件。

ManagedClusterNATGatewayProfile

托管群集 NAT 网关的配置文件。

ManagedClusterNodeResourceGroupProfile

托管群集的节点资源组锁定配置文件。

ManagedClusterOIDCIssuerProfile

托管群集的 OIDC 颁发者配置文件。

ManagedClusterPodIdentity

有关分配给托管群集的 Pod 标识的详细信息。

ManagedClusterPodIdentityException

Pod 标识异常,允许具有某些标签的 Pod 访问 Azure 实例元数据服务(IMDS)终结点,而不会被节点托管标识(NMI)服务器截获。

ManagedClusterPodIdentityProfile

托管群集的 Pod 标识配置文件。

ManagedClusterPodIdentityProvisioningError

Pod 标识预配的错误响应。

ManagedClusterPodIdentityProvisioningErrorBody

Pod 标识预配的错误响应。

ManagedClusterPodIdentityProvisioningState

Pod 标识的当前预配状态。

ManagedClusterSecurityProfile

容器服务群集的安全配置文件。

ManagedClusterSecurityProfileDefender

Microsoft安全配置文件的 Defender 设置。

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft安全配置文件威胁检测的 Defender 设置。

ManagedClusterSecurityProfileImageCleaner

映像清理器从节点中删除未使用的映像,释放磁盘空间并帮助减少攻击外围应用。 下面是安全配置文件的设置。

ManagedClusterSecurityProfileWorkloadIdentity

安全配置文件的工作负荷标识设置。

ManagedClusterServicePrincipalProfile

有关群集用于操作 Azure API 的服务主体标识的信息。

ManagedClusterSKU

托管群集的 SKU。

ManagedClusterSKUName

托管群集 SKU 的名称。

ManagedClusterSKUTier

托管群集 SKU 的层。

ManagedClusterStorageProfile

容器服务群集的存储配置文件。

ManagedClusterStorageProfileBlobCSIDriver

存储配置文件的 AzureBlob CSI 驱动程序设置。

ManagedClusterStorageProfileDiskCSIDriver

存储配置文件的 AzureDisk CSI 驱动程序设置。

ManagedClusterStorageProfileFileCSIDriver

存储配置文件的 AzureFile CSI 驱动程序设置。

ManagedClusterStorageProfileSnapshotController

存储配置文件的快照控制器设置。

ManagedClusterWindowsProfile

托管群集中 Windows VM 的配置文件。

ManagedClusterWorkloadAutoScalerProfile

托管群集的工作负荷自动缩放程序配置文件。

ManagedClusterWorkloadAutoScalerProfileKeda

KEDA(Kubernetes 事件驱动的自动缩放)设置,用于工作负荷自动缩放程序配置文件。

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

工作负荷自动缩放程序配置文件的 VPA(垂直 Pod 自动缩放程序)设置。

ManagedOutboundIPs

群集负载均衡器的所需托管出站 IP。

networkDataplane

Kubernetes 群集中使用的网络数据平面。

networkMode

配置了 Azure CNI 的网络模式。

NetworkPlugin

用于生成 Kubernetes 网络的网络插件。

NetworkPluginMode

网络插件应使用的模式。

NetworkPolicy

用于生成 Kubernetes 网络的网络策略。

nodeOSUpgradeChannel

节点 OS 升级通道

OSDiskType

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

OSSKU

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

OSType

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

OutboundIPPrefixes

群集负载均衡器的所需出站 IP 前缀资源。

OutboundIPs

群集负载均衡器的所需出站 IP 资源。

outboundType

出站(出口)路由方法。

PortRange

端口范围。

PowerState

描述群集的电源状态

PrivateLinkResource

专用链接资源

Protocol

端口的网络协议。

ProvisioningInfo
PublicNetworkAccess

managedCluster 的 PublicNetworkAccess

ResourceIdentityType

用于托管群集的标识类型。

ResourceReference

对 Azure 资源的引用。

RestrictionLevel

应用于群集节点资源组的限制级别。 如果未指定,则默认值为“未限制”

ScaleDownMode

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

ScaleSetEvictionPolicy

虚拟机规模集逐出策略。

ScaleSetPriority

虚拟机规模集优先级。

ServiceMeshMode

服务网格的模式。

ServiceMeshProfile

托管群集的服务网格配置文件。

SysctlConfig

Linux 代理节点的 Sysctl 设置。

systemData

与创建和上次修改资源相关的元数据。

upgradeChannel

用于自动升级的升级通道。 默认值为“none”。

UpgradeOverrideSettings

升级群集时替代的设置。

UserAssignedIdentities

与托管群集关联的用户标识。 此标识将用于控制平面。 仅允许一个用户分配的标识。

UserAssignedIdentity

有关用户分配标识的详细信息。

WindowsGmsaProfile

托管群集中的 Windows gMSA 配置文件。

WorkloadRuntime

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

AdvancedNetworking

用于在群集上启用可观测性和安全功能套件的高级网络配置文件。 有关详细信息,请参阅 aka.ms/aksadvancednetworking。

名称 类型 说明
enabled

boolean

指示在 AKS 群集上启用可观测性和安全性的高级网络功能。 如果设置为 true,除非显式禁用,否则所有可观测性和安全功能都将设置为启用。 如果未指定,则默认值为 false。

observability

AdvancedNetworkingObservability

可观测性配置文件,用于启用具有历史上下文的高级网络指标和流日志。

security

AdvancedNetworkingSecurity

用于在基于 cilium 的群集上启用安全功能的安全配置文件。

AdvancedNetworkingObservability

可观测性配置文件,用于启用具有历史上下文的高级网络指标和流日志。

名称 类型 说明
enabled

boolean

指示在群集上启用高级网络可观测性功能。

AdvancedNetworkingSecurity

用于在基于 cilium 的群集上启用安全功能的安全配置文件。

名称 类型 说明
enabled

boolean

此功能允许用户基于 DNS(FQDN)名称配置网络策略。 只能在基于 cilium 的群集上启用它。 如果未指定,则默认值为 false。

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。

AutoScalerProfile

启用时要应用于群集自动缩放程序的参数

名称 类型 说明
balance-similar-node-groups

string

检测类似的节点池,并平衡它们之间的节点数。
有效值为“true”和“false”

daemonset-eviction-for-empty-nodes

boolean

DaemonSet Pod 将从空节点正常终止
如果设置为 true,则会在删除节点之前逐出空节点上的所有守护程序集 Pod。 如果无法逐出守护程序集 Pod,则会选择另一个节点进行缩放。 如果设置为 false,则会删除节点,而无需确保删除或逐出守护程序集 Pod。

daemonset-eviction-for-occupied-nodes

boolean

DaemonSet Pod 将从非空节点正常终止
如果设置为 true,则会在删除节点之前逐出占用节点上的所有守护程序集 Pod。 如果无法逐出守护程序集 Pod,则会选择另一个节点进行缩放。 如果设置为 false,则会删除节点,而无需确保删除或逐出守护程序集 Pod。

expander

expander

纵向扩展时要使用的扩展器
如果未指定,则默认值为“random”。 有关详细信息,请参阅 扩展器

ignore-daemonsets-utilization

boolean

CA 在计算资源利用率以缩减时是否应忽略 DaemonSet Pod
如果设置为 true,则当做出缩减决策时,将考虑守护程序集使用的资源。

max-empty-bulk-delete

string

可以同时删除的最大空节点数。 这必须是正整数。
默认值为 10。

max-graceful-termination-sec

string

群集自动缩放程序在尝试缩减节点时等待 Pod 终止的最大秒数。
默认值为 600。

max-node-provision-time

string

自动缩放程序等待预配节点的最长时间。
默认值为“15m”。 值必须是后跟“m”的整数。 不支持除分钟(m)以外的时间单位。

max-total-unready-percentage

string

群集中未读节点的最大百分比。 超过此百分比后,群集自动缩放程序将停止操作。
默认值为 45。 最大值为 100,最小值为 0。

new-pod-scale-up-delay

string

在某个年龄之前忽略未计划的 Pod。
对于在 kubernetes 计划程序可以计划所有 Pod 之前不希望 CA 执行操作的突发/批处理缩放方案,可以告诉 CA 在某个年龄之前忽略未计划的 Pod。 默认值为“0s”。 值必须是一个整数,后跟一个单位(以秒为单位,“m”表示分钟,“h”表示小时等)。

ok-total-unready-count

string

允许的未读节点数,而不考虑最大总未读百分比。
这必须是整数。 默认值为 3。

scale-down-delay-after-add

string

纵向扩展后,纵向缩减评估的恢复时间
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟(m)以外的时间单位。

scale-down-delay-after-delete

string

缩减评估的节点删除后多长时间才能恢复。
默认值为扫描间隔。 值必须是后跟“m”的整数。 不支持除分钟(m)以外的时间单位。

scale-down-delay-after-failure

string

纵向缩减失败后,纵向缩减评估的恢复时间。
默认值为“3m”。 值必须是后跟“m”的整数。 不支持除分钟(m)以外的时间单位。

scale-down-unneeded-time

string

节点在有资格缩减之前,应该不需要多长时间。
默认值为“10m”。 值必须是后跟“m”的整数。 不支持除分钟(m)以外的时间单位。

scale-down-unready-time

string

在未读节点有资格缩减之前,应不需要多少时间
默认值为“20m”。 值必须是后跟“m”的整数。 不支持除分钟(m)以外的时间单位。

scale-down-utilization-threshold

string

节点利用率级别(定义为请求的资源之和除以容量)后,可以考虑节点进行缩减。
默认值为“0.5”。

scan-interval

string

重新评估群集以纵向扩展或缩减的频率。
默认值为“10”。 值必须是整数秒数。

skip-nodes-with-local-storage

string

如果群集自动缩放程序将跳过删除具有本地存储的 Pod 的节点,例如 EmptyDir 或 HostPath。
默认值为 true。

skip-nodes-with-system-pods

string

如果群集自动缩放程序将跳过从 kube 系统中删除具有 Pod 的节点(DaemonSet 或镜像 Pod 除外)
默认值为 true。

AzureKeyVaultKms

安全配置文件的 Azure Key Vault 密钥管理服务设置。

名称 类型 默认值 说明
enabled

boolean

是否启用 Azure Key Vault 密钥管理服务。 默认值为 false。

keyId

string

Azure Key Vault 密钥的标识符。 有关详细信息,请参阅 密钥标识符格式。 启用 Azure Key Vault 密钥管理服务时,此字段是必需的,并且必须是有效的密钥标识符。 禁用 Azure Key Vault 密钥管理服务时,将字段留空。

keyVaultNetworkAccess

KeyVaultNetworkAccessTypes

Public

密钥保管库的网络访问
密钥保管库的网络访问。 可能的值为 PublicPrivatePublic 意味着 Key Vault 允许从所有网络进行公共访问。 Private 意味着密钥保管库禁用公共访问并启用专用链接。 默认值为 Public

keyVaultResourceId

string

密钥保管库的资源 ID。 当 keyVaultNetworkAccess Private时,此字段是必需的,并且必须是有效的资源 ID。 当 keyVaultNetworkAccess Public时,请将字段留空。

BackendPoolType

托管入站负载均衡器 BackendPool 的类型。

名称 类型 说明
NodeIP

string

托管入站负载均衡器 BackendPool 的类型。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend

NodeIPConfiguration

string

托管入站负载均衡器 BackendPool 的类型。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend

CloudError

容器服务的错误响应。

名称 类型 说明
error

CloudErrorBody

有关错误的详细信息。

CloudErrorBody

容器服务的错误响应。

名称 类型 说明
code

string

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

details

CloudErrorBody[]

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

message

string

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

target

string

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

ClusterUpgradeSettings

用于升级群集的设置。

名称 类型 说明
overrideSettings

UpgradeOverrideSettings

替代的设置。

code

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

名称 类型 说明
Running

string

群集正在运行。

Stopped

string

群集已停止。

ContainerServiceLinuxProfile

容器服务群集中 Linux VM 的配置文件。

名称 类型 说明
adminUsername

string

用于 Linux VM 的管理员用户名。

ssh

ContainerServiceSshConfiguration

在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置。

ContainerServiceNetworkProfile

网络配置的配置文件。

名称 类型 默认值 说明
advancedNetworking

AdvancedNetworking

用于在群集上启用可观测性和安全功能套件的高级网络配置文件。 有关详细信息,请参阅 aka.ms/aksadvancednetworking。

dnsServiceIP

string

10.0.0.10

分配给 Kubernetes DNS 服务的 IP 地址。 它必须位于 serviceCidr 中指定的 Kubernetes 服务地址范围内。

ipFamilies

ipFamily[]

用于指定群集可用的 IP 版本的 IP 系列。
IP 系列用于确定单堆栈或双堆栈群集。 对于单堆栈,预期值为 IPv4。 对于双堆栈,预期值为 IPv4 和 IPv6。

loadBalancerProfile

ManagedClusterLoadBalancerProfile

群集负载均衡器的配置文件。

loadBalancerSku

loadBalancerSku

托管群集的负载均衡器 SKU。
默认值为“standard”。 有关负载均衡器 SKU 之间的差异的详细信息,请参阅 Azure 负载均衡器 SKU

natGatewayProfile

ManagedClusterNATGatewayProfile

群集 NAT 网关的配置文件。

networkDataplane

networkDataplane

Kubernetes 群集中使用的网络数据平面。

networkMode

networkMode

配置了 Azure CNI 的网络模式。
如果 networkPlugin 不是“azure”,则无法指定此项。

networkPlugin

NetworkPlugin

用于生成 Kubernetes 网络的网络插件。

networkPluginMode

NetworkPluginMode

网络插件应使用的模式。

networkPolicy

NetworkPolicy

用于生成 Kubernetes 网络的网络策略。

outboundType

outboundType

loadBalancer

出站(出口)路由方法。
这只能在群集创建时设置,以后无法更改。 有关详细信息,请参阅 出口出站类型

podCidr

string

10.244.0.0/16

使用 kubenet 时分配 Pod IP 的 CIDR 表示法 IP 范围。

podCidrs

string[]

CIDR 表示法 IP 范围,从中分配 Pod IP。
单堆栈网络需要一个 IPv4 CIDR。 对于双堆栈网络,每个 IP 系列(IPv4/IPv6)都有两个CIDR。

serviceCidr

string

10.0.0.0/16

从中分配服务群集 IP 的 CIDR 表示法 IP 范围。 它不得与任何子网 IP 范围重叠。

serviceCidrs

string[]

CIDR 表示法 IP 范围,从中分配服务群集 IP。
单堆栈网络需要一个 IPv4 CIDR。 对于双堆栈网络,每个 IP 系列(IPv4/IPv6)都有两个CIDR。 它们不得与任何子网 IP 范围重叠。

ContainerServiceSshConfiguration

在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置。

名称 类型 说明
publicKeys

ContainerServiceSshPublicKey[]

用于通过基于 Linux 的 VM 进行身份验证的 SSH 公钥列表。 最多可以指定 1 个键。

ContainerServiceSshPublicKey

包含有关 SSH 证书公钥数据的信息。

名称 类型 说明
keyData

string

用于通过 SSH 向 VM 进行身份验证的证书公钥。 证书必须采用 PEM 格式(带或不带标头)。

createdByType

创建资源的标识的类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

CreationData

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

名称 类型 说明
sourceResourceId

string

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

DelegatedResource

委派的资源属性 - 仅供内部使用。

名称 类型 说明
location

string

源资源位置 - 仅供内部使用。

referralResource

string

引荐委派(可选)的委托 ID - 仅供内部使用。

resourceId

string

委派资源的 ARM 资源 ID - 仅供内部使用。

tenantId

string

委托资源的租户 ID - 仅供内部使用。

expander

纵向扩展时要使用的扩展器

名称 类型 说明
least-waste

string

选择在纵向扩展后将具有最少空闲 CPU(如果已绑定、未使用的内存)的节点组。 当你具有不同类的节点(例如,高 CPU 或高内存节点)时,这非常有用,并且仅当存在需要大量这些资源的挂起 Pod 时,才需要扩展这些节点。

most-pods

string

选择能够在纵向扩展时计划最多 Pod 的节点组。 使用 nodeSelector 确保某些 Pod 位于某些节点上时,这非常有用。 请注意,这不会导致自动缩放程序选择更大的节点与较小的节点,因为它可以同时添加多个较小的节点。

priority

string

选择具有用户分配的最高优先级的节点组。 此处的更多详细信息 介绍了配置。

random

string

当不需要节点组以不同的方式缩放时使用。

ExtendedLocation

扩展位置的复杂类型。

名称 类型 说明
name

string

扩展位置的名称。

type

ExtendedLocationTypes

扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

名称 类型 说明
EdgeZone

string

GPUInstanceProfile

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

名称 类型 说明
MIG1g

string

MIG2g

string

MIG3g

string

MIG4g

string

MIG7g

string

Identity

资源的标识。

名称 类型 说明
principalId

string

资源标识的主体 ID。 该值必须是 UUID。

tenantId

string

资源的租户 ID。 该值必须是 UUID。

type

ResourceIdentityType

标识类型。

ipFamily

用于指定群集可用的 IP 版本的 IP 系列。

名称 类型 说明
IPv4

string

IPv6

string

IPTag

包含与对象关联的 IPTag。

名称 类型 说明
ipTagType

string

IP 标记类型。 示例:RoutingPreference。

tag

string

与公共 IP 关联的 IP 标记的值。 示例:Internet。

IstioCertificateAuthority

Istio 服务网格证书颁发机构 (CA) 配置。 目前,我们仅支持插件证书,如此处 https://aka.ms/asm-plugin-ca

名称 类型 说明
plugin

IstioPluginCertificateAuthority

服务网格的插件证书信息。

IstioComponents

Istio 组件配置。

名称 类型 说明
egressGateways

IstioEgressGateway[]

Istio 出口网关。

ingressGateways

IstioIngressGateway[]

Istio 入口网关。

IstioEgressGateway

Istio 出口网关配置。

名称 类型 说明
enabled

boolean

是否启用出口网关。

IstioIngressGateway

Istio 入口网关配置。 目前,我们最多支持一个名为 aks-istio-ingressgateway-external 的外部入口网关和一个名为 aks-istio-ingressgateway-internal的内部入口网关。

名称 类型 说明
enabled

boolean

是否启用入口网关。

mode

IstioIngressGatewayMode

入口网关的模式。

IstioIngressGatewayMode

入口网关的模式。

名称 类型 说明
External

string

入口网关分配有公共 IP 地址,可公开访问。

Internal

string

入口网关分配有内部 IP 地址,不能公开访问。

IstioPluginCertificateAuthority

服务网格的插件证书信息。

名称 类型 说明
certChainObjectName

string

Azure Key Vault 中的证书链对象名称。

certObjectName

string

Azure Key Vault 中的中间证书对象名称。

keyObjectName

string

Azure Key Vault 中的中间证书私钥对象名称。

keyVaultId

string

Key Vault 的资源 ID。

rootCertObjectName

string

Azure Key Vault 中的根证书对象名称。

IstioServiceMesh

Istio 服务网格配置。

名称 类型 说明
certificateAuthority

IstioCertificateAuthority

Istio 服务网格证书颁发机构 (CA) 配置。 目前,我们仅支持插件证书,如此处 https://aka.ms/asm-plugin-ca

components

IstioComponents

Istio 组件配置。

revisions

string[]

Istio 控制平面的修订列表。 升级未进行时,这将保留一个值。 当 Canary 升级正在进行时,这只能保留两个连续值。 有关详细信息,请参阅:https://learn.microsoft.com/en-us/azure/aks/istio-upgrade

KeyVaultNetworkAccessTypes

密钥保管库的网络访问

名称 类型 说明
Private

string

Public

string

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 会将临时磁盘用于其数据。

KubernetesSupportPlan

AKS 托管群集的不同支持层

名称 类型 说明
AKSLongTermSupport

string

对版本的支持已超过 KubernetesOfficial 支持 1 年。 AKS 继续修补 CVE 再 1 年,总共支持 2 年。

KubernetesOfficial

string

对版本的支持与开放源代码 Kubernetes 产品/服务的支持相同。 正式 Kubernetes 开源社区在发布后 1 年支持版本。

licenseType

用于 Windows VM 的许可证类型。 有关更多详细信息,请参阅 Azure 混合用户权益

名称 类型 说明
None

string

不会应用其他许可。

Windows_Server

string

为 Windows VM 启用 Azure 混合用户权益。

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”。 有关详细信息,请参阅 透明巨页

loadBalancerSku

托管群集的负载均衡器 SKU。

名称 类型 说明
basic

string

使用功能有限的基本负载均衡器。

standard

string

使用标准负载均衡器。 这是建议的负载均衡器 SKU。 有关在托管群集中使用负载均衡器的详细信息,请参阅 标准负载均衡器 一文。

ManagedCluster

托管群集。

名称 类型 说明
eTag

string

用于实现乐观并发的唯一只读字符串。 更新资源时,eTag 值将更改。 使用后续请求的 eTag 值指定 if-match 或 if-none-match 标头,以便根据正常的 etag 约定启用乐观并发。

extendedLocation

ExtendedLocation

虚拟机的扩展位置。

id

string

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

identity

ManagedClusterIdentity

托管群集的标识(如果已配置)。

location

string

资源所在的地理位置

name

string

资源的名称

properties.aadProfile

ManagedClusterAADProfile

AADProfile 指定 Azure Active Directory 集成的属性。
Azure Active Directory 配置。

properties.addonProfiles

<string,  ManagedClusterAddonProfile>

托管群集加载项的配置文件。

properties.agentPoolProfiles

ManagedClusterAgentPoolProfile[]

代理池属性。

properties.apiServerAccessProfile

ManagedClusterAPIServerAccessProfile

托管群集 API 服务器的访问配置文件。

properties.autoScalerProfile

AutoScalerProfile

启用时要应用于群集自动缩放程序的参数

properties.autoUpgradeProfile

ManagedClusterAutoUpgradeProfile

自动升级配置。

properties.azureMonitorProfile

ManagedClusterAzureMonitorProfile

用于监视托管群集的 Azure Monitor 加载项配置文件。

properties.azurePortalFQDN

string

Azure 门户用于访问托管群集的特殊 FQDN。 此 FQDN 仅供 Azure 门户使用,不应由其他客户端使用。
Azure 门户要求在某些响应中发送某些跨域资源共享(CORS)标头,Kubernetes APIServer 默认情况下不会处理这些标头。 此特殊的 FQDN 支持 CORS,使 Azure 门户能够正常运行。

properties.currentKubernetesVersion

string

托管群集运行的 Kubernetes 版本。
如果 kubernetesVersion 是一个完全指定的版本 <major.minor.patch>,则此字段将完全等于它。 如果 kubernetesVersion <major.minor>,则此字段将包含正在使用的完整 <major.minor.patch> 版本。

properties.disableLocalAccounts

boolean

如果应在托管群集上禁用本地帐户。
如果设置为 true,将禁用此群集的静态凭据。 这只能在启用了 AAD 的托管群集上使用。 有关详细信息,请参阅 禁用本地帐户

properties.diskEncryptionSetID

string

用于启用静态加密的磁盘加密集的资源 ID。
此格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}”

properties.dnsPrefix

string

托管群集的 DNS 前缀。
创建托管群集后,无法更新此功能。

properties.enablePodSecurityPolicy

boolean

(已弃用)是否启用 Kubernetes Pod 安全策略(预览版)。 Kubernetes v1.21 中弃用 PodSecurityPolicy,并在 v1.25 中从 Kubernetes 中删除。 在 https://aka.ms/k8s/psphttps://aka.ms/aks/psp了解详细信息。

properties.enableRBAC

boolean

是否启用 Kubernetes Role-Based 访问控制。

properties.fqdn

string

主池的 FQDN。

properties.fqdnSubdomain

string

具有自定义专用 DNS 区域的专用群集的 FQDN 子域。
创建托管群集后,无法更新此功能。

properties.httpProxyConfig

ManagedClusterHTTPProxyConfig

使用 HTTP 代理服务器预配群集的配置。

properties.identityProfile

<string,  UserAssignedIdentity>

与托管群集关联的用户标识。 kubelet 将使用此标识。 仅允许一个用户分配的标识。 唯一接受的密钥为“kubeletidentity”,值为“resourceId”:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

properties.ingressProfile

ManagedClusterIngressProfile

托管群集的入口配置文件。

properties.kubernetesVersion

string

用户指定的 Kubernetes 版本。
支持两个修补程序版本 <major.minor.patch>(例如 1.20.13)和 <major.minor>(例如 1.20)。 指定 <major.minor> 时,会自动选择最新的受支持的 GA 修补程序版本。 创建群集后使用相同的 <major.minor>(例如 1.14.x -> 1.14)更新群集不会触发升级,即使更新的修补程序版本可用也是如此。 升级支持的 AKS 群集时,无法跳过 Kubernetes 次要版本。 所有升级都必须按主版本号按顺序执行。 例如,允许在 1.14.x -> 1.15.x 或 1.15.x 之间升级> 1.16.x,但不允许使用 1.14.x -> 1.16.x。 有关更多详细信息,请参阅 升级 AKS 群集

properties.linuxProfile

ContainerServiceLinuxProfile

托管群集中 Linux VM 的配置文件。

properties.maxAgentPools

integer

托管群集的最大代理池数。

properties.metricsProfile

ManagedClusterMetricsProfile

可选群集指标配置。

properties.networkProfile

ContainerServiceNetworkProfile

网络配置文件。

properties.nodeResourceGroup

string

包含代理池节点的资源组的名称。

properties.nodeResourceGroupProfile

ManagedClusterNodeResourceGroupProfile

节点资源组配置的配置文件。

properties.oidcIssuerProfile

ManagedClusterOIDCIssuerProfile

托管群集的 OIDC 颁发者配置文件。

properties.podIdentityProfile

ManagedClusterPodIdentityProfile

托管群集的 Pod 标识配置文件。
有关 AAD Pod 标识集成的详细信息,请参阅 使用 AAD Pod 标识

properties.powerState

PowerState

群集的电源状态。

properties.privateFQDN

string

专用群集的 FQDN。

properties.privateLinkResources

PrivateLinkResource[]

与群集关联的专用链接资源。

properties.provisioningState

string

当前预配状态。

properties.publicNetworkAccess

PublicNetworkAccess

managedCluster 的 PublicNetworkAccess
允许或拒绝 AKS 的公共网络访问

properties.resourceUID

string

resourceUID 唯一标识重复使用 ARM ResourceId 的 ManagedCluster(即:创建、删除、创建序列)

properties.securityProfile

ManagedClusterSecurityProfile

托管群集的安全配置文件。

properties.serviceMeshProfile

ServiceMeshProfile

托管群集的服务网格配置文件。

properties.servicePrincipalProfile

ManagedClusterServicePrincipalProfile

有关群集用于操作 Azure API 的服务主体标识的信息。

properties.storageProfile

ManagedClusterStorageProfile

托管群集的存储配置文件。

properties.supportPlan

KubernetesSupportPlan

托管群集的支持计划。 如果未指定,则默认值为“KubernetesOfficial”。

properties.upgradeSettings

ClusterUpgradeSettings

用于升级群集的设置。

properties.windowsProfile

ManagedClusterWindowsProfile

托管群集中 Windows VM 的配置文件。

properties.workloadAutoScalerProfile

ManagedClusterWorkloadAutoScalerProfile

托管群集的工作负荷自动缩放程序配置文件。

sku

ManagedClusterSKU

托管群集 SKU。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

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

ManagedClusterAADProfile

AADProfile 指定 Azure Active Directory 集成的属性。

名称 类型 说明
adminGroupObjectIDs

string[]

将具有群集管理员角色的 AAD 组对象 ID 的列表。

clientAppID

string

(已弃用)客户端 AAD 应用程序 ID。 在 https://aka.ms/aks/aad-legacy了解详细信息。

enableAzureRBAC

boolean

是否为 Kubernetes 授权启用 Azure RBAC。

managed

boolean

是否启用托管 AAD。

serverAppID

string

(已弃用)服务器 AAD 应用程序 ID。 在 https://aka.ms/aks/aad-legacy了解详细信息。

serverAppSecret

string

(已弃用)服务器 AAD 应用程序机密。 在 https://aka.ms/aks/aad-legacy了解详细信息。

tenantID

string

用于身份验证的 AAD 租户 ID。 如果未指定,将使用部署订阅的租户。

ManagedClusterAddonProfile

托管群集的 Kubernetes 加载项配置文件。

名称 类型 说明
config

object

用于配置加载项的键值对。

enabled

boolean

是否启用加载项。

identity

Identity

此加载项使用的用户分配标识的信息。

ManagedClusterAgentPoolProfile

容器服务代理池的配置文件。

名称 类型 默认值 说明
availabilityZones

string[]

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

capacityReservationGroupID

string

容量预留组的完全限定资源 ID,用于从虚拟机的保留组提供虚拟机。
AKS 会将指定的代理池与容量预留组相关联。

count

integer

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

creationData

CreationData

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

currentOrchestratorVersion

string

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

eTag

string

用于实现乐观并发的唯一只读字符串。 更新资源时,eTag 值将更改。 使用后续请求的 eTag 值指定 if-match 或 if-none-match 标头,以便根据正常的 etag 约定启用乐观并发。

enableAutoScaling

boolean

是否启用自动缩放程序

enableEncryptionAtHost

boolean

是否启用基于主机的 OS 和数据驱动器加密。
这仅在某些 VM 大小和某些 Azure 区域中受支持。 有关详细信息,请参阅:https://docs.microsoft.com/azure/aks/enable-host-encryption

enableFIPS

boolean

是否使用已启用 FIPS 的 OS。
有关详细信息,请参阅 添加启用了 FIPS 的节点池

enableNodePublicIP

boolean

是否为每个节点分配自己的公共 IP。
某些方案可能需要节点池中的节点接收其自己的专用公共 IP 地址。 一种常见方案适用于游戏工作负载,其中主机需要与云虚拟机建立直接连接,以最大程度地减少跃点。 有关详细信息,请参阅 为每个节点分配公共 IP。 默认值为 false。

enableUltraSSD

boolean

是否启用 UltraSSD

gpuInstanceProfile

GPUInstanceProfile

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

hostGroupID

string

专用主机组的完全限定资源 ID,用于预配虚拟机,仅在创建方案中使用,不允许在设置后更改。
此格式为:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}。 有关详细信息,请参阅 Azure 专用主机

kubeletConfig

KubeletConfig

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

kubeletDiskType

KubeletDiskType

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

linuxOSConfig

LinuxOSConfig

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

maxCount

integer

自动缩放的最大节点数

maxPods

integer

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

minCount

integer

自动缩放的最小节点数

mode

AgentPoolMode

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

name

string

订阅和资源组上下文中代理池配置文件的唯一名称。
Windows 代理池名称必须为 6 个字符或更少。

networkProfile

AgentPoolNetworkProfile

代理池的网络相关设置。

nodeImageVersion

string

节点映像的版本

nodeLabels

object

要跨代理池中的所有节点保留的节点标签。

nodePublicIPPrefixID

string

VM 节点应使用 IP 的公共 IP 前缀 ID。
此格式为:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodeTaints

string[]

在节点池创建和缩放期间添加到新节点的污点。 例如,key=value:NoSchedule。

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 版本。 节点池版本必须与控制平面具有相同的主版本。 节点池次要版本必须位于控制平面版本的两个次要版本中。 节点池版本不能大于控制平面版本。 有关详细信息,请参阅 升级节点池

osDiskSizeGB

integer

OS 磁盘大小(以 GB 为单位)用于为主/代理池中的每个计算机指定磁盘大小。 如果指定 0,它将根据指定的 vmSize 应用默认 osDisk 大小。

osDiskType

OSDiskType

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

osSKU

OSSKU

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

osType

OSType

Linux

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

podSubnetID

string

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

powerState

PowerState

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

provisioningState

string

当前部署或预配状态。

proximityPlacementGroupID

string

邻近放置组的 ID。

scaleDownMode

ScaleDownMode

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

scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

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

scaleSetPriority

ScaleSetPriority

Regular

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

securityProfile

AgentPoolSecurityProfile

代理池的安全设置。

spotMaxPrice

number

-1

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

tags

object

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

type

AgentPoolType

代理池的类型。

upgradeSettings

AgentPoolUpgradeSettings

用于升级代理池的设置

vmSize

string

代理池 VM 的大小。
VM 大小可用性因区域而异。 如果节点包含的计算资源(内存、cpu 等)Pod 不足,可能无法正常运行。 有关受限 VM 大小的更多详细信息,请参阅:https://docs.microsoft.com/azure/aks/quotas-skus-regions

vnetSubnetID

string

代理池节点和(可选)Pod 将在启动时加入的子网的 ID。
如果未指定,将生成和使用 VNET 和子网。 如果未指定 podSubnetID,则这适用于节点和 Pod,否则它仅适用于节点。 此格式为:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

windowsProfile

AgentPoolWindowsProfile

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

workloadRuntime

WorkloadRuntime

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

ManagedClusterAPIServerAccessProfile

托管群集 API 服务器的访问配置文件。

名称 类型 说明
authorizedIPRanges

string[]

有权访问 Kubernetes API 服务器的 IP 范围。
IP 范围以 CIDR 格式指定,例如 137.117.106.88/29。 此功能与使用公共 IP Per Node 的群集或使用基本负载均衡器的群集不兼容。 有关详细信息,请参阅 API 服务器授权 IP 范围

disableRunCommand

boolean

是否禁用群集的 run 命令。

enablePrivateCluster

boolean

是否创建群集作为专用群集。
有关详细信息,请参阅 创建专用 AKS 群集

enablePrivateClusterPublicFQDN

boolean

是否为专用群集创建其他公共 FQDN。

privateDNSZone

string

群集的专用 DNS 区域模式。
默认值为 System。 有关详细信息,请参阅 配置专用 DNS 区域。 允许的值为“system”和“none”。

ManagedClusterAutoUpgradeProfile

托管群集的自动升级配置文件。

名称 类型 说明
nodeOSUpgradeChannel

nodeOSUpgradeChannel

节点 OS 升级通道
更新节点上 OS 的方式。 默认值为 NodeImage。

upgradeChannel

upgradeChannel

用于自动升级的升级通道。 默认值为“none”。
有关详细信息,请参阅 设置 AKS 群集自动升级通道

ManagedClusterAzureMonitorProfile

用于监视托管群集的 Azure Monitor 加载项配置文件。

名称 类型 说明
metrics

ManagedClusterAzureMonitorProfileMetrics

适用于 Prometheus 加载项的 Azure Monitor 托管服务的指标配置文件。 收集现装的 Kubernetes 基础结构指标,以发送到 Azure Monitor 工作区,并为自定义目标配置额外的擦除。 有关概述,请参阅 aka.ms/AzureManagedPrometheus。

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure 托管 Prometheus 加载项的 Kube 状态指标配置文件。 这些可选设置适用于使用加载项部署的 kube-state-metrics Pod。 有关详细信息,请参阅 aka.ms/AzureManagedPrometheus-optional-parameters。

名称 类型 说明
metricAnnotationsAllowList

string

将在资源的标签指标中使用的 Kubernetes 批注键的逗号分隔列表(示例:'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...')。 默认情况下,指标仅包含资源名称和命名空间标签。

metricLabelsAllowlist

string

将在资源的标签指标中使用的其他 Kubernetes 标签键的逗号分隔列表(示例:'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...')。 默认情况下,指标仅包含资源名称和命名空间标签。

ManagedClusterAzureMonitorProfileMetrics

适用于 Prometheus 加载项的 Azure Monitor 托管服务的指标配置文件。 收集现装的 Kubernetes 基础结构指标,以发送到 Azure Monitor 工作区,并为自定义目标配置额外的擦除。 有关概述,请参阅 aka.ms/AzureManagedPrometheus。

名称 类型 说明
enabled

boolean

是启用或禁用用于 Prometheus 监视的 Azure 托管 Prometheus 加载项。 有关启用和禁用的详细信息,请参阅 aka.ms/AzureManagedPrometheus-aks-enable。

kubeStateMetrics

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure 托管 Prometheus 加载项的 Kube 状态指标配置文件。 这些可选设置适用于使用加载项部署的 kube-state-metrics Pod。 有关详细信息,请参阅 aka.ms/AzureManagedPrometheus-optional-parameters。

ManagedClusterCostAnalysis

群集的成本分析配置

名称 类型 说明
enabled

boolean

是否启用成本分析
托管群集 sku.tier 必须设置为“标准”或“高级”才能启用此功能。 启用此功能会将 Kubernetes 命名空间和部署详细信息添加到 Azure 门户中的成本分析视图。 如果未指定,则默认值为 false。 有关详细信息,请参阅 aka.ms/aks/docs/cost-analysis。

ManagedClusterHTTPProxyConfig

群集 HTTP 代理配置。

名称 类型 说明
httpProxy

string

要使用的 HTTP 代理服务器终结点。

httpsProxy

string

要使用的 HTTPS 代理服务器终结点。

noProxy

string[]

不应通过代理的终结点。

trustedCa

string

用于连接到代理服务器的替代 CA 证书。

ManagedClusterIdentity

托管群集的标识。

名称 类型 说明
delegatedResources

<string,  DelegatedResource>

分配给此托管群集的委托标识资源。 这只能由另一个 Azure 资源提供程序设置,托管群集仅接受一个委派的标识资源。 仅供内部使用。

principalId

string

主组件使用的系统分配标识的主体 ID。

tenantId

string

主组件使用的系统分配标识的租户 ID。

type

ResourceIdentityType

用于托管群集的标识类型。
有关详细信息,请参阅 在 AKS中使用托管标识。

userAssignedIdentities

UserAssignedIdentities

与托管群集关联的用户标识。 此标识将用于控制平面。 仅允许一个用户分配的标识。
密钥必须是 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

ManagedClusterIngressProfile

容器服务群集的入口配置文件。

名称 类型 说明
webAppRouting

ManagedClusterIngressProfileWebAppRouting

入口配置文件的应用路由设置。 可以在 https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default中找到此功能的概述和载入指南。

ManagedClusterIngressProfileWebAppRouting

入口配置文件的应用程序路由加载项设置。

名称 类型 说明
dnsZoneResourceIds

string[]

要与应用程序路由加载项关联的 DNS 区域的资源 ID。 仅在启用应用程序路由加载项时使用。 公共和专用 DNS 区域可以位于不同的资源组中,但所有公共 DNS 区域必须位于同一资源组中,并且所有专用 DNS 区域必须位于同一资源组中。

enabled

boolean

是否启用应用程序路由加载项。

identity

UserAssignedIdentity

应用程序路由加载项的托管标识。 这是应授予权限的标识,例如,管理关联的 Azure DNS 资源并从 Azure Key Vault 获取证书。 有关更多说明,请参阅此加载项 概述

ManagedClusterLoadBalancerProfile

托管群集负载均衡器的配置文件。

名称 类型 默认值 说明
allocatedOutboundPorts

integer

0

每个 VM 分配的 SNAT 端口的所需数量。 允许的值为 0 到 64000(含)。 默认值为 0,这会导致 Azure 动态分配端口。

backendPoolType

BackendPoolType

NodeIPConfiguration

托管入站负载均衡器 BackendPool 的类型。

effectiveOutboundIPs

ResourceReference[]

群集负载均衡器的有效出站 IP 资源。

enableMultipleStandardLoadBalancers

boolean

为每个 AKS 群集启用多个标准负载均衡器。

idleTimeoutInMinutes

integer

30

所需的出站流空闲超时(以分钟为单位)。 允许的值为 4 到 120(含)。 默认值为 30 分钟。

managedOutboundIPs

ManagedOutboundIPs

群集负载均衡器的所需托管出站 IP。

outboundIPPrefixes

OutboundIPPrefixes

群集负载均衡器的所需出站 IP 前缀资源。

outboundIPs

OutboundIPs

群集负载均衡器的所需出站 IP 资源。

ManagedClusterManagedOutboundIPProfile

托管群集的托管出站 IP 资源的配置文件。

名称 类型 默认值 说明
count

integer

1

Azure 创建/管理的所需出站 IP 数。 允许的值必须介于 1 到 16 之间(含)。 默认值为 1。

ManagedClusterMetricsProfile

ManagedCluster 的指标配置文件。

名称 类型 说明
costAnalysis

ManagedClusterCostAnalysis

每个 Kubernetes 资源成本分析的详细配置。
群集的成本分析配置

ManagedClusterNATGatewayProfile

托管群集 NAT 网关的配置文件。

名称 类型 默认值 说明
effectiveOutboundIPs

ResourceReference[]

群集 NAT 网关的有效出站 IP 资源。

idleTimeoutInMinutes

integer

4

所需的出站流空闲超时(以分钟为单位)。 允许的值为 4 到 120(含)。 默认值为 4 分钟。

managedOutboundIPProfile

ManagedClusterManagedOutboundIPProfile

群集 NAT 网关的托管出站 IP 资源的配置文件。

ManagedClusterNodeResourceGroupProfile

托管群集的节点资源组锁定配置文件。

名称 类型 说明
restrictionLevel

RestrictionLevel

应用于群集节点资源组的限制级别。 如果未指定,则默认值为“未限制”

ManagedClusterOIDCIssuerProfile

托管群集的 OIDC 颁发者配置文件。

名称 类型 说明
enabled

boolean

是否启用 OIDC 颁发者。

issuerURL

string

托管群集的 OIDC 颁发者 URL。

ManagedClusterPodIdentity

有关分配给托管群集的 Pod 标识的详细信息。

名称 类型 说明
bindingSelector

string

要用于 AzureIdentityBinding 资源的绑定选择器。

identity

UserAssignedIdentity

用户分配的标识详细信息。

name

string

Pod 标识的名称。

namespace

string

Pod 标识的命名空间。

provisioningInfo

ProvisioningInfo

provisioningState

ManagedClusterPodIdentityProvisioningState

Pod 标识的当前预配状态。

ManagedClusterPodIdentityException

Pod 标识异常,允许具有某些标签的 Pod 访问 Azure 实例元数据服务(IMDS)终结点,而不会被节点托管标识(NMI)服务器截获。

名称 类型 说明
name

string

Pod 标识异常的名称。

namespace

string

Pod 标识异常的命名空间。

podLabels

object

要匹配的 Pod 标签。

ManagedClusterPodIdentityProfile

托管群集的 Pod 标识配置文件。

名称 类型 说明
allowNetworkPluginKubenet

boolean

是否允许使用 Kubenet 网络在群集上运行 Pod 标识。
默认情况下,由于 AAD Pod 标识的安全相关特性以及 IP 欺骗的风险,在 Kubenet 中运行会禁用。 有关详细信息,请参阅 将 Kubenet 网络插件与 AAD Pod 标识 配合使用。

enabled

boolean

是否启用 Pod 标识加载项。

userAssignedIdentities

ManagedClusterPodIdentity[]

群集中使用的 Pod 标识。

userAssignedIdentityExceptions

ManagedClusterPodIdentityException[]

允许的 Pod 标识异常。

ManagedClusterPodIdentityProvisioningError

Pod 标识预配的错误响应。

名称 类型 说明
error

ManagedClusterPodIdentityProvisioningErrorBody

有关错误的详细信息。

ManagedClusterPodIdentityProvisioningErrorBody

Pod 标识预配的错误响应。

名称 类型 说明
code

string

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

details

ManagedClusterPodIdentityProvisioningErrorBody[]

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

message

string

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

target

string

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

ManagedClusterPodIdentityProvisioningState

Pod 标识的当前预配状态。

名称 类型 说明
Assigned

string

Canceled

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ManagedClusterSecurityProfile

容器服务群集的安全配置文件。

名称 类型 说明
azureKeyVaultKms

AzureKeyVaultKms

Azure Key Vault 安全配置文件的密钥管理服务 设置。

defender

ManagedClusterSecurityProfileDefender

Microsoft安全配置文件的 Defender 设置。

imageCleaner

ManagedClusterSecurityProfileImageCleaner

安全配置文件的图像清理器设置。

workloadIdentity

ManagedClusterSecurityProfileWorkloadIdentity

安全配置文件的工作负荷标识设置。 使用工作负荷标识,Kubernetes 应用程序可以使用 Azure AD 安全地访问 Azure 云资源。 有关详细信息,请参阅 https://aka.ms/aks/wi

ManagedClusterSecurityProfileDefender

Microsoft安全配置文件的 Defender 设置。

名称 类型 说明
logAnalyticsWorkspaceResourceId

string

要与 Microsoft Defender 关联的 Log Analytics 工作区的资源 ID。 启用Microsoft Defender 后,此字段是必需的,并且必须是有效的工作区资源 ID。 禁用Microsoft Defender 时,请将字段留空。

securityMonitoring

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft安全配置文件的云设置的 Defender 威胁检测。

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft安全配置文件威胁检测的 Defender 设置。

名称 类型 说明
enabled

boolean

是否启用 Defender 威胁检测

ManagedClusterSecurityProfileImageCleaner

映像清理器从节点中删除未使用的映像,释放磁盘空间并帮助减少攻击外围应用。 下面是安全配置文件的设置。

名称 类型 说明
enabled

boolean

是否在 AKS 群集上启用映像清理器。

intervalHours

integer

图像清理器扫描间隔(以小时为单位)。

ManagedClusterSecurityProfileWorkloadIdentity

安全配置文件的工作负荷标识设置。

名称 类型 说明
enabled

boolean

是否启用工作负荷标识。

ManagedClusterServicePrincipalProfile

有关群集用于操作 Azure API 的服务主体标识的信息。

名称 类型 说明
clientId

string

服务主体的 ID。

secret

string

以纯文本形式与服务主体关联的机密密码。

ManagedClusterSKU

托管群集的 SKU。

名称 类型 说明
name

ManagedClusterSKUName

托管群集 SKU 的名称。

tier

ManagedClusterSKUTier

托管群集 SKU 的层。
如果未指定,则默认值为“Free”。 有关详细信息,请参阅 AKS 定价层

ManagedClusterSKUName

托管群集 SKU 的名称。

名称 类型 说明
Base

string

AKS 控制平面的基本选项。

ManagedClusterSKUTier

托管群集 SKU 的层。

名称 类型 说明
Free

string

群集管理是免费的,但针对 VM、存储和网络使用情况收费。 最适合用于试验、学习、简单测试或少于 10 个节点的工作负荷。 不建议用于生产用例。

Premium

string

除了“标准”中包含的所有功能外,群集还具有高级功能。 高级版支持为某些 Kubernetes 版本选择 LongTermSupport (aka.ms/aks/lts)。

Standard

string

建议用于任务关键型工作负荷和生产工作负荷。 包括 Kubernetes 控制平面自动缩放、工作负荷密集型测试,以及每个群集最多 5,000 个节点。 保证 99.95% 使用可用性区域的群集的 Kubernetes API 服务器终结点的可用性,并为不使用可用性区域的群集提供 99.9% 可用性。

ManagedClusterStorageProfile

容器服务群集的存储配置文件。

名称 类型 说明
blobCSIDriver

ManagedClusterStorageProfileBlobCSIDriver

存储配置文件的 AzureBlob CSI 驱动程序设置。

diskCSIDriver

ManagedClusterStorageProfileDiskCSIDriver

存储配置文件的 AzureDisk CSI 驱动程序设置。

fileCSIDriver

ManagedClusterStorageProfileFileCSIDriver

存储配置文件的 AzureFile CSI 驱动程序设置。

snapshotController

ManagedClusterStorageProfileSnapshotController

存储配置文件的快照控制器设置。

ManagedClusterStorageProfileBlobCSIDriver

存储配置文件的 AzureBlob CSI 驱动程序设置。

名称 类型 说明
enabled

boolean

是否启用 AzureBlob CSI 驱动程序。 默认值为 false。

ManagedClusterStorageProfileDiskCSIDriver

存储配置文件的 AzureDisk CSI 驱动程序设置。

名称 类型 说明
enabled

boolean

是否启用 AzureDisk CSI 驱动程序。 默认值为 true。

ManagedClusterStorageProfileFileCSIDriver

存储配置文件的 AzureFile CSI 驱动程序设置。

名称 类型 说明
enabled

boolean

是否启用 AzureFile CSI 驱动程序。 默认值为 true。

ManagedClusterStorageProfileSnapshotController

存储配置文件的快照控制器设置。

名称 类型 说明
enabled

boolean

是否启用快照控制器。 默认值为 true。

ManagedClusterWindowsProfile

托管群集中 Windows VM 的配置文件。

名称 类型 说明
adminPassword

string

指定管理员帐户的密码。

最小长度: 8 个字符

最大长度: 123 个字符

复杂性要求:需要满足以下 4 个条件中的 3 个
字符数较低
具有大写字符
包含数字
具有特殊字符(正则表达式匹配 [\W_])

不允许的值:“abc@123”、“P@$$w 0rd”、“P@ssw0rd”、“P@ssword123”、“Pa$$word”、“pass@word1”、“Password!”、“Password1”、“Password22”、“iloveyou!”

adminUsername

string

指定管理员帐户的名称。

限制: 不能以“.” 结尾。

不允许的值:“administrator”、“admin”、“user”、“user1”、“test”、“user2”、“test1”、“user3”、“admin1”、“1”, “123”、“a”、“actuser”、“adm”、“admin2”、“aspnet”、“backup”、“console”、“david”、“guest”、“john”、“owner”、“root”、“server”、“sql”、“support”、“support_388945a0”、“sys”、“test2”、“test3”、“user4”、“user5”。

最小长度: 1 个字符

最大长度: 20 个字符

enableCSIProxy

boolean

是否启用 CSI 代理。
有关 CSI 代理的更多详细信息,请参阅 CSI 代理 GitHub 存储库

gmsaProfile

WindowsGmsaProfile

托管群集中的 Windows gMSA 配置文件。

licenseType

licenseType

用于 Windows VM 的许可证类型。 有关更多详细信息,请参阅 Azure 混合用户权益

ManagedClusterWorkloadAutoScalerProfile

托管群集的工作负荷自动缩放程序配置文件。

名称 类型 说明
keda

ManagedClusterWorkloadAutoScalerProfileKeda

KEDA(Kubernetes 事件驱动的自动缩放)设置,用于工作负荷自动缩放程序配置文件。

verticalPodAutoscaler

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

工作负荷自动缩放程序配置文件的 VPA(垂直 Pod 自动缩放程序)设置。

ManagedClusterWorkloadAutoScalerProfileKeda

KEDA(Kubernetes 事件驱动的自动缩放)设置,用于工作负荷自动缩放程序配置文件。

名称 类型 说明
enabled

boolean

是否启用 KEDA。

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

工作负荷自动缩放程序配置文件的 VPA(垂直 Pod 自动缩放程序)设置。

名称 类型 默认值 说明
enabled

boolean

False

是否启用 VPA。 默认值为 false。

ManagedOutboundIPs

群集负载均衡器的所需托管出站 IP。

名称 类型 默认值 说明
count

integer

1

Azure 为群集负载均衡器创建/管理的所需 IPv4 出站 IP 数。 允许的值必须介于 1 到 100 之间(含)。 默认值为 1。

countIPv6

integer

0

Azure 为群集负载均衡器创建/管理的所需 IPv6 出站 IP 数。 允许的值必须介于 1 到 100 之间(含)。 对于单堆栈,默认值为 0,双堆栈的默认值为 1。

networkDataplane

Kubernetes 群集中使用的网络数据平面。

名称 类型 说明
azure

string

使用 Azure 网络数据平面。

cilium

string

使用 Cilium 网络数据平面。 有关详细信息,请参阅由 Cilium 提供支持的 Azure CNI

networkMode

配置了 Azure CNI 的网络模式。

名称 类型 说明
bridge

string

这不再受支持

transparent

string

未创建桥。 Intra-VM Pod 到 Pod 通信是通过 Azure CNI 创建的 IP 路由进行的。 有关详细信息,请参阅 透明模式

NetworkPlugin

用于生成 Kubernetes 网络的网络插件。

名称 类型 说明
azure

string

使用 Azure CNI 网络插件。 有关详细信息,请参阅 Azure CNI(高级)网络

kubenet

string

使用 Kubenet 网络插件。 有关详细信息,请参阅 Kubenet (基本) 网络

none

string

未预安装 CNI 插件。 有关详细信息,请参阅 BYO CNI

NetworkPluginMode

网络插件应使用的模式。

名称 类型 说明
overlay

string

与 networkPlugin=azure 一起使用时,Pod 从 PodCIDR 地址空间获得 IP,但使用 Azure 路由域,而不是 Kubenet 路由表的方法。 有关详细信息,请访问 https://aka.ms/aks/azure-cni-overlay

NetworkPolicy

用于生成 Kubernetes 网络的网络策略。

名称 类型 说明
azure

string

使用 Azure 网络策略。 有关详细信息,请参阅 Azure 和 Calico 策略 之间的 差异。

calico

string

使用 Calico 网络策略。 有关详细信息,请参阅 Azure 和 Calico 策略 之间的 差异。

cilium

string

使用 Cilium 强制实施网络策略。 这要求 networkDataplane 为“cilium”。

none

string

不会强制实施网络策略。 如果未指定 NetworkPolicy,则为默认值。

nodeOSUpgradeChannel

节点 OS 升级通道

名称 类型 说明
NodeImage

string

AKS 将使用新修补的 VHD 更新节点,其中包含每周一次的安全修复和 bug 修复。 在维护时段和激增设置之后,VHD 更新计算机将滚动重新映像到该 VHD。 选择此选项作为 AKS 托管映像时,不会产生额外的 VHD 费用。

None

string

OS 或滚动 VHD 不会尝试更新计算机 OS。 这意味着你负责安全更新

SecurityPatch

string

AKS 使用测试的安全更新下载和更新节点。 这些更新遵循维护时段设置,并生成新节点上使用的新 VHD。 在某些情况下,无法就地应用更新,在这种情况下,现有节点也将重新映像到新生成的 VHD,以便应用更改。 此选项在资源组中托管新的安全修补程序 VHD 会产生额外的费用,以便及时使用。

Unmanaged

string

OS 更新将通过 OS 内置修补基础结构自动应用。 新扩展的计算机最初将取消修补,并且会在某个时候由 OS 的基础结构修补。 此选项的行为取决于有问题的 OS。 Ubuntu 和 Mariner 通过无人参与的升级应用安全修补程序,大约每天大约在 06:00 UTC 一次。 Windows 不会自动应用安全修补程序,因此对于它们,此选项等效于“无”,直到进一步通知

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。

OutboundIPPrefixes

群集负载均衡器的所需出站 IP 前缀资源。

名称 类型 说明
publicIPPrefixes

ResourceReference[]

公共 IP 前缀资源的列表。

OutboundIPs

群集负载均衡器的所需出站 IP 资源。

名称 类型 说明
publicIPs

ResourceReference[]

公共 IP 资源的列表。

outboundType

出站(出口)路由方法。

名称 类型 说明
loadBalancer

string

负载均衡器用于通过 AKS 分配的公共 IP 出口。 这支持类型为“loadBalancer”的 Kubernetes 服务。 有关详细信息,请参阅 出站类型 loadbalancer

managedNATGateway

string

AKS 管理的 NAT 网关用于出口。

userAssignedNATGateway

string

与群集子网关联的用户分配的 NAT 网关用于出口。 这是一个高级方案,需要适当的网络配置。

userDefinedRouting

string

出口路径必须由用户定义。 这是一个高级方案,需要适当的网络配置。 有关详细信息,请参阅 出站类型 userDefinedRouting

PortRange

端口范围。

名称 类型 说明
portEnd

integer

范围中包含的最大端口。 它的范围应从 1 到 65535,并且大于或等于 portStart。

portStart

integer

范围中包含的最小端口。 它的范围应从 1 到 65535,并且小于或等于 portEnd。

protocol

Protocol

端口的网络协议。

PowerState

描述群集的电源状态

名称 类型 说明
code

code

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

PrivateLinkResource

专用链接资源

名称 类型 说明
groupId

string

资源的组 ID。

id

string

专用链接资源的 ID。

name

string

专用链接资源的名称。

privateLinkServiceID

string

资源的专用链接服务 ID,此字段仅在内部向 NRP 公开。

requiredMembers

string[]

资源的 RequiredMembers

type

string

资源类型。

Protocol

端口的网络协议。

名称 类型 说明
TCP

string

TCP 协议。

UDP

string

UDP 协议。

ProvisioningInfo

名称 类型 说明
error

ManagedClusterPodIdentityProvisioningError

Pod 标识分配错误(如果有)。

PublicNetworkAccess

managedCluster 的 PublicNetworkAccess

名称 类型 说明
Disabled

string

Enabled

string

ResourceIdentityType

用于托管群集的标识类型。

名称 类型 说明
None

string

不要对托管群集使用托管标识,而是使用服务主体。

SystemAssigned

string

使用隐式创建的系统分配的托管标识来管理群集资源。 控制平面中的主组件(如 kube-controller-manager)将使用系统分配的托管标识来操作 Azure 资源。

UserAssigned

string

使用用户指定的标识来管理群集资源。 控制平面(如 kube-controller-manager)中的主组件将使用指定的用户分配的托管标识来操作 Azure 资源。

ResourceReference

对 Azure 资源的引用。

名称 类型 说明
id

string

完全限定的 Azure 资源 ID。

RestrictionLevel

应用于群集节点资源组的限制级别。 如果未指定,则默认值为“未限制”

名称 类型 说明
ReadOnly

string

仅允许对托管节点资源组拥有 */读取 RBAC 权限

Unrestricted

string

托管节点资源组上允许所有 RBAC 权限

ScaleDownMode

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

名称 类型 说明
Deallocate

string

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

Delete

string

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

ScaleSetEvictionPolicy

虚拟机规模集逐出策略。

名称 类型 说明
Deallocate

string

节点池的基础规模集中的节点在逐出时设置为已停止解除分配的状态。 针对计算配额的已停止解除分配状态计数中的节点,并可能导致群集缩放或升级出现问题。

Delete

string

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

ScaleSetPriority

虚拟机规模集优先级。

名称 类型 说明
Regular

string

将使用常规 VM。

Spot

string

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

ServiceMeshMode

服务网格的模式。

名称 类型 说明
Disabled

string

网格已禁用。

Istio

string

Istio 部署为 AKS 加载项。

ServiceMeshProfile

托管群集的服务网格配置文件。

名称 类型 说明
istio

IstioServiceMesh

Istio 服务网格配置。

mode

ServiceMeshMode

服务网格的模式。

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。

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。

upgradeChannel

用于自动升级的升级通道。 默认值为“none”。

名称 类型 说明
node-image

string

自动将节点映像升级到可用的最新版本。 请考虑改用 nodeOSUpgradeChannel,因为它允许配置独立于 Kubernetes 版本修补的节点 OS 修补

none

string

禁用自动升级,并使群集保持其当前版本的 Kubernetes。

patch

string

当群集可用时自动将群集升级到最新支持的修补程序版本,同时保持次要版本不变。 例如,如果群集正在运行版本 1.17.7 和版本 1.17.9、1.18.4、1.18.6 和 1.19.1,则群集将升级到 1.17.9。

rapid

string

自动将群集升级到最新支持的次要版本上支持的最新修补程序版本。 如果群集位于 N-2 次要版本的 Kubernetes 版本,其中 N 是最新支持的次要版本,则群集首先升级到 N-1 次要版本上支持的最新修补程序版本。 例如,如果群集正在运行版本 1.17.7 和版本 1.17.9、1.18.4、1.18.6 和 1.19.1,则群集首先升级到 1.18.6,然后升级到 1.19.1。

stable

string

自动将群集升级到次要版本 N-1 上支持的最新修补程序版本,其中 N 是最新支持的次要版本。 例如,如果群集正在运行版本 1.17.7 和版本 1.17.9、1.18.4、1.18.6 和 1.19.1,则群集将升级到 1.18.6。

UpgradeOverrideSettings

升级群集时替代的设置。

名称 类型 说明
forceUpgrade

boolean

是否强制升级群集。 请注意,此选项指示升级操作绕过升级保护,例如检查已弃用的 API 使用情况。 仅谨慎启用此选项。

until

string

直到重写生效为止。 请注意,这仅与升级的开始时间匹配,即使升级继续时 until 过期,升级的有效性也不会更改。 默认情况下不设置此字段。 必须设置重写才能生效。

UserAssignedIdentities

与托管群集关联的用户标识。 此标识将用于控制平面。 仅允许一个用户分配的标识。

名称 类型 说明

UserAssignedIdentity

有关用户分配标识的详细信息。

名称 类型 说明
clientId

string

用户分配标识的客户端 ID。

objectId

string

用户分配标识的对象 ID。

resourceId

string

用户分配标识的资源 ID。

WindowsGmsaProfile

托管群集中的 Windows gMSA 配置文件。

名称 类型 说明
dnsServer

string

指定 Windows gMSA 的 DNS 服务器。

如果在用于创建托管群集的 vnet 中配置了 DNS 服务器,则将其设置为空。

enabled

boolean

是否启用 Windows gMSA。
指定是否在托管群集中启用 Windows gMSA。

rootDomainName

string

指定 Windows gMSA 的根域名。

如果在用于创建托管群集的 vnet 中配置了 DNS 服务器,则将其设置为空。

WorkloadRuntime

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

名称 类型 说明
OCIContainer

string

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

WasmWasi

string

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