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

ManagedCluster interface

参考

包:: @azure/arm-containerservice

托管群集。

扩展: TrackedResource

属性

aadProfile	Azure Active Directory 配置。
addonProfiles	托管群集加载项的配置文件。
agentPoolProfiles	代理池属性。
apiServerAccessProfile	托管群集 API 服务器的访问配置文件。
autoScalerProfile	启用时要应用于群集自动缩放程序的参数
autoUpgradeProfile	自动升级配置。
azureMonitorProfile	用于监视托管群集的 Azure Monitor 加载项配置文件。
azurePortalFqdn	Azure 门户要求在某些响应中发送某些跨域资源共享（CORS）标头，Kubernetes APIServer 默认情况下不会处理这些标头。此特殊的 FQDN 支持 CORS，使 Azure 门户能够正常运行。注意：此属性不会序列化。它只能由服务器填充。
currentKubernetesVersion	如果 kubernetesVersion 是一个完全指定的版本 <major.minor.patch>，则此字段将完全等于它。如果 kubernetesVersion <major.minor>，则此字段将包含正在使用的完整 <major.minor.patch> 版本。注意：此属性不会序列化。它只能由服务器填充。
disableLocalAccounts	如果设置为 true，将禁用此群集的静态凭据。这只能在启用了 AAD 的托管群集上使用。有关详细信息，请参阅禁用本地帐户。
diskEncryptionSetID	此格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}”
dnsPrefix	创建托管群集后，无法更新此功能。
enablePodSecurityPolicy	（已弃用）是否启用 Kubernetes Pod 安全策略（预览版）。 Kubernetes v1.21 中弃用 PodSecurityPolicy，并在 v1.25 中从 Kubernetes 中删除。在 https://aka.ms/k8s/psp 和 https://aka.ms/aks/psp了解详细信息。
enableRbac	是否启用 Kubernetes Role-Based 访问控制。
eTag	用于实现乐观并发的唯一只读字符串。更新资源时，eTag 值将更改。使用后续请求的 eTag 值指定 if-match 或 if-none-match 标头，以便根据正常的 etag 约定启用乐观并发。注意：此属性不会序列化。它只能由服务器填充。
extendedLocation	虚拟机的扩展位置。
fqdn	主池的 FQDN。注意：此属性不会序列化。它只能由服务器填充。
fqdnSubdomain	创建托管群集后，无法更新此功能。
httpProxyConfig	使用 HTTP 代理服务器预配群集的配置。
identity	托管群集的标识（如果已配置）。
identityProfile	与托管群集关联的用户标识。 kubelet 将使用此标识。仅允许一个用户分配的标识。唯一接受的密钥为“kubeletidentity”，值为“resourceId”：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
ingressProfile	托管群集的入口配置文件。
kubernetesVersion	支持两个修补程序版本 <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 群集。
linuxProfile	托管群集中 Linux VM 的配置文件。
maxAgentPools	托管群集的最大代理池数。注意：此属性不会序列化。它只能由服务器填充。
metricsProfile	可选群集指标配置。
networkProfile	网络配置文件。
nodeResourceGroup	包含代理池节点的资源组的名称。
nodeResourceGroupProfile	节点资源组配置的配置文件。
oidcIssuerProfile	托管群集的 OIDC 颁发者配置文件。
podIdentityProfile	有关 AAD Pod 标识集成的详细信息，请参阅使用 AAD Pod 标识。
powerState	群集的电源状态。注意：此属性不会序列化。它只能由服务器填充。
privateFqdn	专用群集的 FQDN。注意：此属性不会序列化。它只能由服务器填充。
privateLinkResources	与群集关联的专用链接资源。
provisioningState	当前预配状态。注意：此属性不会序列化。它只能由服务器填充。
publicNetworkAccess	允许或拒绝 AKS 的公共网络访问
resourceUID	resourceUID 唯一标识重复使用 ARM ResourceIds 的 ManagedCluster（即：create、delete、create sequence）注意：此属性不会序列化。它只能由服务器填充。
securityProfile	托管群集的安全配置文件。
serviceMeshProfile	托管群集的服务网格配置文件。
servicePrincipalProfile	有关群集用于操作 Azure API 的服务主体标识的信息。
sku	托管群集 SKU。
storageProfile	托管群集的存储配置文件。
supportPlan	托管群集的支持计划。如果未指定，则默认值为“KubernetesOfficial”。
upgradeSettings	用于升级群集的设置。
windowsProfile	托管群集中 Windows VM 的配置文件。
workloadAutoScalerProfile	托管群集的工作负荷自动缩放程序配置文件。

