共用方式為


Managed Clusters - Get

取得受控叢集。

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

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

resourceName
path True

string

受控叢集資源的名稱。

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

subscriptionId
path True

string

uuid

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

要用於這項作業的 API 版本。

回應

名稱 類型 Description
200 OK

ManagedCluster

還行

Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
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"
      }
    }
  }
}

定義

名稱 Description
AdvancedNetworking

在叢集上啟用可檢視性和安全性功能套件的進階網路配置檔。 如需詳細資訊,請參閱 aka.ms/aksadvancednetworking。

AdvancedNetworkingObservability

可檢視性配置檔,可啟用具有歷程記錄內容的進階網路計量和流量記錄。

AdvancedNetworkingSecurity

安全性配置檔,以在 cilium 型叢集上啟用安全性功能。

AgentPoolMode

代理程式集區的模式。

AgentPoolNetworkProfile

代理程式集區的網路設定。

AgentPoolSecurityProfile

代理程式集區的安全性設定。

AgentPoolType

Agent 集區的類型。

AgentPoolUpgradeSettings

升級代理程式集池的設定

AgentPoolWindowsProfile

Windows 代理程式集區的特定配置檔。

AutoScalerProfile

啟用時要套用至叢集自動調整程序的參數

AzureKeyVaultKms

安全性配置檔的 Azure Key Vault 金鑰管理服務設定。

BackendPoolType

受控輸入Load Balancer 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 Service Mesh 證書頒發機構單位 (CA) 組態。 目前,我們僅支援外掛程式憑證,如這裡所述 https://aka.ms/asm-plugin-ca

IstioComponents

Istio 元件設定。

IstioEgressGateway

Istio 輸出閘道組態。

IstioIngressGateway

Istio 輸入閘道組態。 目前,我們最多支援一個名為 aks-istio-ingressgateway-external 的外部輸入閘道,以及一個名為 aks-istio-ingressgateway-internal的內部輸入閘道。

IstioIngressGatewayMode

輸入閘道的模式。

IstioPluginCertificateAuthority

Service Mesh 的外掛程式憑證資訊。

IstioServiceMesh

Istio 服務網格設定。

KeyVaultNetworkAccessTypes

金鑰保存庫的網路存取

KubeletConfig

代理程序節點的 Kubelet 組態。

KubeletDiskType

決定 emptyDir 磁碟區、容器運行時間數據根目錄和 Kubelet 暫時記憶體的位置。

KubernetesSupportPlan

AKS 受控叢集的不同支持層

licenseType

要用於 Windows VM 的授權類型。 如需詳細資訊,請參閱 Azure Hybrid User Benefits

LinuxOSConfig

Linux 代理程序節點的 OS 組態。

loadBalancerSku

受控叢集的負載平衡器 SKU。

ManagedCluster

受控叢集。

ManagedClusterAADProfile

AADProfile 會指定 Azure Active Directory 整合的屬性。

ManagedClusterAddonProfile

受控叢集的 Kubernetes 附加元件配置檔。

ManagedClusterAgentPoolProfile

容器服務代理程式集區的配置檔。

ManagedClusterAPIServerAccessProfile

受控叢集 API 伺服器的存取設定檔。

ManagedClusterAutoUpgradeProfile

受控叢集的自動升級配置檔。

ManagedClusterAzureMonitorProfile

用來監視受控叢集的 Azure 監視器附加元件配置檔。

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure 受控 Prometheus 附加元件 Kube 狀態計量配置檔。 這些選擇性設定適用於使用附加元件部署的 kube-state-metrics Pod。 如需詳細資訊,請參閱 aka.ms/AzureManagedPrometheus-optional-parameters。

ManagedClusterAzureMonitorProfileMetrics

適用於 Prometheus 附加元件之 Azure 監視器受控服務的計量配置檔。 收集現用的 Kubernetes 基礎結構計量,以傳送至 Azure 監視器工作區,併為自定義目標設定額外的擷取。 如需概觀,請參閱 aka.ms/AzureManagedPrometheus。

ManagedClusterCostAnalysis

叢集的成本分析組態

ManagedClusterHTTPProxyConfig

叢集 HTTP Proxy 設定。

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

套用至叢集節點資源群組的限制層級。 如果未指定,預設值為 'Unrestricted'

ScaleDownMode

描述如何將 VM 新增至代理程式集區或從代理程式集區中移除。 請參閱計費狀態。

ScaleSetEvictionPolicy

虛擬機擴展集收回原則。

ScaleSetPriority

虛擬機擴展集優先順序。

ServiceMeshMode

服務網格的模式。

ServiceMeshProfile

受控叢集的服務網格配置檔。

SysctlConfig

Linux 代理程序節點的 Sysctl 設定。

systemData

與建立和上次修改資源相關的元數據。

upgradeChannel

自動升級的升級通道。 預設值為 『none』。

UpgradeOverrideSettings

升級叢集時覆寫的設定。

UserAssignedIdentities

與受控叢集相關聯的使用者身分識別。 此身分識別將用於控制平面。 只允許一個使用者指派的身分識別。

UserAssignedIdentity

使用者指派身分識別的詳細數據。

WindowsGmsaProfile

受控叢集中的 Windows gMSA 配置檔。

WorkloadRuntime

決定節點可執行的工作負載類型。

AdvancedNetworking

在叢集上啟用可檢視性和安全性功能套件的進階網路配置檔。 如需詳細資訊,請參閱 aka.ms/aksadvancednetworking。

名稱 類型 Description
enabled

boolean

表示啟用 AKS 叢集上可檢視性和安全性的進階網路功能。 當此設定為 true 時,除非明確停用,否則所有可檢視性和安全性功能都會設定為啟用。 如果未指定,則預設值為 false。

observability

AdvancedNetworkingObservability

可檢視性配置檔,可啟用具有歷程記錄內容的進階網路計量和流量記錄。

security

AdvancedNetworkingSecurity

安全性配置檔,以在 cilium 型叢集上啟用安全性功能。

AdvancedNetworkingObservability

可檢視性配置檔,可啟用具有歷程記錄內容的進階網路計量和流量記錄。

名稱 類型 Description
enabled

boolean

表示在叢集上啟用進階網路可檢視性功能。

AdvancedNetworkingSecurity

安全性配置檔,以在 cilium 型叢集上啟用安全性功能。

名稱 類型 Description
enabled

boolean

此功能可讓使用者根據 DNS (FQDN) 名稱來設定網路原則。 它只能在 cilium 型叢集上啟用。 如果未指定,則預設值為 false。

AgentPoolMode

代理程式集區的模式。

名稱 類型 Description
System

string

系統代理程式集區主要是用來裝載重要的系統 Pod,例如 CoreDNS 和 metrics-server。 系統代理程式集區 osType 必須是 Linux。 系統代理程式集區 VM SKU 必須至少有 2vCPU 和 4 GB 的記憶體。

User

string

使用者代理程式集區主要是用來裝載應用程式Pod。

AgentPoolNetworkProfile

代理程式集區的網路設定。

名稱 類型 Description
allowedHostPorts

