Managed Clusters - Get

Reference

Service:: AKS

API Version:: 2024-09-01

Gets a managed cluster.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}?api-version=2024-09-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
resourceName	path	True	string	The name of the managed cluster resource. Regex pattern: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ManagedCluster	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get Managed Cluster

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1?api-version=2024-09-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python managed_clusters_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_clusters.get(
        resource_group_name="rg1",
        resource_name="clustername1",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-09-01/examples/ManagedClustersGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
  "location": "location1",
  "name": "clustername1",
  "tags": {
    "archv2": "",
    "tier": "production"
  },
  "type": "Microsoft.ContainerService/ManagedClusters",
  "eTag": "beywbwei",
  "properties": {
    "provisioningState": "Succeeded",
    "maxAgentPools": 1,
    "kubernetesVersion": "1.9.6",
    "currentKubernetesVersion": "1.9.6",
    "dnsPrefix": "dnsprefix1",
    "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
    "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io",
    "agentPoolProfiles": [
      {
        "name": "nodepool1",
        "count": 3,
        "vmSize": "Standard_DS1_v2",
        "maxPods": 110,
        "osType": "Linux",
        "eTag": "nvewbvoi",
        "provisioningState": "Succeeded",
        "orchestratorVersion": "1.9.6",
        "currentOrchestratorVersion": "1.9.6",
        "availabilityZones": [
          "1",
          "2",
          "3"
        ],
        "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
        "upgradeSettings": {
          "maxSurge": "33%"
        }
      }
    ],
    "linuxProfile": {
      "adminUsername": "azureuser",
      "ssh": {
        "publicKeys": [
          {
            "keyData": "keydata"
          }
        ]
      }
    },
    "servicePrincipalProfile": {
      "clientId": "clientid"
    },
    "nodeResourceGroup": "MC_rg1_clustername1_location1",
    "enableRBAC": false,
    "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
    "networkProfile": {
      "networkPlugin": "kubenet",
      "podCidr": "10.244.0.0/16",
      "serviceCidr": "10.0.0.0/16",
      "dnsServiceIP": "10.0.0.10",
      "loadBalancerSku": "standard",
      "outboundType": "loadBalancer",
      "podCidrs": [
        "10.244.0.0/16"
      ],
      "serviceCidrs": [
        "10.0.0.0/16"
      ],
      "ipFamilies": [
        "IPv4"
      ],
      "loadBalancerProfile": {
        "allocatedOutboundPorts": 2000,
        "idleTimeoutInMinutes": 10,
        "outboundIPs": {
          "publicIPs": [
            {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1"
            },
            {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2"
            }
          ]
        },
        "effectiveOutboundIPs": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
          },
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
          }
        ]
      }
    },
    "upgradeSettings": {
      "overrideSettings": {
        "forceUpgrade": true,
        "until": "2022-11-01T13:00:00Z"
      }
    }
  }
}

Definitions

