ManagedClusterProperties interface

Package:

@azure-rest/arm-containerservice

Properties of the managed cluster.

Properties

aadProfile	The Azure Active Directory configuration.
addonProfiles	The profile of managed cluster add-on.
agentPoolProfiles	The agent pool properties.
apiServerAccessProfile	The access profile for managed cluster API server.
autoScalerProfile	Parameters to be applied to the cluster-autoscaler when enabled
autoUpgradeProfile	The auto upgrade configuration.
creationData	CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot.
disableLocalAccounts	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.
diskEncryptionSetID	This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'
dnsPrefix	This cannot be updated once the Managed Cluster has been created.
enableNamespaceResources	The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.
enablePodSecurityPolicy	(DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.
enableRBAC	Whether to enable Kubernetes Role-Based Access Control.
fqdnSubdomain	This cannot be updated once the Managed Cluster has been created.
httpProxyConfig	Configurations for provisioning the cluster with HTTP proxy servers.
identityProfile	Identities associated with the cluster.
ingressProfile	Ingress profile for the managed cluster.
kubernetesVersion	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.
linuxProfile	The profile for Linux VMs in the Managed Cluster.
networkProfile	The network configuration profile.
nodeResourceGroup	The name of the resource group containing agent pool nodes.
oidcIssuerProfile	The OIDC issuer profile of the Managed Cluster.
podIdentityProfile	See use AAD pod identity for more details on AAD pod identity integration.
privateLinkResources	Private link resources associated with the cluster.
publicNetworkAccess	Allow or deny public network access for AKS
securityProfile	Security profile for the managed cluster.
servicePrincipalProfile	Information about a service principal identity for the cluster to use for manipulating Azure APIs.
storageProfile	Storage profile for the managed cluster.
windowsProfile	The profile for Windows VMs in the Managed Cluster.
workloadAutoScalerProfile	Workload Auto-scaler profile for the container service cluster.

Property Details

aadProfile

The Azure Active Directory configuration.

aadProfile?: ManagedClusterAADProfile

Property Value

ManagedClusterAADProfile

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

ManagedClusterAgentPoolProfile[]

apiServerAccessProfile

The access profile for managed cluster API server.

apiServerAccessProfile?: ManagedClusterAPIServerAccessProfile

Property Value

ManagedClusterAPIServerAccessProfile

autoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

autoScalerProfile?: ManagedClusterPropertiesAutoScalerProfile

Property Value

ManagedClusterPropertiesAutoScalerProfile

autoUpgradeProfile

The auto upgrade configuration.

autoUpgradeProfile?: ManagedClusterAutoUpgradeProfile

Property Value

ManagedClusterAutoUpgradeProfile

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

CreationData

disableLocalAccounts

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

This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'

diskEncryptionSetID?: string

Property Value

string

dnsPrefix

This cannot be updated once the Managed Cluster has been created.

dnsPrefix?: string

Property Value

string

enableNamespaceResources

The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.

enableNamespaceResources?: boolean

Property Value

boolean

enablePodSecurityPolicy

(DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.

enablePodSecurityPolicy?: boolean

Property Value

boolean

enableRBAC

Whether to enable Kubernetes Role-Based Access Control.

enableRBAC?: boolean

Property Value

boolean

fqdnSubdomain

This cannot be updated once the Managed Cluster has been created.

fqdnSubdomain?: string

Property Value

string

httpProxyConfig

Configurations for provisioning the cluster with HTTP proxy servers.

httpProxyConfig?: ManagedClusterHttpProxyConfig

Property Value

ManagedClusterHttpProxyConfig

identityProfile

Identities associated with the cluster.

identityProfile?: Record<string, UserAssignedIdentity>

Property Value

Record<string, UserAssignedIdentity>

ingressProfile

Ingress profile for the managed cluster.

ingressProfile?: ManagedClusterIngressProfile

Property Value

ManagedClusterIngressProfile

kubernetesVersion

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

ContainerServiceLinuxProfile

networkProfile

The network configuration profile.

networkProfile?: ContainerServiceNetworkProfile

Property Value

ContainerServiceNetworkProfile

nodeResourceGroup

The name of the resource group containing agent pool nodes.

nodeResourceGroup?: string

Property Value

string

oidcIssuerProfile

The OIDC issuer profile of the Managed Cluster.

oidcIssuerProfile?: ManagedClusterOidcIssuerProfile

Property Value

ManagedClusterOidcIssuerProfile

podIdentityProfile

See use AAD pod identity for more details on AAD pod identity integration.

podIdentityProfile?: ManagedClusterPodIdentityProfile

Property Value

ManagedClusterPodIdentityProfile

privateLinkResources

Private link resources associated with the cluster.

privateLinkResources?: PrivateLinkResource[]

Property Value

PrivateLinkResource[]

publicNetworkAccess

Allow or deny public network access for AKS

publicNetworkAccess?: "Enabled" | "Disabled"

Property Value

"Enabled" | "Disabled"

securityProfile

Security profile for the managed cluster.

securityProfile?: ManagedClusterSecurityProfile

Property Value

ManagedClusterSecurityProfile

servicePrincipalProfile

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

servicePrincipalProfile?: ManagedClusterServicePrincipalProfile

Property Value

ManagedClusterServicePrincipalProfile

storageProfile

Storage profile for the managed cluster.

storageProfile?: ManagedClusterStorageProfile

Property Value

ManagedClusterStorageProfile

windowsProfile

The profile for Windows VMs in the Managed Cluster.

windowsProfile?: ManagedClusterWindowsProfile

Property Value

ManagedClusterWindowsProfile

workloadAutoScalerProfile

Workload Auto-scaler profile for the container service cluster.

workloadAutoScalerProfile?: ManagedClusterWorkloadAutoScalerProfile

Property Value

ManagedClusterWorkloadAutoScalerProfile