ManagedCluster interface

套件:

@azure/arm-containerservice

受控叢集。

Extends

TrackedResource

屬性

aadProfile	Azure Active Directory 組態。
addonProfiles	受控叢集附加元件配置檔。
agentPoolProfiles	代理程式集區屬性。
apiServerAccessProfile	受控叢集 API 伺服器的存取設定檔。
autoScalerProfile	啟用時要套用至叢集自動調整程序的參數
autoUpgradeProfile	自動升級組態。
azureMonitorProfile	用來監視受控叢集的 Azure 監視器附加元件配置檔。
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 安全策略 （預覽）。 PodSecurityPolicy 在 Kubernetes v1.21 中已被取代，並在 v1.25 中從 Kubernetes 中移除。 在 https://aka.ms/k8s/psp 和 https://aka.ms/aks/psp深入瞭解。
enableRbac	是否啟用 Kubernetes Role-Based 訪問控制。
extendedLocation	虛擬機的擴充位置。
fqdn	主要集區的 FQDN。 注意：這個屬性不會串行化。 它只能由伺服器填入。
fqdnSubdomain	建立受控叢集之後，就無法更新此專案。
httpProxyConfig	使用 HTTP Proxy 伺服器布建叢集的組態。
identity	如果已設定，則為受控叢集的身分識別。
identityProfile	與叢集相關聯的身分識別。
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	包含代理程式集區節點的資源群組名稱。
oidcIssuerProfile	受控叢集的 OIDC 簽發者配置檔。
podIdentityProfile	如需 AAD Pod 身分識別整合的詳細資訊，請參閱 使用 AAD Pod 身分識別。
powerState	叢集的電源狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
privateFqdn	私人叢集的 FQDN。 注意：這個屬性不會串行化。 它只能由伺服器填入。
privateLinkResources	與叢集相關聯的私人鏈接資源。
provisioningState	目前的布建狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
publicNetworkAccess	允許或拒絕 AKS 的公用網路存取
resourceUID	resourceUID 可唯一識別重複使用 ARM ResourceIds 的 ManagedClusters （例如：建立、刪除、建立順序）注意：此屬性將不會串行化。 它只能由伺服器填入。
securityProfile	受控叢集的安全性配置檔。
serviceMeshProfile	受控叢集的服務網格配置檔。
servicePrincipalProfile	叢集用來操作 Azure API 的服務主體身分識別相關信息。
sku	受控叢集 SKU。
storageProfile	受控叢集的記憶體配置檔。
supportPlan	受控叢集的支持計劃。 如果未指定，則預設值為 『KubernetesOfficial』。
upgradeSettings	升級叢集的設定。
windowsProfile	受控叢集中 Windows VM 的配置檔。
workloadAutoScalerProfile	受控叢集的工作負載自動調整程式配置檔。

繼承的屬性

id	資源的完整資源標識碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” 附注：此屬性將不會串行化。 它只能由伺服器填入。
location	資源所在的地理位置
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
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 監視器附加元件配置檔。

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 安全策略 （預覽）。 PodSecurityPolicy 在 Kubernetes v1.21 中已被取代，並在 v1.25 中從 Kubernetes 中移除。 在 https://aka.ms/k8s/psp 和 https://aka.ms/aks/psp深入瞭解。

enablePodSecurityPolicy?: boolean

屬性值

boolean

enableRbac

是否啟用 Kubernetes Role-Based 訪問控制。

enableRbac?: boolean

屬性值

boolean

extendedLocation

虛擬機的擴充位置。

extendedLocation?: ExtendedLocation

屬性值

ExtendedLocation

fqdn

主要集區的 FQDN。 注意：這個屬性不會串行化。 它只能由伺服器填入。

fqdn?: string

屬性值

string

fqdnSubdomain

建立受控叢集之後，就無法更新此專案。

fqdnSubdomain?: string

屬性值

string

httpProxyConfig

使用 HTTP Proxy 伺服器布建叢集的組態。

httpProxyConfig?: ManagedClusterHttpProxyConfig

屬性值

ManagedClusterHttpProxyConfig

identity

如果已設定，則為受控叢集的身分識別。

identity?: ManagedClusterIdentity

屬性值

ManagedClusterIdentity

identityProfile

與叢集相關聯的身分識別。

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

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 的 ManagedClusters （例如：建立、刪除、建立順序）注意：此屬性將不會串行化。 它只能由伺服器填入。

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

資源的完整資源標識碼。 例如“/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 Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

systemData?: SystemData

屬性值

SystemData

繼承自TrackedResource.systemData

tags

資源標籤。

tags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自TrackedResource.tags

type

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自TrackedResource.type