Name	Description
AdvancedNetworking	Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking.
AdvancedNetworkingObservability	Observability profile to enable advanced network metrics and flow logs with historical contexts.
AdvancedNetworkingSecurity	Security profile to enable security features on cilium based cluster.
AgentPoolMode	The mode of an agent pool.
AgentPoolNetworkProfile	Network settings of an agent pool.
AgentPoolSecurityProfile	The security settings of an agent pool.
AgentPoolType	The type of Agent Pool.
AgentPoolUpgradeSettings	Settings for upgrading an agentpool
AgentPoolWindowsProfile	The Windows agent pool's specific profile.
AutoScalerProfile	Parameters to be applied to the cluster-autoscaler when enabled
AzureKeyVaultKms	Azure Key Vault key management service settings for the security profile.
BackendPoolType	The type of the managed inbound Load Balancer BackendPool.
CloudError	An error response from the Container service.
CloudErrorBody	An error response from the Container service.
ClusterUpgradeSettings	Settings for upgrading a cluster.
code	Tells whether the cluster is Running or Stopped
ContainerServiceLinuxProfile	Profile for Linux VMs in the container service cluster.
ContainerServiceNetworkProfile	Profile of network configuration.
ContainerServiceSshConfiguration	SSH configuration for Linux-based VMs running on Azure.
ContainerServiceSshPublicKey	Contains information about SSH certificate public key data.
createdByType	The type of identity that created the resource.
CreationData	Data used when creating a target resource from a source resource.
DelegatedResource	Delegated resource properties - internal use only.
expander	The expander to use when scaling up
ExtendedLocation	The complex type of the extended location.
ExtendedLocationTypes	The type of the extended location.
GPUInstanceProfile	GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
Identity	Identity for the resource.
ipFamily	The IP families used to specify IP versions available to the cluster.
IPTag	Contains the IPTag associated with the object.
IstioCertificateAuthority	Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca
IstioComponents	Istio components configuration.
IstioEgressGateway	Istio egress gateway configuration.
IstioIngressGateway	Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.
IstioIngressGatewayMode	Mode of an ingress gateway.
IstioPluginCertificateAuthority	Plugin certificates information for Service Mesh.
IstioServiceMesh	Istio service mesh configuration.
KeyVaultNetworkAccessTypes	Network access of the key vault
KubeletConfig	Kubelet configurations of agent nodes.
KubeletDiskType	Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
KubernetesSupportPlan	Different support tiers for AKS managed clusters
licenseType	The license type to use for Windows VMs. See Azure Hybrid User Benefits for more details.
LinuxOSConfig	OS configurations of Linux agent nodes.
loadBalancerSku	The load balancer sku for the managed cluster.
ManagedCluster	Managed cluster.
ManagedClusterAADProfile	AADProfile specifies attributes for Azure Active Directory integration.
ManagedClusterAddonProfile	A Kubernetes add-on profile for a managed cluster.
ManagedClusterAgentPoolProfile	Profile for the container service agent pool.
ManagedClusterAPIServerAccessProfile	Access profile for managed cluster API server.
ManagedClusterAutoUpgradeProfile	Auto upgrade profile for a managed cluster.
ManagedClusterAzureMonitorProfile	Azure Monitor addon profiles for monitoring the managed cluster.
ManagedClusterAzureMonitorProfileKubeStateMetrics	Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.
ManagedClusterAzureMonitorProfileMetrics	Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.
ManagedClusterCostAnalysis	The cost analysis configuration for the cluster
ManagedClusterHTTPProxyConfig	Cluster HTTP proxy configuration.
ManagedClusterIdentity	Identity for the managed cluster.
ManagedClusterIngressProfile	Ingress profile for the container service cluster.
ManagedClusterIngressProfileWebAppRouting	Application Routing add-on settings for the ingress profile.
ManagedClusterLoadBalancerProfile	Profile of the managed cluster load balancer.
ManagedClusterManagedOutboundIPProfile	Profile of the managed outbound IP resources of the managed cluster.
ManagedClusterMetricsProfile	The metrics profile for the ManagedCluster.
ManagedClusterNATGatewayProfile	Profile of the managed cluster NAT gateway.
ManagedClusterNodeResourceGroupProfile	Node resource group lockdown profile for a managed cluster.
ManagedClusterOIDCIssuerProfile	The OIDC issuer profile of the Managed Cluster.
ManagedClusterPodIdentity	Details about the pod identity assigned to the Managed Cluster.
ManagedClusterPodIdentityException	A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.
ManagedClusterPodIdentityProfile	The pod identity profile of the Managed Cluster.
ManagedClusterPodIdentityProvisioningError	An error response from the pod identity provisioning.
ManagedClusterPodIdentityProvisioningErrorBody	An error response from the pod identity provisioning.
ManagedClusterPodIdentityProvisioningState	The current provisioning state of the pod identity.
ManagedClusterSecurityProfile	Security profile for the container service cluster.
ManagedClusterSecurityProfileDefender	Microsoft Defender settings for the security profile.
ManagedClusterSecurityProfileDefenderSecurityMonitoring	Microsoft Defender settings for the security profile threat detection.
ManagedClusterSecurityProfileImageCleaner	Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile.
ManagedClusterSecurityProfileWorkloadIdentity	Workload identity settings for the security profile.
ManagedClusterServicePrincipalProfile	Information about a service principal identity for the cluster to use for manipulating Azure APIs.
ManagedClusterSKU	The SKU of a Managed Cluster.
ManagedClusterSKUName	The name of a managed cluster SKU.
ManagedClusterSKUTier	The tier of a managed cluster SKU.
ManagedClusterStorageProfile	Storage profile for the container service cluster.
ManagedClusterStorageProfileBlobCSIDriver	AzureBlob CSI Driver settings for the storage profile.
ManagedClusterStorageProfileDiskCSIDriver	AzureDisk CSI Driver settings for the storage profile.
ManagedClusterStorageProfileFileCSIDriver	AzureFile CSI Driver settings for the storage profile.
ManagedClusterStorageProfileSnapshotController	Snapshot Controller settings for the storage profile.
ManagedClusterWindowsProfile	Profile for Windows VMs in the managed cluster.
ManagedClusterWorkloadAutoScalerProfile	Workload Auto-scaler profile for the managed cluster.
ManagedClusterWorkloadAutoScalerProfileKeda	KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.
ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler	VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.
ManagedOutboundIPs	Desired managed outbound IPs for the cluster load balancer.
networkDataplane	Network dataplane used in the Kubernetes cluster.
networkMode	The network mode Azure CNI is configured with.
NetworkPlugin	Network plugin used for building the Kubernetes network.
NetworkPluginMode	The mode the network plugin should use.
NetworkPolicy	Network policy used for building the Kubernetes network.
nodeOSUpgradeChannel	Node OS Upgrade Channel
OSDiskType	The OS disk type to be used for machines in the agent pool.
OSSKU	Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
OSType	The operating system type. The default is Linux.
OutboundIPPrefixes	Desired outbound IP Prefix resources for the cluster load balancer.
OutboundIPs	Desired outbound IP resources for the cluster load balancer.
outboundType	The outbound (egress) routing method.
PortRange	The port range.
PowerState	Describes the Power State of the cluster
PrivateLinkResource	A private link resource
Protocol	The network protocol of the port.
ProvisioningInfo
PublicNetworkAccess	PublicNetworkAccess of the managedCluster
ResourceIdentityType	The type of identity used for the managed cluster.
ResourceReference	A reference to an Azure resource.
RestrictionLevel	The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'
ScaleDownMode	Describes how VMs are added to or removed from Agent Pools. See billing states.
ScaleSetEvictionPolicy	The Virtual Machine Scale Set eviction policy.
ScaleSetPriority	The Virtual Machine Scale Set priority.
ServiceMeshMode	Mode of the service mesh.
ServiceMeshProfile	Service mesh profile for a managed cluster.
SysctlConfig	Sysctl settings for Linux agent nodes.
systemData	Metadata pertaining to creation and last modification of the resource.
upgradeChannel	The upgrade channel for auto upgrade. The default is 'none'.
UpgradeOverrideSettings	Settings for overrides when upgrading a cluster.
UserAssignedIdentities	The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.
UserAssignedIdentity	Details about a user assigned identity.
WindowsGmsaProfile	Windows gMSA Profile in the managed cluster.
WorkloadRuntime	Determines the type of workload a node can run.

AdvancedNetworking

Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking.

Name	Type	Description
enabled	boolean	Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false.
observability	AdvancedNetworkingObservability	Observability profile to enable advanced network metrics and flow logs with historical contexts.
security	AdvancedNetworkingSecurity	Security profile to enable security features on cilium based cluster.

AdvancedNetworkingObservability

Observability profile to enable advanced network metrics and flow logs with historical contexts.

Name	Type	Description
enabled	boolean	Indicates the enablement of Advanced Networking observability functionalities on clusters.

AdvancedNetworkingSecurity

Security profile to enable security features on cilium based cluster.

Name	Type	Description
enabled	boolean	This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false.

AgentPoolMode

The mode of an agent pool.

Name	Type	Description
System	string	System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory.
User	string	User agent pools are primarily for hosting your application pods.

AgentPoolNetworkProfile

Network settings of an agent pool.

Name	Type	Description
allowedHostPorts	PortRange[]	The port ranges that are allowed to access. The specified ranges are allowed to overlap.
applicationSecurityGroups	string[]	The IDs of the application security groups which agent pool will associate when created.
nodePublicIPTags	IPTag[]	IPTags of instance-level public IPs.

AgentPoolSecurityProfile

The security settings of an agent pool.

Name	Type	Description
enableSecureBoot	boolean	Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
enableVTPM	boolean	vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.

AgentPoolType

The type of Agent Pool.

Name	Type	Description
AvailabilitySet	string	Use of this is strongly discouraged.
VirtualMachineScaleSets	string	Create an Agent Pool backed by a Virtual Machine Scale Set.

AgentPoolUpgradeSettings

Settings for upgrading an agentpool

Name	Type	Description
drainTimeoutInMinutes	integer	The drain timeout for a node The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
maxSurge	string	The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade
nodeSoakDurationInMinutes	integer	The soak duration for a node The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.

AgentPoolWindowsProfile

