Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ManagedCluster

Package version

Managed cluster.

Hierarchy

Index

Properties

Optional aadProfile

The Azure Active Directory configuration.

Optional addonProfiles

addonProfiles: undefined | {}

The profile of managed cluster add-on.

Optional agentPoolProfiles

agentPoolProfiles: ManagedClusterAgentPoolProfile[]

The agent pool properties.

Optional apiServerAccessProfile

apiServerAccessProfile: ManagedClusterAPIServerAccessProfile

The access profile for managed cluster API server.

Optional autoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

Optional autoUpgradeProfile

The auto upgrade configuration.

Optional azureMonitorProfile

Prometheus addon profile for the container service cluster

Optional azurePortalFqdn

azurePortalFqdn: undefined | string

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.

Optional creationData

creationData: CreationData

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

Optional currentKubernetesVersion

currentKubernetesVersion: undefined | string

The version of Kubernetes the Managed Cluster is running. NOTE: This property will not be serialized. It can only be populated by the server.

Optional disableLocalAccounts

disableLocalAccounts: undefined | false | true

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.

Optional diskEncryptionSetID

diskEncryptionSetID: undefined | string

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

Optional dnsPrefix

dnsPrefix: undefined | string

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

Optional enableNamespaceResources

enableNamespaceResources: undefined | false | true

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.

Optional enablePodSecurityPolicy

enablePodSecurityPolicy: undefined | false | true

(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.

Optional enableRbac

enableRbac: undefined | false | true

Whether to enable Kubernetes Role-Based Access Control.

Optional extendedLocation

extendedLocation: ExtendedLocation

The extended location of the Virtual Machine.

Optional fqdn

fqdn: undefined | string

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

Optional fqdnSubdomain

fqdnSubdomain: undefined | string

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

Optional guardrailsProfile

guardrailsProfile: GuardrailsProfile

The guardrails profile holds all the guardrails information for a given cluster

Optional httpProxyConfig

Configurations for provisioning the cluster with HTTP proxy servers.

Optional id

id: undefined | string

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

Optional identity

The identity of the managed cluster, if configured.

Optional identityProfile

identityProfile: undefined | {}

Identities associated with the cluster.

Optional ingressProfile

Ingress profile for the managed cluster.

Optional kubernetesVersion

kubernetesVersion: undefined | string

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.

Optional linuxProfile

The profile for Linux VMs in the Managed Cluster.

location

location: string

The geo-location where the resource lives

Optional maxAgentPools

maxAgentPools: undefined | number

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.

Optional name

name: undefined | string

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

Optional networkProfile

The network configuration profile.

Optional nodeResourceGroup

nodeResourceGroup: undefined | string

The name of the resource group containing agent pool nodes.

Optional oidcIssuerProfile

The OIDC issuer profile of the Managed Cluster.

Optional podIdentityProfile

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

Optional powerState

powerState: PowerState

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

Optional privateFqdn

privateFqdn: undefined | string

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

Optional privateLinkResources

privateLinkResources: PrivateLinkResource[]

Private link resources associated with the cluster.

Optional provisioningState

provisioningState: undefined | string

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

Optional publicNetworkAccess

publicNetworkAccess: PublicNetworkAccess

Allow or deny public network access for AKS

Optional securityProfile

Security profile for the managed cluster.

Optional servicePrincipalProfile

servicePrincipalProfile: ManagedClusterServicePrincipalProfile

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

Optional sku

The managed cluster SKU.

Optional storageProfile

Storage profile for the managed cluster.

Optional systemData

systemData: SystemData

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

Optional tags

tags: undefined | {}

Resource tags.

Optional type

type: undefined | string

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.

Optional windowsProfile

The profile for Windows VMs in the Managed Cluster.

Optional workloadAutoScalerProfile

workloadAutoScalerProfile: ManagedClusterWorkloadAutoScalerProfile

Workload Auto-scaler profile for the container service cluster.

Generated using TypeDoc