PortRange[]

允許存取的埠範圍。 允許指定的範圍重疊。

applicationSecurityGroups

string[]

應用程式安全組的標識碼,代理程式集區會在建立時產生關聯。

nodePublicIPTags

IPTag[]

實例層級公用IP的IPTag。

AgentPoolSecurityProfile

代理程式集區的安全性設定。

名稱 類型 Description
enableSecureBoot

boolean

安全開機是受信任的啟動功能,可確保只有已簽署的作業系統和驅動程式才能開機。 如需詳細資訊,請參閱 aka.ms/aks/trustedlaunch。 如果未指定,則預設值為 false。

enableVTPM

boolean

vTPM 是受信任的啟動功能,用於設定節點上本機所保留密鑰和度量的專用安全保存庫。 如需詳細資訊,請參閱 aka.ms/aks/trustedlaunch。 如果未指定,則預設值為 false。

AgentPoolType

Agent 集區的類型。

名稱 類型 Description
AvailabilitySet

string

強烈建議不要使用此方式。

VirtualMachineScaleSets

string

建立虛擬機擴展集所支援的代理程式集區。

AgentPoolUpgradeSettings

升級代理程式集池的設定

名稱 類型 Description
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 代理程式集區的特定配置檔。

名稱 類型 Description
disableOutboundNat

boolean

是否要在 Windows 節點中停用輸出NAT
默認值為 false。 只有在叢集 outboundType 是 NAT 閘道,且 Windows 代理程式集區未啟用節點公用 IP 時,才能停用輸出 NAT。

AutoScalerProfile

啟用時要套用至叢集自動調整程序的參數