The Windows agent pool's specific profile.

Name	Type	Description
disableOutboundNat	boolean	Whether to disable OutboundNAT in windows nodes The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

AutoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

Name	Type	Description
balance-similar-node-groups	string	Detects similar node pools and balances the number of nodes between them. Valid values are 'true' and 'false'
daemonset-eviction-for-empty-nodes	boolean	DaemonSet pods will be gracefully terminated from empty nodes If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted.
daemonset-eviction-for-occupied-nodes	boolean	DaemonSet pods will be gracefully terminated from non-empty nodes If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted.
expander	expander	The expander to use when scaling up If not specified, the default is 'random'. See expanders for more information.
ignore-daemonsets-utilization	boolean	Should CA ignore DaemonSet pods when calculating resource utilization for scaling down If set to true, the resources used by daemonset will be taken into account when making scaling down decisions.
max-empty-bulk-delete	string	The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer. The default is 10.
max-graceful-termination-sec	string	The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. The default is 600.
max-node-provision-time	string	The maximum time the autoscaler waits for a node to be provisioned. The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
max-total-unready-percentage	string	The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations. The default is 45. The maximum is 100 and the minimum is 0.
new-pod-scale-up-delay	string	Ignore unscheduled pods before they're a certain age. For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc).
ok-total-unready-count	string	The number of allowed unready nodes, irrespective of max-total-unready-percentage. This must be an integer. The default is 3.
scale-down-delay-after-add	string	How long after scale up that scale down evaluation resumes The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-delay-after-delete	string	How long after node deletion that scale down evaluation resumes. The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-delay-after-failure	string	How long after scale down failure that scale down evaluation resumes. The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-unneeded-time	string	How long a node should be unneeded before it is eligible for scale down. The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-unready-time	string	How long an unready node should be unneeded before it is eligible for scale down The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.
scale-down-utilization-threshold	string	Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down. The default is '0.5'.
scan-interval	string	How often cluster is reevaluated for scale up or down. The default is '10'. Values must be an integer number of seconds.
skip-nodes-with-local-storage	string	If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath. The default is true.
skip-nodes-with-system-pods	string	If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods) The default is true.

AzureKeyVaultKms

Azure Key Vault key management service settings for the security profile.

Name	Type	Default value	Description
enabled	boolean		Whether to enable Azure Key Vault key management service. The default is false.
keyId	string		Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.
keyVaultNetworkAccess	KeyVaultNetworkAccessTypes	Public	Network access of the key vault Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`.
keyVaultResourceId	string		Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty.

BackendPoolType

The type of the managed inbound Load Balancer BackendPool.

Name	Type	Description
NodeIP	string	The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend.
NodeIPConfiguration	string	The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend.

CloudError

An error response from the Container service.

Name	Type	Description
error	CloudErrorBody	Details about the error.

CloudErrorBody

An error response from the Container service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ClusterUpgradeSettings

Settings for upgrading a cluster.

Name	Type	Description
overrideSettings	UpgradeOverrideSettings	Settings for overrides.

code

Tells whether the cluster is Running or Stopped

Name	Type	Description
Running	string	The cluster is running.
Stopped	string	The cluster is stopped.

ContainerServiceLinuxProfile

Profile for Linux VMs in the container service cluster.

Name	Type	Description
adminUsername	string	The administrator username to use for Linux VMs.
ssh	ContainerServiceSshConfiguration	The SSH configuration for Linux-based VMs running on Azure.

ContainerServiceNetworkProfile

Profile of network configuration.

Name	Type	Default value	Description
advancedNetworking	AdvancedNetworking		Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking.
dnsServiceIP	string	10.0.0.10	An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
ipFamilies	ipFamily[]		The IP families used to specify IP versions available to the cluster. IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.
loadBalancerProfile	ManagedClusterLoadBalancerProfile		Profile of the cluster load balancer.
loadBalancerSku	loadBalancerSku		The load balancer sku for the managed cluster. The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.
natGatewayProfile	ManagedClusterNATGatewayProfile		Profile of the cluster NAT gateway.
networkDataplane	networkDataplane		Network dataplane used in the Kubernetes cluster.
networkMode	networkMode		The network mode Azure CNI is configured with. This cannot be specified if networkPlugin is anything other than 'azure'.
networkPlugin	NetworkPlugin		Network plugin used for building the Kubernetes network.
networkPluginMode	NetworkPluginMode		The mode the network plugin should use.
networkPolicy	NetworkPolicy		Network policy used for building the Kubernetes network.
outboundType	outboundType	loadBalancer	The outbound (egress) routing method. This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.
podCidr	string	10.244.0.0/16	A CIDR notation IP range from which to assign pod IPs when kubenet is used.
podCidrs	string[]		The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.
serviceCidr	string	10.0.0.0/16	A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
serviceCidrs	string[]		The CIDR notation IP ranges from which to assign service cluster IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

ContainerServiceSshConfiguration

SSH configuration for Linux-based VMs running on Azure.

Name	Type	Description
publicKeys	ContainerServiceSshPublicKey[]	The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

ContainerServiceSshPublicKey

Contains information about SSH certificate public key data.

Name	Type	Description
keyData	string	Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreationData

Data used when creating a target resource from a source resource.

Name	Type	Description
sourceResourceId	string	This is the ARM ID of the source object to be used to create the target object.

DelegatedResource

Delegated resource properties - internal use only.

Name	Type	Description
location	string	The source resource location - internal use only.
referralResource	string	The delegation id of the referral delegation (optional) - internal use only.
resourceId	string	The ARM resource id of the delegated resource - internal use only.
tenantId	string	The tenant id of the delegated resource - internal use only.

expander

The expander to use when scaling up

Name	Type	Description
least-waste	string	Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources.
most-pods	string	Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once.
priority	string	Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details here.
random	string	Used when you don't have a particular need for the node groups to scale differently.

ExtendedLocation

The complex type of the extended location.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationTypes	The type of the extended location.

ExtendedLocationTypes

The type of the extended location.

Name	Type	Description
EdgeZone	string

GPUInstanceProfile

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

Name	Type	Description
MIG1g	string
MIG2g	string
MIG3g	string
MIG4g	string
MIG7g	string

Identity

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity. The value must be an UUID.
tenantId	string	The tenant ID of resource. The value must be an UUID.
type	ResourceIdentityType	The identity type.

ipFamily

The IP families used to specify IP versions available to the cluster.

Name	Type	Description
IPv4	string
IPv6	string

IPTag

Contains the IPTag associated with the object.

Name	Type	Description
ipTagType	string	The IP tag type. Example: RoutingPreference.
tag	string	The value of the IP tag associated with the public IP. Example: Internet.

IstioCertificateAuthority

Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca

Name	Type	Description
plugin	IstioPluginCertificateAuthority	Plugin certificates information for Service Mesh.

IstioComponents

Istio components configuration.

Name	Type	Description
egressGateways	IstioEgressGateway[]	Istio egress gateways.
ingressGateways	IstioIngressGateway[]	Istio ingress gateways.

IstioEgressGateway

Istio egress gateway configuration.

Name	Type	Description
enabled	boolean	Whether to enable the egress gateway.

IstioIngressGateway

Istio ingress gateway configuration. For now, we support up to one external ingress gateway named aks-istio-ingressgateway-external and one internal ingress gateway named aks-istio-ingressgateway-internal.

Name	Type	Description
enabled	boolean	Whether to enable the ingress gateway.
mode	IstioIngressGatewayMode	Mode of an ingress gateway.

IstioIngressGatewayMode

Mode of an ingress gateway.

Name	Type	Description
External	string	The ingress gateway is assigned a public IP address and is publicly accessible.
Internal	string	The ingress gateway is assigned an internal IP address and cannot is accessed publicly.

IstioPluginCertificateAuthority

Plugin certificates information for Service Mesh.

Name	Type	Description
certChainObjectName	string	Certificate chain object name in Azure Key Vault.
certObjectName	string	Intermediate certificate object name in Azure Key Vault.
keyObjectName	string	Intermediate certificate private key object name in Azure Key Vault.
keyVaultId	string	The resource ID of the Key Vault.
rootCertObjectName	string	Root certificate object name in Azure Key Vault.

IstioServiceMesh

Istio service mesh configuration.

Name	Type	Description
certificateAuthority	IstioCertificateAuthority	Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca
components	IstioComponents	Istio components configuration.
revisions	string[]	The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade

KeyVaultNetworkAccessTypes

Network access of the key vault

Name	Type	Description
Private	string
Public	string

KubeletConfig

Kubelet configurations of agent nodes.

Name	Type	Description
allowedUnsafeSysctls	string[]	Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`).
containerLogMaxFiles	integer	The maximum number of container log files that can be present for a container. The number must be ≥ 2.
containerLogMaxSizeMB	integer	The maximum size (e.g. 10Mi) of container log file before it is rotated.
cpuCfsQuota	boolean	If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true.
cpuCfsQuotaPeriod	string	The CPU CFS quota period value. The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.
cpuManagerPolicy	string	The CPU Manager policy to use. The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.
failSwapOn	boolean	If set to true it will make the Kubelet fail to start if swap is enabled on the node.
imageGcHighThreshold	integer	The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%
imageGcLowThreshold	integer	The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80%
podMaxPids	integer	The maximum number of processes per pod.
topologyManagerPolicy	string	The Topology Manager policy to use. For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

