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

Managed Clusters - Update Tags

Service:

AKS

API Version:

2022-04-01

更新托管群集上的标记。

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

URI 参数

Name	In	Required	Type	Description
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
tags	object	资源标记。

响应

Name	Type	Description
200 OK	ManagedCluster	OK
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

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	模拟用户帐户

示例

Update Managed Cluster Tags

Sample Request

HTTP

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

{
  "tags": {
    "tier": "testing",
    "archv3": ""
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.containerservice.models.TagsObject;
import java.util.HashMap;
import java.util.Map;

/** Samples for ManagedClusters UpdateTags. */
public final class Main {
    /*
     * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-04-01/examples/ManagedClustersUpdateTags.json
     */
    /**
     * Sample code: Update Managed Cluster Tags.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateManagedClusterTags(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .kubernetesClusters()
            .manager()
            .serviceClient()
            .getManagedClusters()
            .updateTags(
                "rg1", "clustername1", new TagsObject().withTags(mapOf("archv3", "", "tier", "testing")), Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armcontainerservice_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-04-01/examples/ManagedClustersUpdateTags.json
func ExampleManagedClustersClient_BeginUpdateTags() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcontainerservice.NewManagedClustersClient("subid1", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginUpdateTags(ctx,
		"rg1",
		"clustername1",
		armcontainerservice.TagsObject{
			Tags: map[string]*string{
				"archv3": to.Ptr(""),
				"tier":   to.Ptr("testing"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to Updates tags on a managed cluster.
 *
 * @summary Updates tags on a managed cluster.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-04-01/examples/ManagedClustersUpdateTags.json
 */
async function updateManagedClusterTags() {
  const subscriptionId = "subid1";
  const resourceGroupName = "rg1";
  const resourceName = "clustername1";
  const parameters = { tags: { archv3: "", tier: "testing" } };
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.managedClusters.beginUpdateTagsAndWait(
    resourceGroupName,
    resourceName,
    parameters
  );
  console.log(result);
}

updateManagedClusterTags().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
  "location": "location1",
  "name": "clustername1",
  "tags": {
    "archv3": "",
    "tier": "testing"
  },
  "type": "Microsoft.ContainerService/ManagedClusters",
  "properties": {
    "provisioningState": "Succeeded",
    "kubernetesVersion": "1.9.6",
    "dnsPrefix": "dnsprefix1",
    "agentPoolProfiles": [
      {
        "name": "nodepool1",
        "count": 3,
        "vmSize": "Standard_DS1_v2",
        "maxPods": 110,
        "osType": "Linux",
        "provisioningState": "Succeeded",
        "orchestratorVersion": "1.9.6",
        "currentOrchestratorVersion": "1.9.6"
      }
    ],
    "linuxProfile": {
      "adminUsername": "azureuser",
      "ssh": {
        "publicKeys": [
          {
            "keyData": "keydata"
          }
        ]
      }
    },
    "servicePrincipalProfile": {
      "clientId": "clientid"
    },
    "nodeResourceGroup": "MC_rg1_clustername1_location1",
    "enableRBAC": false,
    "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
    "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
    "networkProfile": {
      "networkPlugin": "kubenet",
      "podCidr": "10.244.0.0/16",
      "serviceCidr": "10.0.0.0/16",
      "dnsServiceIP": "10.0.0.10",
      "dockerBridgeCidr": "172.17.0.1/16"
    }
  }
}

定义

AgentPoolMode	代理池的模式。
AgentPoolType	代理池的类型。
AgentPoolUpgradeSettings	用于升级代理池的设置
AutoScalerProfile	启用时要应用于群集自动缩放程序的参数
CloudError	容器服务的错误响应。
CloudErrorBody	容器服务的错误响应。
code	指示群集是正在运行还是已停止
ContainerServiceLinuxProfile	容器服务群集中 Linux VM 的配置文件。
ContainerServiceNetworkProfile	网络配置的配置文件。
ContainerServiceSshConfiguration	适用于在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置。
ContainerServiceSshPublicKey	包含有关 SSH 证书公钥数据的信息。
createdByType	创建资源的标识的类型。
CreationData	从源资源创建目标资源时使用的数据。
expander	纵向扩展时要使用的扩展器
ExtendedLocation	扩展位置的复杂类型。
ExtendedLocationTypes	扩展位置的类型。
GPUInstanceProfile	用于为支持的 GPU VM SKU 指定 GPU MIG 实例配置文件的 GPUInstanceProfile。
Identity	资源的标识。
KubeletConfig	代理节点的 Kubelet 配置。
KubeletDiskType	确定 emptyDir 卷、容器运行时数据根和 Kubelet 临时存储的位置。
licenseType	要用于Windows VM 的许可证类型。 有关更多详细信息，请参阅 Azure 混合用户权益 。
LinuxOSConfig	Linux 代理节点的 OS 配置。
loadBalancerSku	托管群集的负载均衡器 SKU。
ManagedCluster	托管群集。
ManagedClusterAADProfile	AADProfile 指定Azure Active Directory集成的属性。
ManagedClusterAddonProfile	托管群集的 Kubernetes 加载项配置文件。
ManagedClusterAgentPoolProfile	容器服务代理池的配置文件。
ManagedClusterAPIServerAccessProfile	托管群集 API 服务器的访问配置文件。
ManagedClusterAutoUpgradeProfile	托管群集的自动升级配置文件。
ManagedClusterHTTPProxyConfig	群集 HTTP 代理配置。
ManagedClusterIdentity	托管群集的标识。
ManagedClusterLoadBalancerProfile	托管群集负载均衡器的配置文件。
ManagedClusterManagedOutboundIPProfile	托管群集的托管出站 IP 资源的配置文件。
ManagedClusterNATGatewayProfile	托管群集 NAT 网关的配置文件。
ManagedClusterPodIdentity	有关分配给托管群集的 Pod 标识的详细信息。
ManagedClusterPodIdentityException	Pod 标识异常，它允许具有某些标签的 Pod 访问 Azure 实例元数据服务 (IMDS) 终结点，而不会被节点托管标识 (NMI) 服务器截获。
ManagedClusterPodIdentityProfile	托管群集的 Pod 标识配置文件。
ManagedClusterPodIdentityProvisioningError	Pod 标识预配的错误响应。
ManagedClusterPodIdentityProvisioningErrorBody	Pod 标识预配的错误响应。
ManagedClusterPodIdentityProvisioningState	Pod 标识的当前预配状态。
ManagedClusterSecurityProfile	容器服务群集的安全配置文件。
ManagedClusterSecurityProfileAzureDefender	安全配置文件的 Azure Defender 设置。
ManagedClusterServicePrincipalProfile	有关群集用于操作 Azure API 的服务主体标识的信息。
ManagedClusterSKU	托管群集的 SKU。
ManagedClusterSKUName	托管群集 SKU 的名称。
ManagedClusterSKUTier	托管群集 SKU 的层。
ManagedClusterStorageProfile	容器服务群集的存储配置文件。
ManagedClusterStorageProfileDiskCSIDriver	存储配置文件的 AzureDisk CSI 驱动程序设置。
ManagedClusterStorageProfileFileCSIDriver	存储配置文件的 AzureFile CSI 驱动程序设置。
ManagedClusterStorageProfileSnapshotController	存储配置文件的快照控制器设置。
ManagedClusterWindowsProfile	托管群集中Windows VM 的配置文件。
ManagedOutboundIPs	群集负载均衡器的所需托管出站 IP。
networkMode	配置了 Azure CNI 的网络模式。
NetworkPlugin	用于生成 Kubernetes 网络的网络插件。
NetworkPolicy	用于生成 Kubernetes 网络的网络策略。
OSDiskType	要用于代理池中的计算机的 OS 磁盘类型。
OSSKU	指定 OS SKU。 如果 OSType Windows，则不得指定此值。
OSType	操作系统类型。 默认值为 Linux。
OutboundIPPrefixes	群集负载均衡器所需的出站 IP 前缀资源。
OutboundIPs	群集负载均衡器所需的出站 IP 资源。
outboundType	出站 (出口) 路由方法。
PowerState	描述群集的电源状态
PrivateLinkResource	专用链接资源
ProvisioningInfo
PublicNetworkAccess	managedCluster 的 PublicNetworkAccess
ResourceIdentityType	用于托管群集的标识类型。
ResourceReference	对 Azure 资源的引用。
ScaleDownMode	介绍如何将 VM 添加到代理池或从代理池中删除。 请参阅 计费状态。
ScaleSetEvictionPolicy	虚拟机规模集逐出策略。
ScaleSetPriority	虚拟机规模集优先级。
SysctlConfig	Linux 代理节点的 Sysctl 设置。
systemData	与创建和上次修改资源相关的元数据。
TagsObject	用于修补操作的标记对象。
upgradeChannel	用于自动升级的升级通道。 默认值为“none”。
UserAssignedIdentities	与托管群集关联的用户标识。 此标识将用于控制平面。 仅允许一个用户分配的标识。
UserAssignedIdentity	有关用户分配标识的详细信息。
WindowsGmsaProfile	Windows托管群集中的 gMSA 配置文件。
WorkloadRuntime	确定节点可以运行的工作负荷的类型。

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

AutoScalerProfile

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

Name	Type	Description
balance-similar-node-groups	string	检测类似节点池并在各池之间均衡节点数。 有效值为“true”和“false”
expander	expander	纵向扩展时要使用的扩展器 如果未指定，则默认值为“random”。 有关详细信息，请参阅 扩展器 。
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。 对于突发/批量缩放场景，如果你希望 CA 在 kubernetes 计划程序计划所有 Pod 之后再进行操作，可以指示 CA 忽略未达到一定存在时间的计划外 Pod。 默认值为“0s”。 值必须是一个整数，后跟单位 ('s'，以秒为单位，“m”表示分钟数，“h”（小时）等) 。
ok-total-unready-count	string	允许的未读节点数，而不考虑 max-total-unready-percentage。 这必须是整数。 默认值为 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-system (中删除具有 pod 的节点，但 DaemonSet 或镜像 pod) 默认值为 true。

CloudError

容器服务的错误响应。

Name	Type	Description
error	CloudErrorBody	有关错误的详细信息。

CloudErrorBody

容器服务的错误响应。

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

code

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

Name	Type	Description
Running	string	群集正在运行。
Stopped	string	群集已停止。

ContainerServiceLinuxProfile

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

Name	Type	Description
adminUsername	string	用于 Linux VM 的管理员用户名。
ssh	ContainerServiceSshConfiguration	在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置。

ContainerServiceNetworkProfile

网络配置的配置文件。

Name	Type	Default Value	Description
dnsServiceIP	string	10.0.0.10	分配给 Kubernetes DNS 服务的 IP 地址。 它必须位于 serviceCidr 中指定的 Kubernetes 服务地址范围内。
dockerBridgeCidr	string	172.17.0.1/16	分配给 Docker 网桥网络的 CIDR 表示法 IP 范围。 它不得与任何子网 IP 范围或 Kubernetes 服务地址范围重叠。
ipFamilies	string[]		用于指定群集可用的 IP 版本的 IP 系列。 IP 系列用于确定单堆栈或双堆栈群集。 对于单堆栈，预期值为 IPv4。 对于双堆栈，预期值为 IPv4 和 IPv6。
loadBalancerProfile	ManagedClusterLoadBalancerProfile		群集负载均衡器的配置文件。
loadBalancerSku	loadBalancerSku		托管群集的负载均衡器 SKU。 默认值为“standard”。 有关负载均衡器 SKU 之间的差异的详细信息，请参阅Azure 负载均衡器 SKU。
natGatewayProfile	ManagedClusterNATGatewayProfile		群集 NAT 网关的配置文件。
networkMode	networkMode		配置了 Azure CNI 的网络模式。 如果 networkPlugin 不是“azure”，则无法指定此值。
networkPlugin	NetworkPlugin	kubenet	用于生成 Kubernetes 网络的网络插件。
networkPolicy	NetworkPolicy		用于生成 Kubernetes 网络的网络策略。
outboundType	outboundType	loadBalancer	出站 (出口) 路由方法。 这只能在群集创建时设置，以后无法更改。 有关详细信息，请参阅 出口出站类型。
podCidr	string	10.244.0.0/16	CIDR 表示法 IP 范围，使用 kubenet 时从其中分配 Pod IP。
podCidrs	string[]		用于分配 Pod IP 的 CIDR 表示法 IP 范围。 单堆栈网络需要一个 IPv4 CIDR。 两个CIDR，每个 IP 系列 (IPv4/IPv6) ，预计双堆栈网络。
serviceCidr	string	10.0.0.0/16	CIDR 表示法 IP 范围，从其中分配服务群集 IP。 此范围不得与任何子网 IP 范围重叠。
serviceCidrs	string[]		用于分配服务群集 IP 的 CIDR 表示法 IP 范围。 单堆栈网络需要一个 IPv4 CIDR。 两个CIDR，每个 IP 系列 (IPv4/IPv6) ，预计双堆栈网络。 它们不得与任何子网 IP 范围重叠。

ContainerServiceSshConfiguration

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

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

ContainerServiceSshPublicKey

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

Name	Type	Description
keyData	string	用于通过 SSH 通过 VM 进行身份验证的证书公钥。 证书必须采用 PEM 格式，且不带标头。

createdByType

创建资源的标识的类型。

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreationData

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

Name	Type	Description
sourceResourceId	string	这是用于创建目标对象的源对象的 ARM ID。

expander

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

Name	Type	Description
least-waste	string	选择在纵向扩展后将具有最少空闲 CPU (的节点组（如果已绑定、未使用的内存) ）。 如果具有不同类的节点（例如高 CPU 或高内存节点），并且仅当存在需要大量这些资源的挂起 Pod 时，才需要扩展这些节点。
most-pods	string	选择在纵向扩展时能够计划最多 Pod 的节点组。 使用 nodeSelector 确保某些 Pod 降落在特定节点上时，这非常有用。 请注意，这不会导致自动缩放程序选择更大的节点和较小的节点，因为它可以同时添加多个较小的节点。
priority	string	选择具有用户分配的最高优先级的节点组。 此处的更多详细信息介绍了配置。
random	string	当节点组不需要以不同的方式缩放时使用。

ExtendedLocation

扩展位置的复杂类型。

Name	Type	Description
name	string	扩展位置的名称。
type	ExtendedLocationTypes	扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

Name	Type	Description
EdgeZone	string

GPUInstanceProfile

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

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

Identity

资源的标识。

Name	Type	Description
principalId	string	资源标识的主体 ID。
tenantId	string	资源的租户 ID。
type	ResourceIdentityType	标识类型。

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

licenseType

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

Name	Type	Description
None	string	未应用其他许可。
Windows_Server	string	为 Windows VM 启用 Azure 混合用户权益。

LinuxOSConfig

Linux 代理节点的 OS 配置。

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

loadBalancerSku

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

Name	Type	Description
basic	string	使用具有有限功能的基本负载均衡器。
standard	string	使用标准负载均衡器。 这是建议负载均衡器 SKU。 有关在托管群集中使用负载均衡器的详细信息，请参阅标准负载均衡器一文。

ManagedCluster

托管群集。

Name	Type	Description
extendedLocation	ExtendedLocation	虚拟机的扩展位置。
id	string	资源的完全限定的资源 ID。 Ex - /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.azurePortalFQDN	string	Azure 门户用于访问托管群集的特殊 FQDN。 此 FQDN 仅供 Azure 门户使用，不应由其他客户端使用。 Azure 门户要求某些跨域资源共享 (CORS) 标头在一些响应中发送，Kubernetes APIServer 默认情况下不会处理这些标头。 此特殊的 FQDN 支持 CORS，使 Azure 门户能够正常运行。
properties.currentKubernetesVersion	string	托管群集运行的 Kubernetes 版本。 如果 kubernetesVersion 是一个完全指定的主要.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 安全策略 (预览版) 。 此功能设置为在 2020 年 10 月 15 日删除。 有关详细信息，请在 aka.ms/aks/azpodpolicy。
properties.enableRBAC	boolean	是否启用 Kubernetes Role-Based 访问控制。
properties.fqdn	string	主池的 FQDN。
properties.fqdnSubdomain	string	具有自定义专用 DNS 区域的专用群集的 FQDN 子域。 创建托管群集后，无法更新此功能。
properties.httpProxyConfig	ManagedClusterHTTPProxyConfig	使用 HTTP 代理服务器预配群集的配置。
properties.identityProfile	<string,  UserAssignedIdentity>	与群集关联的标识。
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.networkProfile	ContainerServiceNetworkProfile	网络配置文件。
properties.nodeResourceGroup	string	包含代理池节点的资源组的名称。
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.securityProfile	ManagedClusterSecurityProfile	托管群集的安全配置文件。
properties.servicePrincipalProfile	ManagedClusterServicePrincipalProfile	有关群集用于操作 Azure API 的服务主体标识的信息。
properties.storageProfile	ManagedClusterStorageProfile	托管群集存储配置文件。
properties.windowsProfile	ManagedClusterWindowsProfile	托管群集中Windows VM 的配置文件。
sku	ManagedClusterSKU	托管群集 SKU。
systemData	systemData	Azure 资源管理器包含 createdBy 和 modifiedBy 信息的元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

ManagedClusterAADProfile

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

Name	Type	Description
adminGroupObjectIDs	string[]	将具有群集管理员角色的 AAD 组对象 ID 的列表。
clientAppID	string	客户端 AAD 应用程序 ID。
enableAzureRBAC	boolean	是否为 Kubernetes 授权启用 Azure RBAC。
managed	boolean	是否启用托管 AAD。
serverAppID	string	服务器 AAD 应用程序 ID。
serverAppSecret	string	服务器 AAD 应用程序机密。
tenantID	string	用于身份验证的 AAD 租户 ID。 如果未指定，将使用部署订阅的租户。

ManagedClusterAddonProfile

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

Name	Type	Description
config	object	用于配置加载项的键值对。
enabled	boolean	是否启用加载项。
identity	Identity	此加载项使用的用户分配标识的信息。

ManagedClusterAgentPoolProfile

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

Name	Type	Default Value	Description
availabilityZones	string[]		要用于节点的可用性区域列表。 仅当 AgentPoolType 属性为“VirtualMachineScaleSets”时，才能指定此值。
count	integer		) 托管 docker 容器的 VM (代理数。 允许的值必须介于 0 到 1000 () （包括用户池的 1 到 1000 (）范围内（包括 1 到 1000) ）范围内。 默认值为 1。
creationData	CreationData		如果节点池将使用快照创建/升级，则用于指定源快照 ID 的 CreationData。
currentOrchestratorVersion	string		代理池运行的 Kubernetes 版本。 如果 orchestratorVersion 是完全指定的 major.minor.patch> 版本<，则此字段将完全等于它。 如果 orchestratorVersion 为 <major.minor>，则此字段将包含正在使用的完整 <major.minor.patch> 版本。
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。
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 个字符或更少。
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 支持它并且缓存磁盘大于请求的 OSDiskSizeGB，则默认值为“临时”。 否则，默认为“托管”。 创建后可能不会更改。 有关详细信息，请参阅 临时 OS。
osSKU	OSSKU		指定 OS SKU。 如果 OSType Windows，则不能指定此值。
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		缩放代理池时要使用的缩减模式。 这也会影响群集自动缩放程序行为。 如果未指定，则默认为“删除”。
scaleSetEvictionPolicy	ScaleSetEvictionPolicy	Delete	要使用的虚拟机规模集逐出策略。 除非 scaleSetPriority 为“Spot”，否则无法指定此值。 如果未指定，则默认值为“Delete”。
scaleSetPriority	ScaleSetPriority	Regular	虚拟机规模集优先级。 如果未指定，则默认值为“Regular”。
spotMaxPrice	number	-1	) 你愿意为现成实例付费的最大价格 (美元。 可能的值是大于零或 -1 的任何十进制值，指示默认价格是按需价格。 可能的值是大于零或 -1 的任何十进制值，表示愿意支付任何按需价格。 有关现成定价的更多详细信息，请参阅 现成 VM 定价
tags	object		要保留在代理池虚拟机规模集上的标记。
type	AgentPoolType		代理池的类型。
upgradeSettings	AgentPoolUpgradeSettings		用于升级 Agentpool 的设置
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}
workloadRuntime	WorkloadRuntime		确定节点可以运行的工作负荷的类型。

ManagedClusterAPIServerAccessProfile

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

Name	Type	Description
authorizedIPRanges	string[]	有权访问 Kubernetes API 服务器的 IP 范围。 IP 范围以 CIDR 格式指定，例如 137.117.106.88/29。 此功能与使用公共 IP Per Node 的群集不兼容，或者使用基本负载均衡器的群集。 有关详细信息，请参阅 API 服务器授权 IP 范围。
disableRunCommand	boolean	是否禁用群集的运行命令。
enablePrivateCluster	boolean	是否创建群集作为专用群集。 有关详细信息，请参阅 创建专用 AKS 群集。
enablePrivateClusterPublicFQDN	boolean	是否为专用群集创建其他公共 FQDN。
privateDNSZone	string	群集的专用 DNS 区域模式。 默认值为 System。 有关详细信息，请参阅 配置专用 DNS 区域。 允许的值为“system”和“none”。

ManagedClusterAutoUpgradeProfile

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

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

ManagedClusterHTTPProxyConfig

群集 HTTP 代理配置。

Name	Type	Description
httpProxy	string	要使用的 HTTP 代理服务器终结点。
httpsProxy	string	要使用的 HTTPS 代理服务器终结点。
noProxy	string[]	不应通过代理的终结点。
trustedCa	string	用于连接到代理服务器的可选 CA 证书。

ManagedClusterIdentity

托管群集的标识。

Name	Type	Description
principalId	string	主组件使用的系统分配标识的主体 ID。
tenantId	string	主组件使用的系统分配标识的租户 ID。
type	ResourceIdentityType	用于托管群集的标识类型。 有关详细信息，请参阅 AKS 中使用托管标识。
userAssignedIdentities	UserAssignedIdentities	与托管群集关联的用户标识。 此标识将用于控制平面。 仅允许一个用户分配的标识。 密钥必须是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

ManagedClusterLoadBalancerProfile

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

Name	Type	Default Value	Description
allocatedOutboundPorts	integer	0	每个 VM 分配的 SNAT 端口的所需数量。 允许的值范围为 0 到 64000 (非独占) 。 默认值为 0，导致 Azure 动态分配端口。
effectiveOutboundIPs	ResourceReference[]		群集负载均衡器的有效出站 IP 资源。
enableMultipleStandardLoadBalancers	boolean		为每个 AKS 群集启用多个标准负载均衡器。
idleTimeoutInMinutes	integer	30	所需的出站流空闲超时（以分钟为单位）。 允许的值为 4 到 120 (（含) ）。 默认值为 30 分钟。
managedOutboundIPs	ManagedOutboundIPs		群集负载均衡器的所需托管出站 IP。
outboundIPPrefixes	OutboundIPPrefixes		群集负载均衡器所需的出站 IP 前缀资源。
outboundIPs	OutboundIPs		群集负载均衡器所需的出站 IP 资源。

ManagedClusterManagedOutboundIPProfile

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

Name	Type	Default Value	Description
count	integer	1	由 Azure 创建/管理的所需出站 IP 数。 允许的值必须介于 1 到 16 (非独占) 范围内。 默认值为 1。

ManagedClusterNATGatewayProfile

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

Name	Type	Default Value	Description
effectiveOutboundIPs	ResourceReference[]		群集 NAT 网关的有效出站 IP 资源。
idleTimeoutInMinutes	integer	4	所需的出站流空闲超时（以分钟为单位）。 允许的值为 4 到 120 (（含) ）。 默认值为 4 分钟。
managedOutboundIPProfile	ManagedClusterManagedOutboundIPProfile		群集 NAT 网关的托管出站 IP 资源的配置文件。

ManagedClusterPodIdentity

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

Name	Type	Description
bindingSelector	string	要用于 AzureIdentityBinding 资源的绑定选择器。
identity	UserAssignedIdentity	用户分配的标识详细信息。
name	string	Pod 标识的名称。
namespace	string	Pod 标识的命名空间。
provisioningInfo	ProvisioningInfo
provisioningState	ManagedClusterPodIdentityProvisioningState	Pod 标识的当前预配状态。

ManagedClusterPodIdentityException

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

Name	Type	Description
name	string	Pod 标识异常的名称。
namespace	string	Pod 标识异常的命名空间。
podLabels	object	要匹配的 Pod 标签。

ManagedClusterPodIdentityProfile

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

Name	Type	Description
allowNetworkPluginKubenet	boolean	是否允许 Pod 标识在具有 Kubenet 网络的群集上运行。 默认情况下，由于 AAD Pod 标识的安全相关性质以及 IP 欺骗的风险，在 Kubenet 中运行会禁用。 有关详细信息，请参阅 将 Kubenet 网络插件与 AAD Pod 标识配合使用 。
enabled	boolean	是否启用 Pod 标识加载项。
userAssignedIdentities	ManagedClusterPodIdentity[]	在群集中使用的 Pod 标识。
userAssignedIdentityExceptions	ManagedClusterPodIdentityException[]	允许的 Pod 标识异常。

ManagedClusterPodIdentityProvisioningError

Pod 标识预配的错误响应。

Name	Type	Description
error	ManagedClusterPodIdentityProvisioningErrorBody	有关错误的详细信息。

ManagedClusterPodIdentityProvisioningErrorBody

Pod 标识预配的错误响应。

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

ManagedClusterPodIdentityProvisioningState

Pod 标识的当前预配状态。

Name	Type	Description
Assigned	string
Deleting	string
Failed	string
Updating	string

ManagedClusterSecurityProfile

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

Name	Type	Description
azureDefender	ManagedClusterSecurityProfileAzureDefender	安全配置文件的 Azure Defender 设置。

ManagedClusterSecurityProfileAzureDefender

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

Name	Type	Description
enabled	boolean	是否启用 Azure Defender
logAnalyticsWorkspaceResourceId	string	要与 Azure Defender 关联的 Log Analytics 工作区的资源 ID。 启用 Azure Defender 后，此字段是必需的，并且必须是有效的工作区资源 ID。 禁用 Azure Defender 后，将字段留空。

ManagedClusterServicePrincipalProfile

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

Name	Type	Description
clientId	string	服务主体的 ID。
secret	string	以纯文本形式与服务主体关联的机密密码。

ManagedClusterSKU

托管群集的 SKU。

Name	Type	Description
name	ManagedClusterSKUName	托管群集 SKU 的名称。
tier	ManagedClusterSKUTier	托管群集 SKU 的层。 如果未指定，则默认值为“Free”。 有关更多详细信息，请参阅 运行时间 SLA 。

ManagedClusterSKUName

托管群集 SKU 的名称。

Name	Type	Description
Basic	string

ManagedClusterSKUTier

托管群集 SKU 的层。

Name	Type	Description
Free	string	没有保证的 SLA，不收取额外费用。 免费层群集的 SLO 为 99.5%。
Paid	string	为不使用 可用性区域可用性区域的群集提供 99.95% 的 Kubernetes API 服务器终结点可用性，以及 99.9% 的可用性。

ManagedClusterStorageProfile

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

Name	Type	Description
diskCSIDriver	ManagedClusterStorageProfileDiskCSIDriver	存储配置文件的 AzureDisk CSI 驱动程序设置。
fileCSIDriver	ManagedClusterStorageProfileFileCSIDriver	存储配置文件的 AzureFile CSI 驱动程序设置。
snapshotController	ManagedClusterStorageProfileSnapshotController	存储配置文件的快照控制器设置。

ManagedClusterStorageProfileDiskCSIDriver

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

Name	Type	Description
enabled	boolean	是否启用 AzureDisk CSI 驱动程序。 默认值为 true。

ManagedClusterStorageProfileFileCSIDriver

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

Name	Type	Description
enabled	boolean	是否启用 AzureFile CSI 驱动程序。 默认值为 true。

ManagedClusterStorageProfileSnapshotController

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

Name	Type	Description
enabled	boolean	是否启用快照控制器。 默认值为 true。

ManagedClusterWindowsProfile

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

Name	Type	Description
adminPassword	string	指定管理员帐户的密码。 最小长度： 8 个字符 最大长度： 123 个字符 复杂性要求： 需要满足以下 4 个条件中的 3 个条件 字符较少 具有大字符 包含数字 具有特殊字符 (正则表达式匹配 [\W_]) 不允许的值： “abc@123”、“P@$$w 0rd”、“P@ssw0rd”、“P@ssword123”、“Pa$$word”、“pass@word1”、“Password！”、“Password1”、“Password22”、“iveyou！”
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 混合用户权益 。

ManagedOutboundIPs

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

Name	Type	Default Value	Description
count	integer	1	为群集负载均衡器创建的/由 Azure 管理的所需 IPv4 出站 IP 数。 允许的值必须介于 1 到 100 (非独占) 范围内。 默认值为 1。
countIPv6	integer	0	为群集负载均衡器创建/托管的 Azure 创建的所需 IPv6 出站 IP 数。 允许的值必须介于 1 到 100 (非独占) 范围内。 对于单堆栈，默认值为 0，双堆栈的默认值为 1。

networkMode

配置了 Azure CNI 的网络模式。

Name	Type	Description
bridge	string	这不再受支持
transparent	string	未创建桥。 VM 内部 Pod 到 Pod 通信是通过 Azure CNI 创建的 IP 路由进行的。 有关详细信息，请参阅 透明模式 。

NetworkPlugin

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

Name	Type	Description
azure	string	使用 Azure CNI 网络插件。 有关详细信息，请参阅 Azure CNI (高级) 网络 。
kubenet	string	使用 Kubenet 网络插件。 有关详细信息，请参阅 Kubenet (基本) 网络 。

NetworkPolicy

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

Name	Type	Description
azure	string	使用 Azure 网络策略。 有关详细信息 ，请参阅 Azure 和 Calico 策略之间的差异 。
calico	string	使用 Calico 网络策略。 有关详细信息 ，请参阅 Azure 和 Calico 策略之间的差异 。

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。

OutboundIPPrefixes

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

Name	Type	Description
publicIPPrefixes	ResourceReference[]	公共 IP 前缀资源的列表。

OutboundIPs

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

Name	Type	Description
publicIPs	ResourceReference[]	公共 IP 资源的列表。

outboundType

出站 (出口) 路由方法。

Name	Type	Description
loadBalancer	string	对于经过 AKS 分配的公共 IP 的传出流量，将使用负载均衡器。 这支持类型为“loadBalancer”的 Kubernetes 服务。 有关详细信息，请参阅 出站类型 loadbalancer。
managedNATGateway	string	AKS 托管的 NAT 网关用于出口。
userAssignedNATGateway	string	与群集子网关联的用户分配的 NAT 网关用于出口。 这是一种高级方案，需要适当的网络配置。
userDefinedRouting	string	Egress路径必须由用户定义。 这是一种高级方案，需要适当的网络配置。 有关详细信息，请参阅 出站类型 userDefinedRouting。

PowerState

描述群集的电源状态

Name	Type	Description
code	code	指示群集是正在运行还是已停止

PrivateLinkResource

专用链接资源

Name	Type	Description
groupId	string	资源的组 ID。
id	string	专用链接资源的 ID。
name	string	专用链接资源的名称。
privateLinkServiceID	string	资源的专用链接服务 ID，此字段仅在内部向 NRP 公开。
requiredMembers	string[]	资源的 RequiredMembers
type	string	资源类型。

ProvisioningInfo

Name	Type	Description
error	ManagedClusterPodIdentityProvisioningError	如果有任何) ，则 Pod 标识分配错误 (。

PublicNetworkAccess

managedCluster 的 PublicNetworkAccess

Name	Type	Description
Disabled	string
Enabled	string

ResourceIdentityType

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

Name	Type	Description
None	string	不要对托管群集使用托管标识，而是使用服务主体。
SystemAssigned	string	使用隐式创建的系统分配的托管标识来管理群集资源。 控制平面（如 kube-controller-manager）中的主组件将使用系统分配的托管标识来操作 Azure 资源。
UserAssigned	string	使用用户指定的标识管理群集资源。 控制平面（如 kube-controller-manager）中的主组件将使用指定的用户分配的托管标识来操作 Azure 资源。

ResourceReference

对 Azure 资源的引用。

Name	Type	Description
id	string	完全限定的 Azure 资源 ID。

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。

systemData

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

Name	Type	Description
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TagsObject

用于修补操作的标记对象。

Name	Type	Description
tags	object	资源标记。

upgradeChannel

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

Name	Type	Description
node-image	string	自动将节点映像升级到可用的最新版本。 Microsoft 经常（通常每周）为映像节点提供补丁和新映像，但除非升级节点映像，正在运行的节点将不会获得新映像。 当有新版本可用时，打开节点映像通道将自动更新节点映像。
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	在最新支持的次要版本上自动将群集升级到支持的最新修补程序版本。 如果群集的 Kubernetes 版本的次要版本为 N-2，其中 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。

UserAssignedIdentities

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

Name	Type	Description

UserAssignedIdentity

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

Name	Type	Description
clientId	string	用户分配标识的客户端 ID。
objectId	string	用户分配标识的对象 ID。
resourceId	string	用户分配标识的资源 ID。

WindowsGmsaProfile

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

Name	Type	Description
dnsServer	string	指定 Windows gMSA 的 DNS 服务器。 如果在 vnet 中配置了用于创建托管群集的 DNS 服务器，请将其设置为空。
enabled	boolean	是否启用 Windows gMSA。 指定是否在托管群集中启用 Windows gMSA。
rootDomainName	string	指定 Windows gMSA 的根域名。 如果在 vnet 中配置了用于创建托管群集的 DNS 服务器，请将其设置为空。

WorkloadRuntime

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

Name	Type	Description
OCIContainer	string	节点将使用 Kubelet 来运行标准 OCI 容器工作负荷。
WasmWasi	string	节点将使用 Krustlet 通过 WASI 提供程序 (预览版) 运行 WASM 工作负荷。