继承属性

id	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。它只能由服务器填充。
location	资源所在的地理位置
name	资源说明的名称：此属性不会序列化。它只能由服务器填充。
systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。注意：此属性不会序列化。它只能由服务器填充。
tags	资源标记。
type	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。它只能由服务器填充。

属性详细信息

aadProfile

Azure Active Directory 配置。

aadProfile?: ManagedClusterAADProfile

属性值

ManagedClusterAADProfile

addonProfiles

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

addonProfiles?: {[propertyName: string]: ManagedClusterAddonProfile}

属性值

{[propertyName: string]: ManagedClusterAddonProfile}

agentPoolProfiles

代理池属性。

agentPoolProfiles?: ManagedClusterAgentPoolProfile[]

属性值

ManagedClusterAgentPoolProfile[]

apiServerAccessProfile

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

apiServerAccessProfile?: ManagedClusterAPIServerAccessProfile

属性值

ManagedClusterAPIServerAccessProfile

autoScalerProfile

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

autoScalerProfile?: ManagedClusterPropertiesAutoScalerProfile

属性值

ManagedClusterPropertiesAutoScalerProfile

autoUpgradeProfile

自动升级配置。

autoUpgradeProfile?: ManagedClusterAutoUpgradeProfile

属性值

ManagedClusterAutoUpgradeProfile

azureMonitorProfile

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

azureMonitorProfile?: ManagedClusterAzureMonitorProfile

属性值

ManagedClusterAzureMonitorProfile

azurePortalFqdn

Azure 门户要求在某些响应中发送某些跨域资源共享（CORS）标头，Kubernetes APIServer 默认情况下不会处理这些标头。此特殊的 FQDN 支持 CORS，使 Azure 门户能够正常运行。注意：此属性不会序列化。它只能由服务器填充。

azurePortalFqdn?: string

属性值

string

currentKubernetesVersion

如果 kubernetesVersion 是一个完全指定的版本 <major.minor.patch>，则此字段将完全等于它。如果 kubernetesVersion <major.minor>，则此字段将包含正在使用的完整 <major.minor.patch> 版本。注意：此属性不会序列化。它只能由服务器填充。

currentKubernetesVersion?: string

属性值

string

disableLocalAccounts

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

disableLocalAccounts?: boolean

属性值

boolean

diskEncryptionSetID

此格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}”

diskEncryptionSetID?: string

属性值

string

dnsPrefix

创建托管群集后，无法更新此功能。

dnsPrefix?: string

属性值

string

enablePodSecurityPolicy

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

enablePodSecurityPolicy?: boolean

属性值

boolean

enableRbac

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

enableRbac?: boolean

属性值

boolean

eTag

用于实现乐观并发的唯一只读字符串。更新资源时，eTag 值将更改。使用后续请求的 eTag 值指定 if-match 或 if-none-match 标头，以便根据正常的 etag 约定启用乐观并发。注意：此属性不会序列化。它只能由服务器填充。

eTag?: string

属性值

string

extendedLocation

虚拟机的扩展位置。

extendedLocation?: ExtendedLocation

属性值

ExtendedLocation

fqdn

主池的 FQDN。注意：此属性不会序列化。它只能由服务器填充。

fqdn?: string

属性值

string

fqdnSubdomain

创建托管群集后，无法更新此功能。

fqdnSubdomain?: string

属性值

string

httpProxyConfig

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

httpProxyConfig?: ManagedClusterHttpProxyConfig

属性值

ManagedClusterHttpProxyConfig

identity

托管群集的标识（如果已配置）。

identity?: ManagedClusterIdentity

属性值

ManagedClusterIdentity

identityProfile

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

identityProfile?: {[propertyName: string]: UserAssignedIdentity}

属性值

{[propertyName: string]: UserAssignedIdentity}

ingressProfile

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

ingressProfile?: ManagedClusterIngressProfile

属性值

ManagedClusterIngressProfile

kubernetesVersion

支持两个修补程序版本 <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 群集。

kubernetesVersion?: string

属性值

string

linuxProfile

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

linuxProfile?: ContainerServiceLinuxProfile

属性值

ContainerServiceLinuxProfile

maxAgentPools

托管群集的最大代理池数。注意：此属性不会序列化。它只能由服务器填充。

maxAgentPools?: number

属性值

number

metricsProfile

可选群集指标配置。

metricsProfile?: ManagedClusterMetricsProfile

属性值

ManagedClusterMetricsProfile

networkProfile

网络配置文件。