KubeletDiskType

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

Name	Type	Description
OS	string	Kubelet will use the OS disk for its data.
Temporary	string	Kubelet will use the temporary disk for its data.

KubernetesSupportPlan

Different support tiers for AKS managed clusters

Name	Type	Description
AKSLongTermSupport	string	Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support.
KubernetesOfficial	string	Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release.

licenseType

The license type to use for Windows VMs. See Azure Hybrid User Benefits for more details.

Name	Type	Description
None	string	No additional licensing is applied.
Windows_Server	string	Enables Azure Hybrid User Benefits for Windows VMs.

LinuxOSConfig

OS configurations of Linux agent nodes.

Name	Type	Description
swapFileSizeMB	integer	The size in MB of a swap file that will be created on each node.
sysctls	SysctlConfig	Sysctl settings for Linux agent nodes.
transparentHugePageDefrag	string	Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.
transparentHugePageEnabled	string	Whether transparent hugepages are enabled. Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

loadBalancerSku

The load balancer sku for the managed cluster.

Name	Type	Description
basic	string	Use a basic Load Balancer with limited functionality.
standard	string	Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the standard Load Balancer article.

ManagedCluster

Managed cluster.

Name	Type	Description
eTag	string	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.
extendedLocation	ExtendedLocation	The extended location of the Virtual Machine.
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedClusterIdentity	The identity of the managed cluster, if configured.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.aadProfile	ManagedClusterAADProfile	AADProfile specifies attributes for Azure Active Directory integration. The Azure Active Directory configuration.
properties.addonProfiles	<string, ManagedClusterAddonProfile>	The profile of managed cluster add-on.
properties.agentPoolProfiles	ManagedClusterAgentPoolProfile[]	The agent pool properties.
properties.apiServerAccessProfile	ManagedClusterAPIServerAccessProfile	The access profile for managed cluster API server.
properties.autoScalerProfile	AutoScalerProfile	Parameters to be applied to the cluster-autoscaler when enabled
properties.autoUpgradeProfile	ManagedClusterAutoUpgradeProfile	The auto upgrade configuration.
properties.azureMonitorProfile	ManagedClusterAzureMonitorProfile	Azure Monitor addon profiles for monitoring the managed cluster.
properties.azurePortalFQDN	string	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.
properties.currentKubernetesVersion	string	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.
properties.disableLocalAccounts	boolean	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.
properties.diskEncryptionSetID	string	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}'
properties.dnsPrefix	string	The DNS prefix of the Managed Cluster. This cannot be updated once the Managed Cluster has been created.
properties.enablePodSecurityPolicy	boolean	(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.
properties.enableRBAC	boolean	Whether to enable Kubernetes Role-Based Access Control.
properties.fqdn	string	The FQDN of the master pool.
properties.fqdnSubdomain	string	The FQDN subdomain of the private cluster with custom private dns zone. This cannot be updated once the Managed Cluster has been created.
properties.httpProxyConfig	ManagedClusterHTTPProxyConfig	Configurations for provisioning the cluster with HTTP proxy servers.
properties.identityProfile	<string, UserAssignedIdentity>	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}".
properties.ingressProfile	ManagedClusterIngressProfile	Ingress profile for the managed cluster.
properties.kubernetesVersion	string	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.
properties.linuxProfile	ContainerServiceLinuxProfile	The profile for Linux VMs in the Managed Cluster.
properties.maxAgentPools	integer	The max number of agent pools for the managed cluster.
properties.metricsProfile	ManagedClusterMetricsProfile	Optional cluster metrics configuration.
properties.networkProfile	ContainerServiceNetworkProfile	The network configuration profile.
properties.nodeResourceGroup	string	The name of the resource group containing agent pool nodes.
properties.nodeResourceGroupProfile	ManagedClusterNodeResourceGroupProfile	Profile of the node resource group configuration.
properties.oidcIssuerProfile	ManagedClusterOIDCIssuerProfile	The OIDC issuer profile of the Managed Cluster.
properties.podIdentityProfile	ManagedClusterPodIdentityProfile	The pod identity profile of the Managed Cluster. See use AAD pod identity for more details on AAD pod identity integration.
properties.powerState	PowerState	The Power State of the cluster.
properties.privateFQDN	string	The FQDN of private cluster.
properties.privateLinkResources	PrivateLinkResource[]	Private link resources associated with the cluster.
properties.provisioningState	string	The current provisioning state.
properties.publicNetworkAccess	PublicNetworkAccess	PublicNetworkAccess of the managedCluster Allow or deny public network access for AKS
properties.resourceUID	string	The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)
properties.securityProfile	ManagedClusterSecurityProfile	Security profile for the managed cluster.
properties.serviceMeshProfile	ServiceMeshProfile	Service mesh profile for a managed cluster.
properties.servicePrincipalProfile	ManagedClusterServicePrincipalProfile	Information about a service principal identity for the cluster to use for manipulating Azure APIs.
properties.storageProfile	ManagedClusterStorageProfile	Storage profile for the managed cluster.
properties.supportPlan	KubernetesSupportPlan	The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.
properties.upgradeSettings	ClusterUpgradeSettings	Settings for upgrading a cluster.
properties.windowsProfile	ManagedClusterWindowsProfile	The profile for Windows VMs in the Managed Cluster.
properties.workloadAutoScalerProfile	ManagedClusterWorkloadAutoScalerProfile	Workload Auto-scaler profile for the managed cluster.
sku	ManagedClusterSKU	The managed cluster SKU.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ManagedClusterAADProfile

