ManagedCluster interface

The Azure Active Directory configuration.

aadProfile?: ManagedClusterAADProfile

Property Value

The profile of managed cluster add-on.

addonProfiles?: {[propertyName: string]: ManagedClusterAddonProfile}

Property Value

The agent pool properties.

agentPoolProfiles?: ManagedClusterAgentPoolProfile[]

Property Value

AI toolchain operator settings that apply to the whole cluster.

aiToolchainOperatorProfile?: ManagedClusterAIToolchainOperatorProfile

Property Value

The access profile for managed cluster API server.

apiServerAccessProfile?: ManagedClusterAPIServerAccessProfile

Property Value

Parameters to be applied to the cluster-autoscaler when enabled

autoScalerProfile?: ManagedClusterPropertiesAutoScalerProfile

Property Value

The auto upgrade configuration.

autoUpgradeProfile?: ManagedClusterAutoUpgradeProfile

Property Value

Azure Monitor addon profiles for monitoring the managed cluster.

azureMonitorProfile?: ManagedClusterAzureMonitorProfile

Property Value

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. NOTE: This property will not be serialized. It can only be populated by the server.

azurePortalFqdn?: string

Property Value

Profile of the cluster bootstrap configuration.

bootstrapProfile?: ManagedClusterBootstrapProfile

Property Value

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. NOTE: This property will not be serialized. It can only be populated by the server.

currentKubernetesVersion?: string

Property Value

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

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

The DNS prefix of the Managed Cluster. This cannot be updated once the Managed Cluster has been created.

dnsPrefix?: string

Property Value

Whether to enable Kubernetes Role-Based Access Control.

enableRbac?: boolean

Property Value

Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention. NOTE: This property will not be serialized. It can only be populated by the server.

eTag?: string

Property Value

The extended location of the Virtual Machine.

extendedLocation?: ExtendedLocation

Property Value

The FQDN of the master pool. NOTE: This property will not be serialized. It can only be populated by the server.

fqdn?: string

Property Value

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

Configurations for provisioning the cluster with HTTP proxy servers.

httpProxyConfig?: ManagedClusterHttpProxyConfig

Property Value

The identity of the managed cluster, if configured.

identity?: ManagedClusterIdentity

Property Value

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?: {[propertyName: string]: UserAssignedIdentity}

Property Value

Ingress profile for the managed cluster.

ingressProfile?: ManagedClusterIngressProfile

Property Value

This is primarily used to expose different UI experiences in the portal for different kinds

kind?: string

Property Value

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

The profile for Linux VMs in the Managed Cluster.

linuxProfile?: ContainerServiceLinuxProfile

Property Value

The max number of agent pools for the managed cluster. NOTE: This property will not be serialized. It can only be populated by the server.

maxAgentPools?: number

Property Value

Optional cluster metrics configuration.

metricsProfile?: ManagedClusterMetricsProfile

Property Value

The network configuration profile.

networkProfile?: ContainerServiceNetworkProfile

Property Value

Node provisioning settings that apply to the whole cluster.

nodeProvisioningProfile?: ManagedClusterNodeProvisioningProfile

Property Value

The name of the resource group containing agent pool nodes.

nodeResourceGroup?: string

Property Value

Profile of the node resource group configuration.

nodeResourceGroupProfile?: ManagedClusterNodeResourceGroupProfile

Property Value

The OIDC issuer profile of the Managed Cluster.

oidcIssuerProfile?: ManagedClusterOidcIssuerProfile

Property Value

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

The Power State of the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

powerState?: PowerState

Property Value

The FQDN of private cluster. NOTE: This property will not be serialized. It can only be populated by the server.

privateFqdn?: string

Property Value

Private link resources associated with the cluster.

privateLinkResources?: PrivateLinkResource[]

Property Value

The current provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

PublicNetworkAccess of the managedCluster. Allow or deny public network access for AKS

publicNetworkAccess?: string

Property Value

The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence) NOTE: This property will not be serialized. It can only be populated by the server.

resourceUID?: string

Property Value

Security profile for the managed cluster.

securityProfile?: ManagedClusterSecurityProfile

Property Value

Service mesh profile for a managed cluster.

serviceMeshProfile?: ServiceMeshProfile

Property Value

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

servicePrincipalProfile?: ManagedClusterServicePrincipalProfile

Property Value

The managed cluster SKU.

sku?: ManagedClusterSKU

Property Value

Contains read-only information about the Managed Cluster.

status?: ManagedClusterStatus

Property Value

Storage profile for the managed cluster.

storageProfile?: ManagedClusterStorageProfile

Property Value

The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.

supportPlan?: string

Property Value

Settings for upgrading a cluster.

upgradeSettings?: ClusterUpgradeSettings

Property Value

The profile for Windows VMs in the Managed Cluster.

windowsProfile?: ManagedClusterWindowsProfile

Property Value

Workload Auto-scaler profile for the managed cluster.

workloadAutoScalerProfile?: ManagedClusterWorkloadAutoScalerProfile

Property Value

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

Inherited From TrackedResource.id

The geo-location where the resource lives

location: string

Property Value

Inherited From TrackedResource.location

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

Inherited From TrackedResource.name

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

Resource tags.

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

Property Value

Inherited From TrackedResource.tags

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

Inherited From TrackedResource.type