名稱 類型 Description
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。
針對高載/批次規模等案例,您不希望 CA 在 kubernetes 排程器排程所有 Pod 之前採取行動,您可以告訴 CA 在排程特定年齡之前忽略未排程的 Pod。 預設值為 『0s』。 值必須是整數,後面接著單位(秒的 's'、'm' 代表分鐘數、'h' 等。

ok-total-unready-count

string

允許的未讀取節點數目,不論 total-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 系統刪除具有 Pod 的節點(除了 DaemonSet 或鏡像 Pod 除外)
默認值為 true。

AzureKeyVaultKms

安全性配置檔的 Azure Key Vault 金鑰管理服務設定。

名稱 類型 預設值 Description
enabled

boolean

是否要啟用 Azure Key Vault 金鑰管理服務。 默認值為 false。

keyId

string

Azure Key Vault 金鑰的識別碼。 如需詳細資訊,請參閱 金鑰標識碼格式。 啟用 Azure Key Vault 金鑰管理服務時,此字段是必要的,而且必須是有效的密鑰標識碼。 停用 Azure Key Vault 金鑰管理服務時,請將字段保留空白。

keyVaultNetworkAccess

KeyVaultNetworkAccessTypes

Public

金鑰保存庫的網路存取
金鑰保存庫的網路存取。 可能的值為 PublicPrivatePublic 表示金鑰保存庫允許來自所有網路的公用存取。 Private 表示金鑰保存庫會停用公用存取,並啟用私人連結。 預設值為 Public

keyVaultResourceId

string

金鑰保存庫的資源識別碼。 當keyVaultNetworkAccess Private時,此欄位是必要的,而且必須是有效的資源標識符。 當keyVaultNetworkAccess Public時,請將欄位保留空白。

BackendPoolType

受控輸入Load Balancer BackendPool的類型。

名稱 類型 Description
NodeIP

string

受控輸入Load Balancer BackendPool的類型。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend

NodeIPConfiguration

string

受控輸入Load Balancer BackendPool的類型。 https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend

CloudError

來自容器服務的錯誤回應。

名稱 類型 Description
error

CloudErrorBody

錯誤的詳細數據。

CloudErrorBody

來自容器服務的錯誤回應。

名稱 類型 Description
code

string

錯誤的識別碼。 程序代碼是不變的,而且是要以程序設計方式取用。

details

CloudErrorBody[]

錯誤的其他詳細數據清單。

message

string

描述錯誤的訊息,適用於在使用者介面中顯示。

target

string

特定錯誤的目標。 例如,錯誤中的屬性名稱。

ClusterUpgradeSettings

升級叢集的設定。

名稱 類型 Description
overrideSettings

UpgradeOverrideSettings

覆寫的設定。

code

告知叢集是否正在執行或已停止

名稱 類型 Description
Running

string

叢集正在執行。

Stopped

string

叢集已停止。

ContainerServiceLinuxProfile

容器服務叢集中Linux VM的配置檔。

名稱 類型 Description
adminUsername

string

要用於 Linux VM 的系統管理員用戶名稱。

ssh

ContainerServiceSshConfiguration

在 Azure 上執行的 Linux 型 VM 的 SSH 組態。

ContainerServiceNetworkProfile

網路組態的配置檔。

名稱 類型 預設值 Description
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 Load Balancer 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[]

要從中指派 Pod IP 的 CIDR 表示法IP範圍。
單一堆棧網路應該會有一個 IPv4 CIDR。 兩個 CIDR,每個 IP 系列一個 (IPv4/IPv6),預期雙堆棧網路。

serviceCidr

string

10.0.0.0/16

要從中指派服務叢集IP的CIDR表示法IP範圍。 它不得與任何子網IP範圍重疊。

serviceCidrs

string[]

要從中指派服務叢集IP的CIDR表示法IP範圍。
單一堆棧網路應該會有一個 IPv4 CIDR。 兩個 CIDR,每個 IP 系列一個 (IPv4/IPv6),預期雙堆棧網路。 它們不得與任何子網IP範圍重疊。

ContainerServiceSshConfiguration

在 Azure 上執行的 Linux 型 VM 的 SSH 組態。

名稱 類型 Description
publicKeys

ContainerServiceSshPublicKey[]

用來向Linux型VM進行驗證的SSH公鑰清單。 最多可以指定1個索引鍵。

ContainerServiceSshPublicKey

包含 SSH 憑證公鑰數據的相關信息。

名稱 類型 Description
keyData

string

用來透過 SSH 向 VM 進行驗證的憑證公鑰。 憑證必須採用 PEM 格式,且不含標頭。

createdByType

建立資源的身分識別類型。

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

CreationData

從來源資源建立目標資源時所使用的數據。

名稱 類型 Description
sourceResourceId

string

這是要用來建立目標物件的來源物件的 ARM 識別碼。

DelegatedResource

委派的資源屬性 - 僅供內部使用。

名稱 類型 Description
location

string

來源資源位置 - 僅供內部使用。

referralResource

string

轉介委派的委派標識碼 (選擇性) - 僅供內部使用。

resourceId

string

委派資源的 ARM 資源識別碼 - 僅供內部使用。

tenantId

string

委派資源的租用戶標識碼 - 僅供內部使用。

expander

相應增加時要使用的展開器

名稱 類型 Description
least-waste

string

選取在相應增加之後,將具有最少閑置 CPU 的節點群組(如果系結、未使用的記憶體)。 當您有不同類別的節點時,例如高 CPU 或高記憶體節點,而且只有在有需要大量這些資源的暫止 Pod 時,才想要擴充這些節點。

most-pods

string

選取可在相應增加時排程最多 Pod 的節點群組。 當您使用 nodeSelector 確保特定 Pod 落在特定節點上時,這會很有用。 請注意,這不會讓自動調整程序選取較大的節點與較小的節點,因為它可以同時新增多個較小的節點。

priority

string

選取具有使用者指派最高優先順序的節點群組。 如需詳細資訊,請參閱這裡的詳細數據

random

string

當您不需要節點群組以不同的方式進行調整時使用。

ExtendedLocation

擴充位置的複雜類型。

名稱 類型 Description
name

string

擴充位置的名稱。

type

ExtendedLocationTypes

擴充位置的類型。

ExtendedLocationTypes

擴充位置的類型。

名稱 類型 Description
EdgeZone

string

GPUInstanceProfile

要用來為支援的 GPU VM SKU 指定 GPU MIG 實例設定檔的 GPUInstanceProfile。

名稱 類型 Description
MIG1g

string

MIG2g

string

MIG3g

string

MIG4g

string

MIG7g

string

Identity

資源的身分識別。

名稱 類型 Description
principalId

string

資源識別的主要標識碼。 此值必須是 UUID。

tenantId

string

資源的租用戶標識碼。 此值必須是 UUID。

type

ResourceIdentityType

識別類型。

ipFamily

用來指定叢集可用IP版本的IP系列。

名稱 類型 Description
IPv4

string

IPv6

string

IPTag

包含與 對象相關聯的IPTag。

名稱 類型 Description
ipTagType

string

IP 標籤類型。 範例:RoutingPreference。

tag

string

與公用IP相關聯的IP標籤。 範例:因特網。

IstioCertificateAuthority

Istio Service Mesh 證書頒發機構單位 (CA) 組態。 目前,我們僅支援外掛程式憑證,如這裡所述 https://aka.ms/asm-plugin-ca

名稱 類型 Description
plugin

IstioPluginCertificateAuthority

Service Mesh 的外掛程式憑證資訊。

IstioComponents

Istio 元件設定。

名稱 類型 Description
egressGateways

IstioEgressGateway[]

Istio 輸出閘道。

ingressGateways

IstioIngressGateway[]

Istio 輸入閘道。

IstioEgressGateway

Istio 輸出閘道組態。

名稱 類型 Description
enabled

boolean

是否啟用輸出閘道。

IstioIngressGateway

Istio 輸入閘道組態。 目前,我們最多支援一個名為 aks-istio-ingressgateway-external 的外部輸入閘道,以及一個名為 aks-istio-ingressgateway-internal的內部輸入閘道。

名稱 類型 Description
enabled

boolean

是否要啟用輸入閘道。

mode

IstioIngressGatewayMode

輸入閘道的模式。

IstioIngressGatewayMode

輸入閘道的模式。

名稱 類型 Description
External

string

輸入閘道會指派公用IP位址,且可公開存取。

Internal

string

輸入閘道會指派內部IP位址,且無法公開存取。

IstioPluginCertificateAuthority

Service Mesh 的外掛程式憑證資訊。

名稱 類型 Description
certChainObjectName

string

Azure Key Vault 中的憑證鏈結物件名稱。

certObjectName

string

Azure Key Vault 中的中繼憑證物件名稱。

keyObjectName

string

Azure Key Vault 中的中繼憑證私鑰物件名稱。

keyVaultId

string

Key Vault 的資源標識碼。

rootCertObjectName

string

Azure Key Vault 中的跟證書物件名稱。

IstioServiceMesh

Istio 服務網格設定。

名稱 類型 Description
certificateAuthority

IstioCertificateAuthority

Istio Service Mesh 證書頒發機構單位 (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

金鑰保存庫的網路存取

名稱 類型 Description
Private

string

Public

string

KubeletConfig

代理程序節點的 Kubelet 組態。

名稱 類型 Description
allowedUnsafeSysctls

string[]

允許的不安全 sysctls 或 unsafe sysctl 模式清單(以 *結尾)。

containerLogMaxFiles

integer

容器可存在的容器記錄檔數目上限。 數字必須≥ 2。

containerLogMaxSizeMB

integer

容器記錄檔的大小上限(例如 10Mi)在輪替之前。

cpuCfsQuota

boolean

如果針對指定 CPU 限制的容器啟用 CPU CFS 配額強制執行。
默認值為 true。

cpuCfsQuotaPeriod

string

CPU CFS 配額期間值。
默認值為 『100 毫秒』。 有效值是具有選擇性分數和單位後綴的十進位數序列。 例如:『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 暫時記憶體的位置。

名稱 類型 Description
OS

string

Kubelet 會將 OS 磁碟用於其數據。

Temporary

string

Kubelet 會將其數據使用暫存磁碟。

KubernetesSupportPlan

AKS 受控叢集的不同支持層

名稱 類型 Description
AKSLongTermSupport

string

超過 KubernetesOfficial 支援 1 年的版本支援。 AKS 繼續修補 CVE 再 1 年,總共支援 2 年。

KubernetesOfficial

string

版本支援與開放原始碼 Kubernetes 供應專案相同。 正式 Kubernetes 開放原始碼社群在發行后 1 年支援版本。

licenseType

要用於 Windows VM 的授權類型。 如需詳細資訊,請參閱 Azure Hybrid User Benefits

名稱 類型 Description
None

string

不會套用其他授權。

Windows_Server

string

啟用適用於 Windows VM 的 Azure 混合式用戶權益。

LinuxOSConfig

Linux 代理程序節點的 OS 組態。

名稱 類型 Description
swapFileSizeMB

integer

將在每個節點上建立之交換檔案 MB 的大小。

sysctls

SysctlConfig

Linux 代理程序節點的 Sysctl 設定。

transparentHugePageDefrag

string

核心是否應該積極使用記憶體壓縮,讓更多的大量頁面可供使用。
有效值為 'always'、'defer'、'defer+madvise'、'madvise' 和 'never'。 默認值為 「瘋狂」。 如需詳細資訊,請參閱 Transparent Hugepages

transparentHugePageEnabled

string

是否啟用透明巨頁。
有效值為 『always』、『madvise』和 『never』。 默認值為 『always』。 如需詳細資訊,請參閱 Transparent Hugepages

loadBalancerSku

受控叢集的負載平衡器 SKU。

名稱 類型 Description
basic

string

使用具有有限功能的基本Load Balancer。

standard

string

使用標準Load Balancer。 這是建議的Load Balancer SKU。 如需在受控叢集中使用負載平衡器的詳細資訊,請參閱 標準Load Balancer 一文。

ManagedCluster

受控叢集。

名稱 類型 Description
eTag

string

用來實作開放式並行存取的唯一隻讀字串。 更新資源時,eTag 值將會變更。 針對後續要求指定 if-match 或 if-none-match 標頭,以針對後續要求指定 if-match 或 if-none-match 標頭,以根據一般 etag 慣例啟用開放式並行存取。

extendedLocation

ExtendedLocation

虛擬機的擴充位置。

id

string

資源的完整資源標識碼。 例如 “/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 監視器附加元件配置檔。

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

要用來啟用待用加密之磁碟加密的資源標識符。
這是格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'

properties.dnsPrefix

string

受控叢集的 DNS 前置詞。
建立受控叢集之後,就無法更新此專案。

properties.enablePodSecurityPolicy

boolean

(已淘汰)是否要啟用 Kubernetes Pod 安全策略 (預覽)。 PodSecurityPolicy 在 Kubernetes v1.21 中已被取代,並在 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 Proxy 伺服器布建叢集的組態。

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 ResourceIds 的 ManagedClusters(例如:建立、刪除、建立順序)

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 Resource Manager 元數據。

tags

object

資源標籤。

type

string

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

ManagedClusterAADProfile

AADProfile 會指定 Azure Active Directory 整合的屬性。

名稱 類型 Description
adminGroupObjectIDs

string[]

具有叢集管理員角色的 AAD 群組物件標識符清單。

clientAppID

string

(已淘汰)用戶端 AAD 應用程式識別碼。 在 https://aka.ms/aks/aad-legacy深入瞭解。

enableAzureRBAC

boolean

是否要啟用適用於 Kubernetes 授權的 Azure RBAC。

managed

boolean

是否要啟用受控 AAD。

serverAppID

string

(已淘汰)伺服器 AAD 應用程式識別碼。 在 https://aka.ms/aks/aad-legacy深入瞭解。

serverAppSecret

string

(已淘汰)伺服器 AAD 應用程式秘密。 在 https://aka.ms/aks/aad-legacy深入瞭解。

tenantID

string

要用於驗證的 AAD 租使用者識別碼。 如果未指定,將會使用部署訂用帳戶的租使用者。

ManagedClusterAddonProfile

受控叢集的 Kubernetes 附加元件配置檔。

名稱 類型 Description
config

object

用於設定附加元件的關鍵/值組。

enabled

boolean

是否啟用附加元件。

identity

Identity

此附加元件所使用的使用者指派身分識別資訊。

ManagedClusterAgentPoolProfile

容器服務代理程式集區的配置檔。

名稱 類型 預設值 Description
availabilityZones

string[]

要用於節點的可用性區域清單。 只有在 AgentPoolType 屬性是 'VirtualMachineScaleSets' 時,才能指定這個值。

capacityReservationGroupID

string

容量保留群組的完整資源標識符,可從保留的虛擬機群組提供虛擬機。
AKS 會將指定的代理程式集區與容量保留群組產生關聯。

count

integer

裝載 Docker 容器的代理程式 (VM) 數目。 允許的值必須介於使用者集區的 0 到 1000(含)範圍內,且系統集區的範圍為 1 到 1000(含)。 預設值為 1。

creationData

CreationData

如果節點集區將會使用快照集建立/升級,則用來指定來源快照集標識符的 CreationData。

currentOrchestratorVersion

string

Agent 集區正在執行的 Kubernetes 版本。
如果 orchestratorVersion 是 <major.minor.patch>的完整指定版本,則此字段會完全相等。 如果 orchestratorVersion <major.minor>,則此字段會包含使用的完整 <major.minor.patch> 版本。

eTag

string

用來實作開放式並行存取的唯一隻讀字串。 更新資源時,eTag 值將會變更。 針對後續要求指定 if-match 或 if-none-match 標頭,以針對後續要求指定 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

專用主機群組用來布建虛擬機的完整資源標識符,僅用於建立案例,且一旦設定后就不允許變更。
這是格式:/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前置詞標識碼。
格式如下:/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,則預設值為 「暫時」。 否則,預設為 「受控」。 建立之後可能不會變更。 如需詳細資訊,請參閱 暫時作業系統

osSKU

OSSKU

指定代理程式集區所使用的 OS SKU。 如果OSType為Linux,則預設值為Ubuntu。 當 Kubernetes <= 1.24 或 Windows2022 時,當 Kubernetes >= 1.25 如果 OSType 為 Windows,則預設值為 Windows2019。

osType

OSType

Linux

操作系統類型。 預設值為Linux。

podSubnetID

string

啟動時,Pod 會加入之子網的標識碼。
如果省略,則會在節點子網上靜態指派 Pod IP(如需詳細資訊,請參閱 vnetSubnetID)。 格式如下:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

powerState

PowerState

代理程式集區正在執行或停止。
第一次建立代理程式集區時,它一開始會執行。 您可以將此欄位設定為 [已停止] 來停止代理程式集區。 已停止的代理程式集區會停止其所有 VM,而不會產生計費費用。 只有在執行中且布建狀態為 [成功] 時,才能停止代理程式集區

provisioningState

string

目前的部署或布建狀態。

proximityPlacementGroupID

string

鄰近放置群組的標識碼。

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

Agent 集區的類型。

upgradeSettings

AgentPoolUpgradeSettings

升級代理程式集池的設定

vmSize

string

代理程式集區 VM 的大小。
VM 大小可用性會因區域而異。 如果節點包含計算資源不足(記憶體、cpu 等)Pod 可能無法正確執行。 如需受限制 VM 大小的詳細資訊,請參閱:https://docs.microsoft.com/azure/aks/quotas-skus-regions

vnetSubnetID

string

代理程式集區節點和選擇性 Pod 將在啟動時加入的子網標識碼。
如果未指定此專案,則會產生及使用 VNET 和子網。 如果未指定 podSubnetID,這會套用至節點和 Pod,否則只會套用至節點。 格式如下:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

windowsProfile

AgentPoolWindowsProfile

Windows 代理程式集區的特定配置檔。

workloadRuntime

WorkloadRuntime

決定節點可執行的工作負載類型。

ManagedClusterAPIServerAccessProfile

受控叢集 API 伺服器的存取設定檔。

名稱 類型 Description
authorizedIPRanges

string[]

授權存取 Kubernetes API 伺服器的 IP 範圍。
IP 範圍以 CIDR 格式指定,例如 137.117.106.88/29。 此功能與使用公用IP Per Node的叢集或使用基本Load Balancer的叢集不相容。 如需詳細資訊,請參閱API 伺服器授權的IP範圍。

disableRunCommand

boolean

是否要停用叢集的執行命令。

enablePrivateCluster

boolean

是否要將叢集建立為私人叢集。
如需詳細資訊,請參閱 建立私人 AKS 叢集

enablePrivateClusterPublicFQDN

boolean

是否要為私人叢集建立其他公用 FQDN。

privateDNSZone

string

叢集的私人 DNS 區域模式。
預設值為 System。 如需詳細資訊,請參閱 設定私人 DNS 區域。 允許的值為 'system' 和 'none'。

ManagedClusterAutoUpgradeProfile

受控叢集的自動升級配置檔。

名稱 類型 Description
nodeOSUpgradeChannel

nodeOSUpgradeChannel

節點OS升級通道
更新節點上OS的方式。 預設值為 NodeImage。

upgradeChannel

upgradeChannel

自動升級的升級通道。 預設值為 『none』。
如需詳細資訊,請參閱 設定 AKS 叢集自動升級通道

ManagedClusterAzureMonitorProfile

用來監視受控叢集的 Azure 監視器附加元件配置檔。

名稱 類型 Description
metrics

ManagedClusterAzureMonitorProfileMetrics

適用於 Prometheus 附加元件之 Azure 監視器受控服務的計量配置檔。 收集現用的 Kubernetes 基礎結構計量,以傳送至 Azure 監視器工作區,併為自定義目標設定額外的擷取。 如需概觀,請參閱 aka.ms/AzureManagedPrometheus。

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure 受控 Prometheus 附加元件 Kube 狀態計量配置檔。 這些選擇性設定適用於使用附加元件部署的 kube-state-metrics Pod。 如需詳細資訊,請參閱 aka.ms/AzureManagedPrometheus-optional-parameters。

名稱 類型 Description
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 監視器受控服務的計量配置檔。 收集現用的 Kubernetes 基礎結構計量,以傳送至 Azure 監視器工作區,併為自定義目標設定額外的擷取。 如需概觀,請參閱 aka.ms/AzureManagedPrometheus。

名稱 類型 Description
enabled

boolean

是否要啟用或停用 Prometheus 監視的 Azure Managed Prometheus 附加元件。 如需啟用和停用的詳細資訊,請參閱 aka.ms/AzureManagedPrometheus-aks-enable。

kubeStateMetrics

ManagedClusterAzureMonitorProfileKubeStateMetrics

Azure 受控 Prometheus 附加元件 Kube 狀態計量配置檔。 這些選擇性設定適用於使用附加元件部署的 kube-state-metrics Pod。 如需詳細資訊,請參閱 aka.ms/AzureManagedPrometheus-optional-parameters。

ManagedClusterCostAnalysis

叢集的成本分析組態

名稱 類型 Description
enabled

boolean

是否要啟用成本分析
受控叢集 sku.tier 必須設定為 「標準」或「進階」,才能啟用此功能。 啟用此選項會將 Kubernetes 命名空間和部署詳細資料新增至 Azure 入口網站中的成本分析檢視。 如果未指定,則預設值為 false。 如需詳細資訊,請參閱 aka.ms/aks/docs/cost-analysis。

ManagedClusterHTTPProxyConfig

叢集 HTTP Proxy 設定。

名稱 類型 Description
httpProxy

string

要使用的 HTTP Proxy 伺服器端點。

httpsProxy

string

要使用的 HTTPS Proxy 伺服器端點。

noProxy

string[]

不應該通過 Proxy 的端點。

trustedCa

string

用來連線到 Proxy 伺服器的替代 CA 憑證。

ManagedClusterIdentity

受控叢集的身分識別。

名稱 類型 Description
delegatedResources

<string,  DelegatedResource>

指派給此受控叢集的委派身分識別資源。 這隻能由另一個 Azure 資源提供者設定,受控叢集只接受一個委派的身分識別資源。 僅限內部使用。

principalId

string

主要元件所使用的系統指派身分識別主體標識碼。

tenantId

string

主要元件所使用的系統指派身分識別的租用戶標識碼。

type

ResourceIdentityType

用於受控叢集的身分識別類型。
如需詳細資訊,請參閱在 AKS中使用受控識別

userAssignedIdentities

UserAssignedIdentities

與受控叢集相關聯的使用者身分識別。 此身分識別將用於控制平面。 只允許一個使用者指派的身分識別。
密鑰必須是 ARM 資源識別符,格式為:『/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

ManagedClusterIngressProfile

容器服務叢集的輸入配置檔。

名稱 類型 Description
webAppRouting

ManagedClusterIngressProfileWebAppRouting

輸入設定檔的應用程式路由設定。 您可以在 https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default找到這項功能的概觀和上線指南。

ManagedClusterIngressProfileWebAppRouting

輸入配置檔的應用程式路由附加元件設定。

名稱 類型 Description
dnsZoneResourceIds

string[]

要與應用程式路由附加元件相關聯的 DNS 區域資源識別碼。 只有在啟用應用程式路由附加元件時才使用。 公用和私人 DNS 區域可以位於不同的資源群組中,但所有公用 DNS 區域都必須位於相同的資源群組中,而且所有私人 DNS 區域都必須位於相同的資源群組中。

enabled

boolean

是否要啟用應用程式路由附加元件。

identity

UserAssignedIdentity

應用程式路由附加元件受控識別。 這是應授與許可權的身分識別,例如管理相關聯的 Azure DNS 資源,並從 Azure Key Vault 取得憑證。 如需詳細資訊,請參閱 此附加元件 概觀。

ManagedClusterLoadBalancerProfile

受控叢集負載平衡器的配置檔。

名稱 類型 預設值 Description
allocatedOutboundPorts

integer

0

每個 VM 所需配置的 SNAT 埠數目。 允許的值介於 0 到 64000 的範圍內(含)。 默認值為 0,這會導致 Azure 動態配置埠。

backendPoolType

BackendPoolType

NodeIPConfiguration

受控輸入Load Balancer BackendPool的類型。

effectiveOutboundIPs

ResourceReference[]

叢集負載平衡器的有效輸出IP資源。

enableMultipleStandardLoadBalancers

boolean

為每個 AKS 叢集啟用多個標準負載平衡器。

idleTimeoutInMinutes

integer

30

所需的輸出流程閑置逾時,以分鐘為單位。 允許的值介於 4 到 120 之間(含)。 預設值為30分鐘。

managedOutboundIPs

ManagedOutboundIPs

叢集負載平衡器所需的受控輸出IP。

outboundIPPrefixes

OutboundIPPrefixes

叢集負載平衡器所需的輸出 IP 前綴資源。

outboundIPs

OutboundIPs

叢集負載平衡器所需的輸出IP資源。

ManagedClusterManagedOutboundIPProfile

受控叢集的受控輸出IP資源配置檔。

名稱 類型 預設值 Description
count

integer

1

由 Azure 建立/ 管理的所需輸出 IP 數目。 允許的值必須介於 1 到 16 的範圍內(含)。 預設值為 1。

ManagedClusterMetricsProfile

ManagedCluster 的計量配置檔。

名稱 類型 Description
costAnalysis

ManagedClusterCostAnalysis

每個 Kubernetes 資源成本分析的詳細設定。
叢集的成本分析組態

ManagedClusterNATGatewayProfile

受控叢集 NAT 閘道的配置檔。

名稱 類型 預設值 Description
effectiveOutboundIPs

ResourceReference[]

叢集 NAT 閘道的有效輸出 IP 資源。

idleTimeoutInMinutes

integer

4

所需的輸出流程閑置逾時,以分鐘為單位。 允許的值介於 4 到 120 之間(含)。 預設值為 4 分鐘。

managedOutboundIPProfile

ManagedClusterManagedOutboundIPProfile

叢集 NAT 閘道的受控輸出 IP 資源設定檔。

ManagedClusterNodeResourceGroupProfile

受控叢集的節點資源群組鎖定配置檔。

名稱 類型 Description
restrictionLevel

RestrictionLevel

套用至叢集節點資源群組的限制層級。 如果未指定,預設值為 'Unrestricted'

ManagedClusterOIDCIssuerProfile

受控叢集的 OIDC 簽發者配置檔。

名稱 類型 Description
enabled

boolean

是否啟用 OIDC 簽發者。

issuerURL

string

受控叢集的 OIDC 簽發者 URL。

ManagedClusterPodIdentity

指派給受控叢集之 Pod 身分識別的詳細數據。

名稱 類型 Description
bindingSelector

string

要用於 AzureIdentityBinding 資源的系結選取器。

identity

UserAssignedIdentity

使用者指派的身分識別詳細數據。

name

string

Pod 身分識別的名稱。

namespace

string

Pod 身分識別的命名空間。

provisioningInfo

ProvisioningInfo

provisioningState

ManagedClusterPodIdentityProvisioningState

Pod 身分識別的目前布建狀態。

ManagedClusterPodIdentityException

Pod 身分識別例外狀況,可讓具有特定標籤的 Pod 存取 Azure 實例元數據服務 (IMDS) 端點,而不會遭到節點受控識別 (NMI) 伺服器攔截。

名稱 類型 Description
name

string

Pod 身分識別例外狀況的名稱。

namespace

string

Pod 身分識別例外狀況的命名空間。

podLabels

object

要比對的 Pod 標籤。

ManagedClusterPodIdentityProfile

受控叢集的Pod身分識別配置檔。

名稱 類型 Description
allowNetworkPluginKubenet

boolean

是否允許Pod身分識別在具有 Kubenet 網路的叢集上執行。
根據預設,在 Kubenet 中執行會因為 AAD Pod 身分識別的安全性相關本質和 IP 詐騙的風險而停用。 如需詳細資訊,請參閱搭配 AAD Pod 身分識別 使用 Kubenet 網路外掛程式

enabled

boolean

是否啟用Pod身分識別附加元件。

userAssignedIdentities

ManagedClusterPodIdentity[]

叢集中要使用的Pod身分識別。

userAssignedIdentityExceptions

ManagedClusterPodIdentityException[]

允許的Pod身分識別例外狀況。

ManagedClusterPodIdentityProvisioningError

Pod 身分識別布建的錯誤回應。

名稱 類型 Description
error

ManagedClusterPodIdentityProvisioningErrorBody

錯誤的詳細數據。

ManagedClusterPodIdentityProvisioningErrorBody

Pod 身分識別布建的錯誤回應。

名稱 類型 Description
code

string

錯誤的識別碼。 程序代碼是不變的,而且是要以程序設計方式取用。

details

ManagedClusterPodIdentityProvisioningErrorBody[]

錯誤的其他詳細數據清單。

message

string

描述錯誤的訊息,適用於在使用者介面中顯示。

target

string

特定錯誤的目標。 例如,錯誤中的屬性名稱。

ManagedClusterPodIdentityProvisioningState

Pod 身分識別的目前布建狀態。

名稱 類型 Description
Assigned

string

Canceled

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ManagedClusterSecurityProfile

容器服務叢集的安全性配置檔。

名稱 類型 Description
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 設定。

名稱 類型 Description
logAnalyticsWorkspaceResourceId

string

要與 Microsoft Defender 相關聯的 Log Analytics 工作區資源識別符。 啟用 Microsoft Defender 時,此字位是必要的,而且必須是有效的工作區資源識別符。 停用 Microsoft Defender 時,請將字段保留空白。

securityMonitoring

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft適用於安全性配置檔之雲端設定的 Defender 威脅偵測。

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft安全性配置文件威脅偵測的 Defender 設定。

名稱 類型 Description
enabled

boolean

是否啟用Defender威脅偵測

ManagedClusterSecurityProfileImageCleaner

影像清除工具會從節點移除未使用的映像、釋放磁碟空間,並協助減少受攻擊面區域。 以下是安全性配置檔的設定。

名稱 類型 Description
enabled

boolean

是否要在 AKS 叢集上啟用影像清除器。

intervalHours

integer

影像清除程序掃描間隔以小時為單位。

ManagedClusterSecurityProfileWorkloadIdentity

安全性配置檔的工作負載身分識別設定。

名稱 類型 Description
enabled

boolean

是否要啟用工作負載身分識別。

ManagedClusterServicePrincipalProfile

叢集用來操作 Azure API 的服務主體身分識別相關信息。

名稱 類型 Description
clientId

string

服務主體的標識碼。

secret

string

純文本中與服務主體相關聯的秘密密碼。

ManagedClusterSKU

受控叢集的SKU。

名稱 類型 Description
name

ManagedClusterSKUName

受控叢集 SKU 的名稱。

tier

ManagedClusterSKUTier

受控叢集 SKU 的層。
如果未指定,則預設值為 『Free』。 如需詳細資訊,請參閱 AKS 定價層

ManagedClusterSKUName

受控叢集 SKU 的名稱。

名稱 類型 Description
Base

string

AKS 控制平面的基底選項。

ManagedClusterSKUTier

受控叢集 SKU 的層。

名稱 類型 Description
Free

string

叢集管理是免費的,但需支付 VM、記憶體和網路使用量的費用。 最適合用於實驗、學習、簡單測試或少於10個節點的工作負載。 不建議用於生產使用案例。

Premium

string

叢集除了「標準」中包含的所有功能之外,還有進階功能。 Premium 可讓您針對特定 Kubernetes 版本選擇 LongTermSupport (aka.ms/aks/lts)。

Standard

string

建議用於任務關鍵性與生產工作負載。 包含 Kubernetes 控制平面自動調整、工作負載密集測試,以及每個叢集最多 5,000 個節點。 為未使用可用性區域的叢集保證 99.95% Kubernetes API 伺服器端點的可用性,以及 99.9% 可用性。

ManagedClusterStorageProfile

容器服務叢集的記憶體配置檔。

名稱 類型 Description
blobCSIDriver

ManagedClusterStorageProfileBlobCSIDriver

記憶體配置檔的 AzureBlob CSI 驅動程式設定。

diskCSIDriver

ManagedClusterStorageProfileDiskCSIDriver

記憶體配置檔的 AzureDisk CSI 驅動程式設定。

fileCSIDriver

ManagedClusterStorageProfileFileCSIDriver

記憶體配置檔的 AzureFile CSI 驅動程式設定。

snapshotController

ManagedClusterStorageProfileSnapshotController

記憶體配置檔的快照集控制器設定。

ManagedClusterStorageProfileBlobCSIDriver

記憶體配置檔的 AzureBlob CSI 驅動程式設定。

名稱 類型 Description
enabled

boolean

是否要啟用 AzureBlob CSI 驅動程式。 默認值為 false。

ManagedClusterStorageProfileDiskCSIDriver

記憶體配置檔的 AzureDisk CSI 驅動程式設定。

名稱 類型 Description
enabled

boolean

是否要啟用 AzureDisk CSI 驅動程式。 默認值為 true。

ManagedClusterStorageProfileFileCSIDriver

記憶體配置檔的 AzureFile CSI 驅動程式設定。

名稱 類型 Description
enabled

boolean

是否要啟用 AzureFile CSI 驅動程式。 默認值為 true。

ManagedClusterStorageProfileSnapshotController

記憶體配置檔的快照集控制器設定。

名稱 類型 Description
enabled

boolean

是否要啟用快照控制器。 默認值為 true。

ManagedClusterWindowsProfile

受控叢集中 Windows VM 的配置檔。

名稱 類型 Description
adminPassword

string

指定系統管理員帳戶的密碼。

長度下限: 8 個字元

長度上限: 123 個字元

複雜性需求:需要滿足下列 4 個條件中的 3 個
字元較低
具有大字元
具有數位
具有特殊字元 (Regex match [\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 Proxy。
如需 CSI Proxy 的詳細資訊,請參閱 CSI Proxy GitHub 存放庫

gmsaProfile

WindowsGmsaProfile

受控叢集中的 Windows gMSA 配置檔。

licenseType

licenseType

要用於 Windows VM 的授權類型。 如需詳細資訊,請參閱 Azure Hybrid User Benefits

ManagedClusterWorkloadAutoScalerProfile

受控叢集的工作負載自動調整程式配置檔。

名稱 類型 Description
keda

ManagedClusterWorkloadAutoScalerProfileKeda

適用於工作負載自動調整程式配置檔的KEDA (Kubernetes 事件驅動自動調整) 設定。

verticalPodAutoscaler

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

工作負載自動調整程式設定檔的 VPA (垂直 Pod 自動調整程式) 設定。

ManagedClusterWorkloadAutoScalerProfileKeda

適用於工作負載自動調整程式配置檔的KEDA (Kubernetes 事件驅動自動調整) 設定。

名稱 類型 Description
enabled

boolean

是否要啟用 KEDA。

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

工作負載自動調整程式設定檔的 VPA (垂直 Pod 自動調整程式) 設定。

名稱 類型 預設值 Description
enabled

boolean

False

是否要啟用 VPA。 默認值為 false。

ManagedOutboundIPs

叢集負載平衡器所需的受控輸出IP。

名稱 類型 預設值 Description
count

integer

1

叢集負載平衡器所建立/管理的所需 IPv4 輸出IP數目。 允許的值必須介於 1 到 100 的範圍內(含)。 預設值為 1。

countIPv6

integer

0

叢集負載平衡器所建立/管理的所需 IPv6 輸出IP數目。 允許的值必須介於 1 到 100 的範圍內(含)。 單一堆棧的預設值為0,雙堆疊的預設值為1。

networkDataplane

Kubernetes 叢集中所使用的網路數據平面。

名稱 類型 Description
azure

string

使用 Azure 網路數據平面。

cilium

string

使用 Cilium 網路數據平面。 如需詳細資訊,請參閱 Azure CNI Powered by Cilium

networkMode

Azure CNI 的網路模式已設定為 。

名稱 類型 Description
bridge

string

不再支援此設定

transparent

string

未建立任何網橋。 Intra-VM Pod 到 Pod 通訊是透過 Azure CNI 所建立的 IP 路由。 如需詳細資訊,請參閱 透明模式

NetworkPlugin

用於建置 Kubernetes 網路的網路外掛程式。

名稱 類型 Description
azure

string

使用 Azure CNI 網路外掛程式。 如需詳細資訊,請參閱 Azure CNI(進階)網路

kubenet

string

使用 Kubenet 網路外掛程式。 如需詳細資訊,請參閱 Kubenet (基本) 網路

none

string

未預安裝任何 CNI 外掛程式。 如需詳細資訊,請參閱 BYO CNI

NetworkPluginMode

網路外掛程式應該使用的模式。

名稱 類型 Description
overlay

string

與 networkPlugin=azure 搭配使用,Pod 會從 PodCIDR 位址空間獲得 IP,但使用 Azure 路由網域,而不是 Kubenet 的路由表方法。 如需詳細資訊,請造訪 https://aka.ms/aks/azure-cni-overlay

NetworkPolicy

用於建置 Kubernetes 網路的網路原則。

名稱 類型 Description
azure

string

使用 Azure 網路原則。 如需詳細資訊,請參閱 azure 和 Calico 原則 之間的 差異。

calico

string

使用 Calico 網路原則。 如需詳細資訊,請參閱 azure 和 Calico 原則 之間的 差異。

cilium

string

使用 Cilium 強制執行網路原則。 這需要 networkDataplane 為 『cilium』。

none

string

不會強制執行網路原則。 未指定 NetworkPolicy 時,這是預設值。

nodeOSUpgradeChannel

節點OS升級通道

名稱 類型 Description
NodeImage

string

AKS 會以新修補的 VHD 更新節點,其中包含每周的安全性修正和錯誤修正。 使用 VHD 更新機器,將會在維護期間和激增設定之後,輪流重新映射至該 VHD。 選擇此選項作為 AKS 裝載映射時,不會產生額外的 VHD 成本。

None

string

操作系統或滾動 VHD 不會嘗試更新您的電腦 OS。 這表示您負責安全性更新

SecurityPatch

string

AKS 會使用測試的安全性更新來下載並更新節點。 這些更新會接受維護期間設定,併產生新的 VHD,以在新節點上使用。 在某些情況下,您無法就地套用更新,在這種情況下,現有的節點也會重新映像到新產生的 VHD,以套用變更。 此選項會產生在資源群組中裝載新安全性修補程式 VHD 的額外成本,以便及時取用。

Unmanaged

string

操作系統更新將透過OS內建修補基礎結構自動套用。 新調整的機器一開始將會取消修補,而且會由OS的基礎結構在某個時間點修補。 此選項的行為取決於有問題的OS。 Ubuntu 和 Mariner 會透過自動升級套用安全性修補程式,大約一天大約是 06:00 UTC。 Windows 不會自動套用安全性修補程式,因此此選項相當於 [無],直到進一步通知為止

OSDiskType

要用於代理程式集區中機器的 OS 磁碟類型。

名稱 類型 Description
Ephemeral

string

暫時 OS 磁碟只會儲存在主電腦上,就像暫存磁碟一樣。 這可提供較低的讀取/寫入延遲,以及更快的節點調整和叢集升級。

Managed

string

Azure 會將虛擬機的操作系統磁碟複寫至 Azure 記憶體,以避免數據遺失,如果 VM 需要重新放置至另一部主機。 由於容器並非設計為保存本機狀態,因此此行為會提供有限的值,同時提供一些缺點,包括較慢的節點布建和較高的讀取/寫入延遲。

OSSKU

指定代理程式集區所使用的 OS SKU。 如果OSType為Linux,則預設值為Ubuntu。 當 Kubernetes <= 1.24 或 Windows2022 時,當 Kubernetes >= 1.25 如果 OSType 為 Windows,則預設值為 Windows2019。

名稱 類型 Description
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。

名稱 類型 Description
Linux

string

使用 Linux。

Windows

string

使用 Windows。

OutboundIPPrefixes

叢集負載平衡器所需的輸出 IP 前綴資源。

名稱 類型 Description
publicIPPrefixes

ResourceReference[]

公用IP前置資源的清單。

OutboundIPs

叢集負載平衡器所需的輸出IP資源。

名稱 類型 Description
publicIPs

ResourceReference[]

公用IP資源的清單。

outboundType

輸出 (輸出) 路由方法。

名稱 類型 Description
loadBalancer

string

負載平衡器用於透過 AKS 指派的公用 IP 輸出。 這支援類型為 『loadBalancer』 的 Kubernetes 服務。 如需詳細資訊,請參閱 輸出類型 loadbalancer

managedNATGateway

string

AKS 管理的 NAT 閘道用於輸出。

userAssignedNATGateway

string

與叢集子網相關聯的使用者指派 NAT 閘道會用於輸出。 這是進階案例,需要適當的網路設定。

userDefinedRouting

string

輸出路徑必須由用戶定義。 這是進階案例,需要適當的網路設定。 如需詳細資訊,請參閱 輸出類型 userDefinedRouting

PortRange

埠範圍。

名稱 類型 Description
portEnd

integer

範圍中包含的最大埠。 它的範圍應從 1 到 65535,且大於或等於 portStart。

portStart

integer

範圍中包含的最小埠。 它的範圍應從 1 到 65535,且小於或等於 portEnd。

protocol

Protocol

埠的網路通訊協定。

PowerState

描述叢集的電源狀態

名稱 類型 Description
code

code

告知叢集是否正在執行或已停止

PrivateLinkResource

私人鏈接資源

名稱 類型 Description
groupId

string

資源的群組標識碼。

id

string

私人鏈接資源的識別碼。

name

string

私人鏈接資源的名稱。

privateLinkServiceID

string

資源的私人鏈接服務標識碼,此字段只會在內部公開給NRP。

requiredMembers

string[]

資源的 RequiredMembers

type

string

資源類型。

Protocol

埠的網路通訊協定。

名稱 類型 Description
TCP

string

TCP 通訊協定。

UDP

string

UDP 通訊協定。

ProvisioningInfo

名稱 類型 Description
error

ManagedClusterPodIdentityProvisioningError

Pod 身分識別指派錯誤(如果有的話)。

PublicNetworkAccess

managedCluster 的 PublicNetworkAccess

名稱 類型 Description
Disabled

string

Enabled

string

ResourceIdentityType

用於受控叢集的身分識別類型。

名稱 類型 Description
None

string

請勿使用受控叢集的受控識別,將會改用服務主體。

SystemAssigned

string

使用隱含建立的系統指派受控識別來管理叢集資源。 控制平面中的主要元件,例如 kube-controller-manager 會使用系統指派的受控識別來管理 Azure 資源。

UserAssigned

string

使用使用者指定的身分識別來管理叢集資源。 控制平面中的主要元件,例如 kube-controller-manager 會使用指定的使用者指派的受控識別來管理 Azure 資源。

ResourceReference

Azure 資源的參考。

名稱 類型 Description
id

string

完整 Azure 資源識別碼。

RestrictionLevel

套用至叢集節點資源群組的限制層級。 如果未指定,預設值為 'Unrestricted'

名稱 類型 Description
ReadOnly

string

僅限受控節點資源群組上允許的 */讀取 RBAC 許可權

Unrestricted

string

受控節點資源群組上允許所有 RBAC 許可權

ScaleDownMode

描述如何將 VM 新增至代理程式集區或從代理程式集區中移除。 請參閱計費狀態。

名稱 類型 Description
Deallocate

string

嘗試在相應增加期間啟動已解除分配的實例,並在相應減少期間解除分配實例。

Delete

string

在相應增加期間建立新的實例,並在相應減少期間移除實例。

ScaleSetEvictionPolicy

虛擬機擴展集收回原則。

名稱 類型 Description
Deallocate

string

節點集區基礎擴展集中的節點會在收回時設定為已停止解除分配的狀態。 針對計算配額,停止解除分配狀態計數中的節點,並可能導致叢集調整或升級的問題。

Delete

string

節點集區基礎擴展集中的節點會在收回時刪除。

ScaleSetPriority

虛擬機擴展集優先順序。

名稱 類型 Description
Regular

string

將會使用一般 VM。

Spot

string

將會使用現成優先順序 VM。 現成節點沒有 SLA。 如需詳細資訊,請參閱 AKS 上的 位置。

ServiceMeshMode

服務網格的模式。

名稱 類型 Description
Disabled

string

網格已停用。

Istio

string

Istio 部署為 AKS 附加元件。

ServiceMeshProfile

受控叢集的服務網格配置檔。

名稱 類型 Description
istio

IstioServiceMesh

Istio 服務網格設定。

mode

ServiceMeshMode

服務網格的模式。

SysctlConfig

Linux 代理程序節點的 Sysctl 設定。

名稱 類型 Description
fsAioMaxNr

integer

Sysctl 設定 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 設定 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

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳(UTC)。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。

upgradeChannel

自動升級的升級通道。 預設值為 『none』。

名稱 類型 Description
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

升級叢集時覆寫的設定。

名稱 類型 Description
forceUpgrade

boolean

是否要強制升級叢集。 請注意,此選項會指示升級作業略過升級保護,例如檢查已淘汰的 API 使用量。 請謹慎啟用此選項。

until

string

直到覆寫生效為止。 請注意,這隻會符合升級的開始時間,即使升級繼續 until 到期,升級的有效性也不會變更。 預設不會設定此欄位。 必須設定覆寫才會生效。

UserAssignedIdentities

與受控叢集相關聯的使用者身分識別。 此身分識別將用於控制平面。 只允許一個使用者指派的身分識別。

名稱 類型 Description

UserAssignedIdentity

使用者指派身分識別的詳細數據。

名稱 類型 Description
clientId

string

使用者指派身分識別的用戶端標識碼。

objectId

string

使用者指派身分識別的物件標識碼。

resourceId

string

使用者指派身分識別的資源標識碼。

WindowsGmsaProfile

受控叢集中的 Windows gMSA 配置檔。

名稱 類型 Description
dnsServer

string

指定 Windows gMSA 的 DNS 伺服器。

如果您已在用來建立受控叢集的 vnet 中設定 DNS 伺服器,請將它設定為空白。

enabled

boolean

是否要啟用 Windows gMSA。
指定是否要在受控叢集中啟用 Windows gMSA。

rootDomainName

string

指定 Windows gMSA 的根功能變數名稱。

如果您已在用來建立受控叢集的 vnet 中設定 DNS 伺服器,請將它設定為空白。

WorkloadRuntime

決定節點可執行的工作負載類型。

名稱 類型 Description
OCIContainer

string

節點會使用 Kubelet 來執行標準 OCI 容器工作負載。

WasmWasi

string

節點會使用 Krustlet 使用 WASI 提供者來執行 WASM 工作負載(預覽)。