AADProfile specifies attributes for Azure Active Directory integration.

Name	Type	Description
adminGroupObjectIDs	string[]	The list of AAD group object IDs that will have admin role of the cluster.
clientAppID	string	(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.
enableAzureRBAC	boolean	Whether to enable Azure RBAC for Kubernetes authorization.
managed	boolean	Whether to enable managed AAD.
serverAppID	string	(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.
serverAppSecret	string	(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.
tenantID	string	The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

ManagedClusterAddonProfile

A Kubernetes add-on profile for a managed cluster.

Name	Type	Description
config	object	Key-value pairs for configuring an add-on.
enabled	boolean	Whether the add-on is enabled or not.
identity	Identity	Information of user assigned identity used by this add-on.

ManagedClusterAgentPoolProfile

Profile for the container service agent pool.

Name	Type	Default value	Description
availabilityZones	string[]		The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
capacityReservationGroupID	string		The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines. AKS will associate the specified agent pool with the Capacity Reservation Group.
count	integer		Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1.
creationData	CreationData		CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
currentOrchestratorVersion	string		The version of Kubernetes the Agent Pool is running. If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.
eTag	string		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.
enableAutoScaling	boolean		Whether to enable auto-scaler
enableEncryptionAtHost	boolean		Whether to enable host based OS and data drive encryption. This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption
enableFIPS	boolean		Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
enableNodePublicIP	boolean		Whether each node is allocated its own public IP. Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.
enableUltraSSD	boolean		Whether to enable UltraSSD
gpuInstanceProfile	GPUInstanceProfile		GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
hostGroupID	string		The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.
kubeletConfig	KubeletConfig		Kubelet configurations of agent nodes. The Kubelet configuration on the agent pool nodes.
kubeletDiskType	KubeletDiskType		Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
linuxOSConfig	LinuxOSConfig		OS configurations of Linux agent nodes. The OS configuration of Linux agent nodes.
maxCount	integer		The maximum number of nodes for auto-scaling
maxPods	integer		The maximum number of pods that can run on a node.
minCount	integer		The minimum number of nodes for auto-scaling
mode	AgentPoolMode		The mode of an agent pool. A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools
name	string		Unique name of the agent pool profile in the context of the subscription and resource group. Windows agent pool names must be 6 characters or less.
networkProfile	AgentPoolNetworkProfile		Network-related settings of an agent pool.
nodeImageVersion	string		The version of node image
nodeLabels	object		The node labels to be persisted across all nodes in agent pool.
nodePublicIPPrefixID	string		The public IP prefix ID which VM nodes should use IPs from. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints	string[]		The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
orchestratorVersion	string		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. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.
osDiskSizeGB	integer		OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.
osDiskType	OSDiskType		The OS disk type to be used for machines in the agent pool. The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS.
osSKU	OSSKU		Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
osType	OSType	Linux	The operating system type. The default is Linux.
podSubnetID	string		The ID of the subnet which pods will join when launched. If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
powerState	PowerState		Whether the Agent Pool is running or stopped. When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded
provisioningState	string		The current deployment or provisioning state.
proximityPlacementGroupID	string		The ID for Proximity Placement Group.
scaleDownMode	ScaleDownMode		The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
scaleSetEvictionPolicy	ScaleSetEvictionPolicy	Delete	The Virtual Machine Scale Set eviction policy to use. This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
scaleSetPriority	ScaleSetPriority	Regular	The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
securityProfile	AgentPoolSecurityProfile		The security settings of an agent pool.
spotMaxPrice	number	-1	The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing
tags	object		The tags to be persisted on the agent pool virtual machine scale set.
type	AgentPoolType		The type of Agent Pool.
upgradeSettings	AgentPoolUpgradeSettings		Settings for upgrading the agentpool
vmSize	string		The size of the agent pool VMs. VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions
vnetSubnetID	string		The ID of the subnet which agent pool nodes and optionally pods will join on startup. If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
windowsProfile	AgentPoolWindowsProfile		The Windows agent pool's specific profile.
workloadRuntime	WorkloadRuntime		Determines the type of workload a node can run.

ManagedClusterAPIServerAccessProfile

Access profile for managed cluster API server.

Name	Type	Description
authorizedIPRanges	string[]	The IP ranges authorized to access the Kubernetes API server. IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.
disableRunCommand	boolean	Whether to disable run command for the cluster or not.
enablePrivateCluster	boolean	Whether to create the cluster as a private cluster or not. For more details, see Creating a private AKS cluster.
enablePrivateClusterPublicFQDN	boolean	Whether to create additional public FQDN for private cluster or not.
privateDNSZone	string	The private DNS zone mode for the cluster. The default is System. For more details see configure private DNS zone. Allowed values are 'system' and 'none'.

ManagedClusterAutoUpgradeProfile

Auto upgrade profile for a managed cluster.

Name	Type	Description
nodeOSUpgradeChannel	nodeOSUpgradeChannel	Node OS Upgrade Channel Manner in which the OS on your nodes is updated. The default is NodeImage.
upgradeChannel	upgradeChannel	The upgrade channel for auto upgrade. The default is 'none'. For more information see setting the AKS cluster auto-upgrade channel.

ManagedClusterAzureMonitorProfile

Azure Monitor addon profiles for monitoring the managed cluster.

Name	Type	Description
metrics	ManagedClusterAzureMonitorProfileMetrics	Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.

ManagedClusterAzureMonitorProfileKubeStateMetrics

Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.

Name	Type	Description
metricAnnotationsAllowList	string	Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels.
metricLabelsAllowlist	string	Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels.

ManagedClusterAzureMonitorProfileMetrics

Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.

Name	Type	Description
enabled	boolean	Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling.
kubeStateMetrics	ManagedClusterAzureMonitorProfileKubeStateMetrics	Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.

ManagedClusterCostAnalysis

The cost analysis configuration for the cluster

Name	Type	Description
enabled	boolean	Whether to enable cost analysis The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis.

ManagedClusterHTTPProxyConfig

Cluster HTTP proxy configuration.

Name	Type	Description
httpProxy	string	The HTTP proxy server endpoint to use.
httpsProxy	string	The HTTPS proxy server endpoint to use.
noProxy	string[]	The endpoints that should not go through proxy.
trustedCa	string	Alternative CA cert to use for connecting to proxy servers.

ManagedClusterIdentity

Identity for the managed cluster.

Name	Type	Description
delegatedResources	<string, DelegatedResource>	The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only.
principalId	string	The principal id of the system assigned identity which is used by master components.
tenantId	string	The tenant id of the system assigned identity which is used by master components.
type	ResourceIdentityType	The type of identity used for the managed cluster. For more information see use managed identities in AKS.
userAssignedIdentities	UserAssignedIdentities	The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed. The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedClusterIngressProfile

Ingress profile for the container service cluster.

Name	Type	Description
webAppRouting	ManagedClusterIngressProfileWebAppRouting	App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default.

ManagedClusterIngressProfileWebAppRouting

Application Routing add-on settings for the ingress profile.

Name	Type	Description
dnsZoneResourceIds	string[]	Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group.
enabled	boolean	Whether to enable the Application Routing add-on.
identity	UserAssignedIdentity	Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See this overview of the add-on for more instructions.

ManagedClusterLoadBalancerProfile

Profile of the managed cluster load balancer.

Name	Type	Default value	Description
allocatedOutboundPorts	integer	0	The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.
backendPoolType	BackendPoolType	NodeIPConfiguration	The type of the managed inbound Load Balancer BackendPool.
effectiveOutboundIPs	ResourceReference[]		The effective outbound IP resources of the cluster load balancer.
enableMultipleStandardLoadBalancers	boolean		Enable multiple standard load balancers per AKS cluster or not.
idleTimeoutInMinutes	integer	30	Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.
managedOutboundIPs	ManagedOutboundIPs		Desired managed outbound IPs for the cluster load balancer.
outboundIPPrefixes	OutboundIPPrefixes		Desired outbound IP Prefix resources for the cluster load balancer.
outboundIPs	OutboundIPs		Desired outbound IP resources for the cluster load balancer.

ManagedClusterManagedOutboundIPProfile

Profile of the managed outbound IP resources of the managed cluster.

Name	Type	Default value	Description
count	integer	1	The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1.

ManagedClusterMetricsProfile

The metrics profile for the ManagedCluster.

Name	Type	Description
costAnalysis	ManagedClusterCostAnalysis	The configuration for detailed per-Kubernetes resource cost analysis. The cost analysis configuration for the cluster

ManagedClusterNATGatewayProfile

Profile of the managed cluster NAT gateway.

Name	Type	Default value	Description
effectiveOutboundIPs	ResourceReference[]		The effective outbound IP resources of the cluster NAT gateway.
idleTimeoutInMinutes	integer	4	Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.
managedOutboundIPProfile	ManagedClusterManagedOutboundIPProfile		Profile of the managed outbound IP resources of the cluster NAT gateway.

ManagedClusterNodeResourceGroupProfile

Node resource group lockdown profile for a managed cluster.

Name	Type	Description
restrictionLevel	RestrictionLevel	The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'

ManagedClusterOIDCIssuerProfile

The OIDC issuer profile of the Managed Cluster.

Name	Type	Description
enabled	boolean	Whether the OIDC issuer is enabled.
issuerURL	string	The OIDC issuer url of the Managed Cluster.

ManagedClusterPodIdentity

Details about the pod identity assigned to the Managed Cluster.

Name	Type	Description
bindingSelector	string	The binding selector to use for the AzureIdentityBinding resource.
identity	UserAssignedIdentity	The user assigned identity details.
name	string	The name of the pod identity.
namespace	string	The namespace of the pod identity.
provisioningInfo	ProvisioningInfo
provisioningState	ManagedClusterPodIdentityProvisioningState	The current provisioning state of the pod identity.

ManagedClusterPodIdentityException

A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.

Name	Type	Description
name	string	The name of the pod identity exception.
namespace	string	The namespace of the pod identity exception.
podLabels	object	The pod labels to match.

ManagedClusterPodIdentityProfile

The pod identity profile of the Managed Cluster.

Name	Type	Description
allowNetworkPluginKubenet	boolean	Whether pod identity is allowed to run on clusters with Kubenet networking. Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See using Kubenet network plugin with AAD Pod Identity for more information.
enabled	boolean	Whether the pod identity addon is enabled.
userAssignedIdentities	ManagedClusterPodIdentity[]	The pod identities to use in the cluster.
userAssignedIdentityExceptions	ManagedClusterPodIdentityException[]	The pod identity exceptions to allow.

ManagedClusterPodIdentityProvisioningError

An error response from the pod identity provisioning.

Name	Type	Description
error	ManagedClusterPodIdentityProvisioningErrorBody	Details about the error.

ManagedClusterPodIdentityProvisioningErrorBody

An error response from the pod identity provisioning.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	ManagedClusterPodIdentityProvisioningErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ManagedClusterPodIdentityProvisioningState

The current provisioning state of the pod identity.

Name	Type	Description
Assigned	string
Canceled	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ManagedClusterSecurityProfile

Security profile for the container service cluster.

Name	Type	Description
azureKeyVaultKms	AzureKeyVaultKms	Azure Key Vault key management service settings for the security profile.
defender	ManagedClusterSecurityProfileDefender	Microsoft Defender settings for the security profile.
imageCleaner	ManagedClusterSecurityProfileImageCleaner	Image Cleaner settings for the security profile.
workloadIdentity	ManagedClusterSecurityProfileWorkloadIdentity	Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details.

ManagedClusterSecurityProfileDefender

Microsoft Defender settings for the security profile.

Name	Type	Description
logAnalyticsWorkspaceResourceId	string	Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty.
securityMonitoring	ManagedClusterSecurityProfileDefenderSecurityMonitoring	Microsoft Defender threat detection for Cloud settings for the security profile.

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft Defender settings for the security profile threat detection.

Name	Type	Description
enabled	boolean	Whether to enable Defender threat detection

ManagedClusterSecurityProfileImageCleaner

Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile.

Name	Type	Description
enabled	boolean	Whether to enable Image Cleaner on AKS cluster.
intervalHours	integer	Image Cleaner scanning interval in hours.

ManagedClusterSecurityProfileWorkloadIdentity

Workload identity settings for the security profile.

Name	Type	Description
enabled	boolean	Whether to enable workload identity.

ManagedClusterServicePrincipalProfile

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

Name	Type	Description
clientId	string	The ID for the service principal.
secret	string	The secret password associated with the service principal in plain text.

ManagedClusterSKU

The SKU of a Managed Cluster.

Name	Type	Description
name	ManagedClusterSKUName	The name of a managed cluster SKU.
tier	ManagedClusterSKUTier	The tier of a managed cluster SKU. If not specified, the default is 'Free'. See AKS Pricing Tier for more details.

ManagedClusterSKUName

The name of a managed cluster SKU.

Name	Type	Description
Base	string	Base option for the AKS control plane.

ManagedClusterSKUTier

The tier of a managed cluster SKU.

Name	Type	Description
Free	string	The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases.
Premium	string	Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions.
Standard	string	Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones.

ManagedClusterStorageProfile

Storage profile for the container service cluster.

Name	Type	Description
blobCSIDriver	ManagedClusterStorageProfileBlobCSIDriver	AzureBlob CSI Driver settings for the storage profile.
diskCSIDriver	ManagedClusterStorageProfileDiskCSIDriver	AzureDisk CSI Driver settings for the storage profile.
fileCSIDriver	ManagedClusterStorageProfileFileCSIDriver	AzureFile CSI Driver settings for the storage profile.
snapshotController	ManagedClusterStorageProfileSnapshotController	Snapshot Controller settings for the storage profile.

ManagedClusterStorageProfileBlobCSIDriver

AzureBlob CSI Driver settings for the storage profile.

Name	Type	Description
enabled	boolean	Whether to enable AzureBlob CSI Driver. The default value is false.

ManagedClusterStorageProfileDiskCSIDriver

AzureDisk CSI Driver settings for the storage profile.

Name	Type	Description
enabled	boolean	Whether to enable AzureDisk CSI Driver. The default value is true.

ManagedClusterStorageProfileFileCSIDriver

AzureFile CSI Driver settings for the storage profile.

Name	Type	Description
enabled	boolean	Whether to enable AzureFile CSI Driver. The default value is true.

ManagedClusterStorageProfileSnapshotController

Snapshot Controller settings for the storage profile.

Name	Type	Description
enabled	boolean	Whether to enable Snapshot Controller. The default value is true.

ManagedClusterWindowsProfile

Profile for Windows VMs in the managed cluster.

Name	Type	Description
adminPassword	string	Specifies the password of the administrator account. Minimum-length: 8 characters Max-length: 123 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"
adminUsername	string	Specifies the name of the administrator account. Restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length: 1 character Max-length: 20 characters
enableCSIProxy	boolean	Whether to enable CSI proxy. For more details on CSI proxy, see the CSI proxy GitHub repo.
gmsaProfile	WindowsGmsaProfile	The Windows gMSA Profile in the Managed Cluster.
licenseType	licenseType	The license type to use for Windows VMs. See Azure Hybrid User Benefits for more details.

ManagedClusterWorkloadAutoScalerProfile

Workload Auto-scaler profile for the managed cluster.

Name	Type	Description
keda	ManagedClusterWorkloadAutoScalerProfileKeda	KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.
verticalPodAutoscaler	ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler	VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.

ManagedClusterWorkloadAutoScalerProfileKeda

KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.

Name	Type	Description
enabled	boolean	Whether to enable KEDA.

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.

Name	Type	Default value	Description
enabled	boolean	False	Whether to enable VPA. Default value is false.

ManagedOutboundIPs

Desired managed outbound IPs for the cluster load balancer.

Name	Type	Default value	Description
count	integer	1	The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
countIPv6	integer	0	The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack.

networkDataplane

Network dataplane used in the Kubernetes cluster.

Name	Type	Description
azure	string	Use Azure network dataplane.
cilium	string	Use Cilium network dataplane. See Azure CNI Powered by Cilium for more information.

networkMode

The network mode Azure CNI is configured with.

Name	Type	Description
bridge	string	This is no longer supported
transparent	string	No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See Transparent Mode for more information.

NetworkPlugin

Network plugin used for building the Kubernetes network.

Name	Type	Description
azure	string	Use the Azure CNI network plugin. See Azure CNI (advanced) networking for more information.
kubenet	string	Use the Kubenet network plugin. See Kubenet (basic) networking for more information.
none	string	No CNI plugin is pre-installed. See BYO CNI for more information.

NetworkPluginMode

The mode the network plugin should use.

Name	Type	Description
overlay	string	Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay.

NetworkPolicy

Network policy used for building the Kubernetes network.

Name	Type	Description
azure	string	Use Azure network policies. See differences between Azure and Calico policies for more information.
calico	string	Use Calico network policies. See differences between Azure and Calico policies for more information.
cilium	string	Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'.
none	string	Network policies will not be enforced. This is the default value when NetworkPolicy is not specified.

nodeOSUpgradeChannel

Node OS Upgrade Channel

Name	Type	Description
NodeImage	string	AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images.
None	string	No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates
SecurityPatch	string	AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption.
Unmanaged	string	OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice

OSDiskType

The OS disk type to be used for machines in the agent pool.

Name	Type	Description
Ephemeral	string	Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades.
Managed	string	Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency.

OSSKU

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

Name	Type	Description
AzureLinux	string	Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information.
CBLMariner	string	Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead.
Ubuntu	string	Use Ubuntu as the OS for node images.
Windows2019	string	Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa.
Windows2022	string	Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa.

OSType

The operating system type. The default is Linux.

Name	Type	Description
Linux	string	Use Linux.
Windows	string	Use Windows.

OutboundIPPrefixes

Desired outbound IP Prefix resources for the cluster load balancer.

Name	Type	Description
publicIPPrefixes	ResourceReference[]	A list of public IP prefix resources.

OutboundIPs

Desired outbound IP resources for the cluster load balancer.

Name	Type	Description
publicIPs	ResourceReference[]	A list of public IP resources.

outboundType

The outbound (egress) routing method.

Name	Type	Description
loadBalancer	string	The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see outbound type loadbalancer.
managedNATGateway	string	The AKS-managed NAT gateway is used for egress.
userAssignedNATGateway	string	The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration.
userDefinedRouting	string	Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see outbound type userDefinedRouting.

PortRange

The port range.

Name	Type	Description
portEnd	integer	The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.
portStart	integer	The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.
protocol	Protocol	The network protocol of the port.

PowerState

Describes the Power State of the cluster

Name	Type	Description
code	code	Tells whether the cluster is Running or Stopped

PrivateLinkResource

A private link resource

Name	Type	Description
groupId	string	The group ID of the resource.
id	string	The ID of the private link resource.
name	string	The name of the private link resource.
privateLinkServiceID	string	The private link service ID of the resource, this field is exposed only to NRP internally.
requiredMembers	string[]	The RequiredMembers of the resource
type	string	The resource type.

Protocol

The network protocol of the port.

Name	Type	Description
TCP	string	TCP protocol.
UDP	string	UDP protocol.

ProvisioningInfo

Name	Type	Description
error	ManagedClusterPodIdentityProvisioningError	Pod identity assignment error (if any).

PublicNetworkAccess

PublicNetworkAccess of the managedCluster

Name	Type	Description
Disabled	string
Enabled	string

ResourceIdentityType

The type of identity used for the managed cluster.

Name	Type	Description
None	string	Do not use a managed identity for the Managed Cluster, service principal will be used instead.
SystemAssigned	string	Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources.
UserAssigned	string	Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources.

ResourceReference

A reference to an Azure resource.

Name	Type	Description
id	string	The fully qualified Azure resource id.

RestrictionLevel

The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'

Name	Type	Description
ReadOnly	string	Only */read RBAC permissions allowed on the managed node resource group
Unrestricted	string	All RBAC permissions are allowed on the managed node resource group

ScaleDownMode

Describes how VMs are added to or removed from Agent Pools. See billing states.

Name	Type	Description
Deallocate	string	Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down.
Delete	string	Create new instances during scale up and remove instances during scale down.

ScaleSetEvictionPolicy

The Virtual Machine Scale Set eviction policy.

Name	Type	Description
Deallocate	string	Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading.
Delete	string	Nodes in the underlying Scale Set of the node pool are deleted when they're evicted.

ScaleSetPriority

The Virtual Machine Scale Set priority.

Name	Type	Description
Regular	string	Regular VMs will be used.
Spot	string	Spot priority VMs will be used. There is no SLA for spot nodes. See spot on AKS for more information.

ServiceMeshMode

Mode of the service mesh.

Name	Type	Description
Disabled	string	Mesh is disabled.
Istio	string	Istio deployed as an AKS addon.

ServiceMeshProfile

Service mesh profile for a managed cluster.

Name	Type	Description
istio	IstioServiceMesh	Istio service mesh configuration.
mode	ServiceMeshMode	Mode of the service mesh.

SysctlConfig

Sysctl settings for Linux agent nodes.

Name	Type	Description
fsAioMaxNr	integer	Sysctl setting fs.aio-max-nr.
fsFileMax	integer	Sysctl setting fs.file-max.
fsInotifyMaxUserWatches	integer	Sysctl setting fs.inotify.max_user_watches.
fsNrOpen	integer	Sysctl setting fs.nr_open.
kernelThreadsMax	integer	Sysctl setting kernel.threads-max.
netCoreNetdevMaxBacklog	integer	Sysctl setting net.core.netdev_max_backlog.
netCoreOptmemMax	integer	Sysctl setting net.core.optmem_max.
netCoreRmemDefault	integer	Sysctl setting net.core.rmem_default.
netCoreRmemMax	integer	Sysctl setting net.core.rmem_max.
netCoreSomaxconn	integer	Sysctl setting net.core.somaxconn.
netCoreWmemDefault	integer	Sysctl setting net.core.wmem_default.
netCoreWmemMax	integer	Sysctl setting net.core.wmem_max.
netIpv4IpLocalPortRange	string	Sysctl setting net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1	integer	Sysctl setting net.ipv4.neigh.default.gc_thresh1.
netIpv4NeighDefaultGcThresh2	integer	Sysctl setting net.ipv4.neigh.default.gc_thresh2.
netIpv4NeighDefaultGcThresh3	integer	Sysctl setting net.ipv4.neigh.default.gc_thresh3.
netIpv4TcpFinTimeout	integer	Sysctl setting net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes	integer	Sysctl setting net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime	integer	Sysctl setting net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog	integer	Sysctl setting net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets	integer	Sysctl setting net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse	boolean	Sysctl setting net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl	integer	Sysctl setting net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets	integer	Sysctl setting net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax	integer	Sysctl setting net.netfilter.nf_conntrack_max.
vmMaxMapCount	integer	Sysctl setting vm.max_map_count.
vmSwappiness	integer	Sysctl setting vm.swappiness.
vmVfsCachePressure	integer	Sysctl setting vm.vfs_cache_pressure.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

upgradeChannel

The upgrade channel for auto upgrade. The default is 'none'.

Name	Type	Description
node-image	string	Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching
none	string	Disables auto-upgrades and keeps the cluster at its current version of Kubernetes.
patch	string	Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9.
rapid	string	Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1.
stable	string	Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6.

UpgradeOverrideSettings

Settings for overrides when upgrading a cluster.

Name	Type	Description
forceUpgrade	boolean	Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution.
until	string	Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect.

UserAssignedIdentities

The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.

Name	Type	Description

UserAssignedIdentity

Details about a user assigned identity.

Name	Type	Description
clientId	string	The client ID of the user assigned identity.
objectId	string	The object ID of the user assigned identity.
resourceId	string	The resource ID of the user assigned identity.

WindowsGmsaProfile

Windows gMSA Profile in the managed cluster.

Name	Type	Description
dnsServer	string	Specifies the DNS server for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.
enabled	boolean	Whether to enable Windows gMSA. Specifies whether to enable Windows gMSA in the managed cluster.
rootDomainName	string	Specifies the root domain name for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

WorkloadRuntime

Determines the type of workload a node can run.

Name	Type	Description
OCIContainer	string	Nodes will use Kubelet to run standard OCI container workloads.
WasmWasi	string	Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview).

Share via