networkProfile?: ContainerServiceNetworkProfile

属性值

ContainerServiceNetworkProfile

nodeResourceGroup

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

nodeResourceGroup?: string

属性值

string

nodeResourceGroupProfile

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

nodeResourceGroupProfile?: ManagedClusterNodeResourceGroupProfile

属性值

ManagedClusterNodeResourceGroupProfile

oidcIssuerProfile

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

oidcIssuerProfile?: ManagedClusterOidcIssuerProfile

属性值

ManagedClusterOidcIssuerProfile

podIdentityProfile

有关 AAD Pod 标识集成的详细信息，请参阅使用 AAD Pod 标识。

podIdentityProfile?: ManagedClusterPodIdentityProfile

属性值

ManagedClusterPodIdentityProfile

powerState

群集的电源状态。注意：此属性不会序列化。它只能由服务器填充。

powerState?: PowerState

属性值

PowerState

privateFqdn

专用群集的 FQDN。注意：此属性不会序列化。它只能由服务器填充。

privateFqdn?: string

属性值

string

privateLinkResources

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

privateLinkResources?: PrivateLinkResource[]

属性值

PrivateLinkResource[]

provisioningState

当前预配状态。注意：此属性不会序列化。它只能由服务器填充。

provisioningState?: string

属性值

string

publicNetworkAccess

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

publicNetworkAccess?: string

属性值

string

resourceUID

resourceUID 唯一标识重复使用 ARM ResourceIds 的 ManagedCluster（即：create、delete、create sequence）注意：此属性不会序列化。它只能由服务器填充。

resourceUID?: string

属性值

string

securityProfile

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

securityProfile?: ManagedClusterSecurityProfile

属性值

ManagedClusterSecurityProfile

serviceMeshProfile

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

serviceMeshProfile?: ServiceMeshProfile

属性值

ServiceMeshProfile

servicePrincipalProfile

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

servicePrincipalProfile?: ManagedClusterServicePrincipalProfile

属性值

ManagedClusterServicePrincipalProfile

sku

托管群集 SKU。

sku?: ManagedClusterSKU

属性值

ManagedClusterSKU

storageProfile

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

storageProfile?: ManagedClusterStorageProfile

属性值

ManagedClusterStorageProfile

supportPlan

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

supportPlan?: string

属性值

string

upgradeSettings

用于升级群集的设置。

upgradeSettings?: ClusterUpgradeSettings

属性值

ClusterUpgradeSettings

windowsProfile

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

windowsProfile?: ManagedClusterWindowsProfile

属性值

ManagedClusterWindowsProfile

workloadAutoScalerProfile

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

workloadAutoScalerProfile?: ManagedClusterWorkloadAutoScalerProfile

属性值

ManagedClusterWorkloadAutoScalerProfile

继承属性详细信息

id

资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。它只能由服务器填充。

id?: string

属性值

string

继承自TrackedResource.id 的

location

资源所在的地理位置

location: string

属性值

string

继承自TrackedResource.location

name

资源说明的名称：此属性不会序列化。它只能由服务器填充。

name?: string

属性值

string

继承自TrackedResource.name 的

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。注意：此属性不会序列化。它只能由服务器填充。

systemData?: SystemData

属性值

SystemData

继承自TrackedResource.systemData

type

资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。它只能由服务器填充。

type?: string

属性值

string

继承自TrackedResource.type

通过

ManagedCluster interface

属性

继承属性

属性详细信息

aadProfile

属性值

addonProfiles

属性值

agentPoolProfiles

属性值

apiServerAccessProfile

属性值

autoScalerProfile

属性值

autoUpgradeProfile

属性值

azureMonitorProfile

属性值

azurePortalFqdn

属性值

currentKubernetesVersion

属性值

disableLocalAccounts

属性值

diskEncryptionSetID

属性值

dnsPrefix

属性值

enablePodSecurityPolicy

属性值

enableRbac

属性值

eTag

属性值

extendedLocation

属性值

fqdn

属性值

fqdnSubdomain

属性值

httpProxyConfig

属性值

identity

属性值

identityProfile

属性值

ingressProfile

属性值

kubernetesVersion

属性值

linuxProfile

属性值

maxAgentPools

属性值

metricsProfile

属性值

networkProfile

属性值

nodeResourceGroup

属性值

nodeResourceGroupProfile

属性值

oidcIssuerProfile

属性值

podIdentityProfile

属性值

powerState

属性值

privateFqdn

属性值

privateLinkResources

属性值

provisioningState

属性值

publicNetworkAccess

属性值

resourceUID

属性值

securityProfile