ManagedClusterProperties interface
Properties of the managed cluster.
Properties
| aad |
The Azure Active Directory configuration. |
| addon |
The profile of managed cluster add-on. |
| agent |
The agent pool properties. |
| ai |
AI toolchain operator settings that apply to the whole cluster. |
| api |
The access profile for managed cluster API server. |
| auto |
Parameters to be applied to the cluster-autoscaler when enabled |
| auto |
The auto upgrade configuration. |
| azure |
Azure Monitor addon profiles for monitoring the managed cluster. |
| azure |
The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients. The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. |
| bootstrap |
Profile of the cluster bootstrap configuration. |
| creation |
CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot. |
| current |
The version of Kubernetes the Managed Cluster is running. If kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used. |
| disable |
If local accounts should be disabled on the Managed Cluster. If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts. |
| disk |
The Resource ID of the disk encryption set to use for enabling encryption at rest. This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' |
| dns |
The DNS prefix of the Managed Cluster. This cannot be updated once the Managed Cluster has been created. |
| enable |
Enable namespace as Azure resource. The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource. |
| enable |
Whether to enable Kubernetes Role-Based Access Control. |
| fqdn | The FQDN of the master pool. |
| fqdn |
The FQDN subdomain of the private cluster with custom private dns zone. This cannot be updated once the Managed Cluster has been created. |
| health |
Health monitor profile for the managed cluster. |
| hosted |
Settings for hosted system addons. For more information, see https://aka.ms/aks/automatic/systemcomponents. |
| http |
Configurations for provisioning the cluster with HTTP proxy servers. |
| identity |
The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
| ingress |
Ingress profile for the managed cluster. |
| kubernetes |
The version of Kubernetes specified by the user. Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details. |
| linux |
The profile for Linux VMs in the Managed Cluster. |
| max |
The max number of agent pools for the managed cluster. |
| metrics |
Optional cluster metrics configuration. |
| network |
The network configuration profile. |
| node |
Node provisioning settings that apply to the whole cluster. |
| node |
The name of the resource group containing agent pool nodes. |
| node |
Profile of the node resource group configuration. |
| oidc |
The OIDC issuer profile of the Managed Cluster. |
| pod |
The pod identity profile of the Managed Cluster. See use AAD pod identity for more details on AAD pod identity integration. |
| power |
The Power State of the cluster. |
| private |
The FQDN of private cluster. |
| private |
Private link resources associated with the cluster. |
| provisioning |
The current provisioning state. |
| public |
PublicNetworkAccess of the managedCluster. Allow or deny public network access for AKS |
| resourceUID | The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) |
| scheduler |
Profile of the pod scheduler configuration. |
| security |
Security profile for the managed cluster. |
| service |
Service mesh profile for a managed cluster. |
| service |
Information about a service principal identity for the cluster to use for manipulating Azure APIs. |
| status | Contains read-only information about the Managed Cluster. |
| storage |
Storage profile for the managed cluster. |
| support |
The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. |
| upgrade |
Settings for upgrading a cluster. |
| windows |
The profile for Windows VMs in the Managed Cluster. |
| workload |
Workload Auto-scaler profile for the managed cluster. |
Property Details
aadProfile
The Azure Active Directory configuration.
aadProfile?: ManagedClusterAADProfile
Property Value
addonProfiles
The profile of managed cluster add-on.
addonProfiles?: Record<string, ManagedClusterAddonProfile>
Property Value
Record<string, ManagedClusterAddonProfile>
agentPoolProfiles
The agent pool properties.
agentPoolProfiles?: ManagedClusterAgentPoolProfile[]
Property Value
aiToolchainOperatorProfile
AI toolchain operator settings that apply to the whole cluster.
aiToolchainOperatorProfile?: ManagedClusterAIToolchainOperatorProfile
Property Value
apiServerAccessProfile
The access profile for managed cluster API server.
apiServerAccessProfile?: ManagedClusterAPIServerAccessProfile
Property Value
autoScalerProfile
Parameters to be applied to the cluster-autoscaler when enabled
autoScalerProfile?: ManagedClusterPropertiesAutoScalerProfile
Property Value
autoUpgradeProfile
The auto upgrade configuration.
autoUpgradeProfile?: ManagedClusterAutoUpgradeProfile
Property Value
azureMonitorProfile
Azure Monitor addon profiles for monitoring the managed cluster.
azureMonitorProfile?: ManagedClusterAzureMonitorProfile
Property Value
azurePortalFqdn
The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients. The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.
azurePortalFqdn?: string
Property Value
string
bootstrapProfile
Profile of the cluster bootstrap configuration.
bootstrapProfile?: ManagedClusterBootstrapProfile
Property Value
creationData
CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot.
creationData?: CreationData
Property Value
currentKubernetesVersion
The version of Kubernetes the Managed Cluster is running. If kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.
currentKubernetesVersion?: string
Property Value
string
disableLocalAccounts
If local accounts should be disabled on the Managed Cluster. If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.
disableLocalAccounts?: boolean
Property Value
boolean
diskEncryptionSetID
The Resource ID of the disk encryption set to use for enabling encryption at rest. This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'
diskEncryptionSetID?: string
Property Value
string
dnsPrefix
The DNS prefix of the Managed Cluster. This cannot be updated once the Managed Cluster has been created.
dnsPrefix?: string
Property Value
string
enableNamespaceResources
Enable namespace as Azure resource. The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.
enableNamespaceResources?: boolean
Property Value
boolean
enableRbac
Whether to enable Kubernetes Role-Based Access Control.
enableRbac?: boolean
Property Value
boolean
fqdn
The FQDN of the master pool.
fqdn?: string
Property Value
string
fqdnSubdomain
The FQDN subdomain of the private cluster with custom private dns zone. This cannot be updated once the Managed Cluster has been created.
fqdnSubdomain?: string
Property Value
string
healthMonitorProfile
Health monitor profile for the managed cluster.
healthMonitorProfile?: ManagedClusterHealthMonitorProfile
Property Value
hostedSystemProfile
Settings for hosted system addons. For more information, see https://aka.ms/aks/automatic/systemcomponents.
hostedSystemProfile?: ManagedClusterHostedSystemProfile
Property Value
httpProxyConfig
Configurations for provisioning the cluster with HTTP proxy servers.
httpProxyConfig?: ManagedClusterHttpProxyConfig
Property Value
identityProfile
The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
identityProfile?: Record<string, UserAssignedIdentity>
Property Value
Record<string, UserAssignedIdentity>
ingressProfile
Ingress profile for the managed cluster.
ingressProfile?: ManagedClusterIngressProfile
Property Value
kubernetesVersion
The version of Kubernetes specified by the user. Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.
kubernetesVersion?: string
Property Value
string
linuxProfile
The profile for Linux VMs in the Managed Cluster.
linuxProfile?: ContainerServiceLinuxProfile
Property Value
maxAgentPools
The max number of agent pools for the managed cluster.
maxAgentPools?: number
Property Value
number
metricsProfile
Optional cluster metrics configuration.
metricsProfile?: ManagedClusterMetricsProfile
Property Value
networkProfile
The network configuration profile.
networkProfile?: ContainerServiceNetworkProfile
Property Value
nodeProvisioningProfile
Node provisioning settings that apply to the whole cluster.
nodeProvisioningProfile?: ManagedClusterNodeProvisioningProfile
Property Value
nodeResourceGroup
The name of the resource group containing agent pool nodes.
nodeResourceGroup?: string
Property Value
string
nodeResourceGroupProfile
Profile of the node resource group configuration.
nodeResourceGroupProfile?: ManagedClusterNodeResourceGroupProfile
Property Value
oidcIssuerProfile
The OIDC issuer profile of the Managed Cluster.
oidcIssuerProfile?: ManagedClusterOidcIssuerProfile
Property Value
podIdentityProfile
The pod identity profile of the Managed Cluster. See use AAD pod identity for more details on AAD pod identity integration.
podIdentityProfile?: ManagedClusterPodIdentityProfile
Property Value
powerState
privateFqdn
The FQDN of private cluster.
privateFqdn?: string
Property Value
string
privateLinkResources
Private link resources associated with the cluster.
privateLinkResources?: PrivateLinkResource[]
Property Value
provisioningState
The current provisioning state.
provisioningState?: string
Property Value
string
publicNetworkAccess
PublicNetworkAccess of the managedCluster. Allow or deny public network access for AKS
publicNetworkAccess?: string
Property Value
string
resourceUID
The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)
resourceUID?: string
Property Value
string
schedulerProfile
Profile of the pod scheduler configuration.
schedulerProfile?: SchedulerProfile
Property Value
securityProfile
Security profile for the managed cluster.
securityProfile?: ManagedClusterSecurityProfile
Property Value
serviceMeshProfile
Service mesh profile for a managed cluster.
serviceMeshProfile?: ServiceMeshProfile
Property Value
servicePrincipalProfile
Information about a service principal identity for the cluster to use for manipulating Azure APIs.
servicePrincipalProfile?: ManagedClusterServicePrincipalProfile
Property Value
status
Contains read-only information about the Managed Cluster.
status?: ManagedClusterStatus
Property Value
storageProfile
Storage profile for the managed cluster.
storageProfile?: ManagedClusterStorageProfile
Property Value
supportPlan
The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.
supportPlan?: string
Property Value
string
upgradeSettings
Settings for upgrading a cluster.
upgradeSettings?: ClusterUpgradeSettings
Property Value
windowsProfile
The profile for Windows VMs in the Managed Cluster.
windowsProfile?: ManagedClusterWindowsProfile
Property Value
workloadAutoScalerProfile
Workload Auto-scaler profile for the managed cluster.
workloadAutoScalerProfile?: ManagedClusterWorkloadAutoScalerProfile