ManagedClusterPropertiesOutput 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.
azurePortalFQDN	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.
creationData	CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot.
currentKubernetesVersion	The version of Kubernetes the Managed Cluster is running.
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.
fqdn	The FQDN of the master pool.
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.
maxAgentPools	The max number of agent pools for 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.
powerState	The Power State of the cluster.
privateFQDN	The FQDN of private cluster.
privateLinkResources	Private link resources associated with the cluster.
provisioningState	The current provisioning state.
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?: ManagedClusterAADProfileOutput

Property Value

ManagedClusterAADProfileOutput

addonProfiles

The profile of managed cluster add-on.

addonProfiles?: Record<string, ManagedClusterAddonProfileOutput>

Property Value

Record<string, ManagedClusterAddonProfileOutput>

agentPoolProfiles

The agent pool properties.

agentPoolProfiles?: ManagedClusterAgentPoolProfileOutput[]

Property Value

ManagedClusterAgentPoolProfileOutput[]

apiServerAccessProfile

The access profile for managed cluster API server.

apiServerAccessProfile?: ManagedClusterAPIServerAccessProfileOutput

Property Value

ManagedClusterAPIServerAccessProfileOutput

autoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

autoScalerProfile?: ManagedClusterPropertiesAutoScalerProfileOutput

Property Value

ManagedClusterPropertiesAutoScalerProfileOutput

autoUpgradeProfile

The auto upgrade configuration.

autoUpgradeProfile?: ManagedClusterAutoUpgradeProfileOutput

Property Value

ManagedClusterAutoUpgradeProfileOutput

azurePortalFQDN

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

creationData

CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot.

creationData?: CreationDataOutput

Property Value

CreationDataOutput

currentKubernetesVersion

The version of Kubernetes the Managed Cluster is running.

currentKubernetesVersion?: string

Property Value

string

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

fqdn

The FQDN of the master pool.

fqdn?: string

Property Value

string

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?: ManagedClusterHttpProxyConfigOutput

Property Value

ManagedClusterHttpProxyConfigOutput

identityProfile

Identities associated with the cluster.

identityProfile?: Record<string, UserAssignedIdentityOutput>

Property Value

Record<string, UserAssignedIdentityOutput>

ingressProfile

Ingress profile for the managed cluster.

ingressProfile?: ManagedClusterIngressProfileOutput

Property Value

ManagedClusterIngressProfileOutput

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?: ContainerServiceLinuxProfileOutput

Property Value

ContainerServiceLinuxProfileOutput

maxAgentPools

The max number of agent pools for the managed cluster.

maxAgentPools?: number

Property Value

number

networkProfile

The network configuration profile.

networkProfile?: ContainerServiceNetworkProfileOutput

Property Value

ContainerServiceNetworkProfileOutput

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?: ManagedClusterOidcIssuerProfileOutput

Property Value

ManagedClusterOidcIssuerProfileOutput

podIdentityProfile

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

podIdentityProfile?: ManagedClusterPodIdentityProfileOutput

Property Value

ManagedClusterPodIdentityProfileOutput

powerState

The Power State of the cluster.

powerState?: PowerStateOutput

Property Value

PowerStateOutput

privateFQDN

The FQDN of private cluster.

privateFQDN?: string

Property Value

string

privateLinkResources

Private link resources associated with the cluster.

privateLinkResources?: PrivateLinkResourceOutput[]

Property Value

PrivateLinkResourceOutput[]

provisioningState

The current provisioning state.

provisioningState?: string

Property Value

string

publicNetworkAccess

Allow or deny public network access for AKS

publicNetworkAccess?: "Enabled" | "Disabled"

Property Value

"Enabled" | "Disabled"

securityProfile

Security profile for the managed cluster.

securityProfile?: ManagedClusterSecurityProfileOutput

Property Value

ManagedClusterSecurityProfileOutput

servicePrincipalProfile

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

servicePrincipalProfile?: ManagedClusterServicePrincipalProfileOutput

Property Value

ManagedClusterServicePrincipalProfileOutput

storageProfile

Storage profile for the managed cluster.

storageProfile?: ManagedClusterStorageProfileOutput

Property Value

ManagedClusterStorageProfileOutput

windowsProfile

The profile for Windows VMs in the Managed Cluster.

windowsProfile?: ManagedClusterWindowsProfileOutput

Property Value

ManagedClusterWindowsProfileOutput

workloadAutoScalerProfile

Workload Auto-scaler profile for the container service cluster.

workloadAutoScalerProfile?: ManagedClusterWorkloadAutoScalerProfileOutput

Property Value

ManagedClusterWorkloadAutoScalerProfileOutput