containerservice.azure.com/v1api20231102preview

APIVersion

Value Description
“2023-11-02-preview”

ManagedCluster

Used by: ManagedClusterList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec ManagedCluster_Spec
Optional
status ManagedCluster_STATUS
Optional

ManagedCluster_Spec

Property Description Type
aadProfile ManagedClusterAADProfile
Optional
addonProfiles map[string]ManagedClusterAddonProfile
Optional
agentPoolProfiles ManagedClusterAgentPoolProfile[]
Optional
aiToolchainOperatorProfile ManagedClusterAIToolchainOperatorProfile
Optional
apiServerAccessProfile ManagedClusterAPIServerAccessProfile
Optional
autoScalerProfile ManagedClusterProperties_AutoScalerProfile
Optional
autoUpgradeProfile ManagedClusterAutoUpgradeProfile
Optional
azureMonitorProfile ManagedClusterAzureMonitorProfile
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
creationData CreationData
Optional
disableLocalAccounts bool
Optional
diskEncryptionSetReference genruntime.ResourceReference
Optional
dnsPrefix string
Optional
enableNamespaceResources bool
Optional
enablePodSecurityPolicy bool
Optional
enableRBAC bool
Optional
extendedLocation ExtendedLocation
Optional
fqdnSubdomain string
Optional
httpProxyConfig ManagedClusterHTTPProxyConfig
Optional
identity ManagedClusterIdentity
Optional
identityProfile map[string]UserAssignedIdentity
Optional
ingressProfile ManagedClusterIngressProfile
Optional
kubernetesVersion string
Optional
linuxProfile ContainerServiceLinuxProfile
Optional
location string
Required
metricsProfile ManagedClusterMetricsProfile
Optional
networkProfile ContainerServiceNetworkProfile
Optional
nodeProvisioningProfile ManagedClusterNodeProvisioningProfile
Optional
nodeResourceGroup string
Optional
nodeResourceGroupProfile ManagedClusterNodeResourceGroupProfile
Optional
oidcIssuerProfile ManagedClusterOIDCIssuerProfile
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ManagedClusterOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
podIdentityProfile ManagedClusterPodIdentityProfile
Optional
privateLinkResources PrivateLinkResource[]
Optional
publicNetworkAccess ManagedClusterProperties_PublicNetworkAccess
Optional
safeguardsProfile SafeguardsProfile
Optional
securityProfile ManagedClusterSecurityProfile
Optional
serviceMeshProfile ServiceMeshProfile
Optional
servicePrincipalProfile ManagedClusterServicePrincipalProfile
Optional
sku ManagedClusterSKU
Optional
storageProfile ManagedClusterStorageProfile
Optional
supportPlan KubernetesSupportPlan
Optional
tags map[string]string
Optional
upgradeSettings ClusterUpgradeSettings
Optional
windowsProfile ManagedClusterWindowsProfile
Optional
workloadAutoScalerProfile ManagedClusterWorkloadAutoScalerProfile
Optional

ManagedCluster_STATUS

Property Description Type
aadProfile ManagedClusterAADProfile_STATUS
Optional
addonProfiles map[string]ManagedClusterAddonProfile_STATUS
Optional
agentPoolProfiles ManagedClusterAgentPoolProfile_STATUS[]
Optional
aiToolchainOperatorProfile ManagedClusterAIToolchainOperatorProfile_STATUS
Optional
apiServerAccessProfile ManagedClusterAPIServerAccessProfile_STATUS
Optional
autoScalerProfile ManagedClusterProperties_AutoScalerProfile_STATUS
Optional
autoUpgradeProfile ManagedClusterAutoUpgradeProfile_STATUS
Optional
azureMonitorProfile ManagedClusterAzureMonitorProfile_STATUS
Optional
azurePortalFQDN string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
creationData CreationData_STATUS
Optional
currentKubernetesVersion string
Optional
disableLocalAccounts bool
Optional
diskEncryptionSetID string
Optional
dnsPrefix string
Optional
enableNamespaceResources bool
Optional
enablePodSecurityPolicy bool
Optional
enableRBAC bool
Optional
extendedLocation ExtendedLocation_STATUS
Optional
fqdn string
Optional
fqdnSubdomain string
Optional
httpProxyConfig ManagedClusterHTTPProxyConfig_STATUS
Optional
id string
Optional
identity ManagedClusterIdentity_STATUS
Optional
identityProfile map[string]UserAssignedIdentity_STATUS
Optional
ingressProfile ManagedClusterIngressProfile_STATUS
Optional
kubernetesVersion string
Optional
linuxProfile ContainerServiceLinuxProfile_STATUS
Optional
location string
Optional
maxAgentPools int
Optional
metricsProfile ManagedClusterMetricsProfile_STATUS
Optional
name string
Optional
networkProfile ContainerServiceNetworkProfile_STATUS
Optional
nodeProvisioningProfile ManagedClusterNodeProvisioningProfile_STATUS
Optional
nodeResourceGroup string
Optional
nodeResourceGroupProfile ManagedClusterNodeResourceGroupProfile_STATUS
Optional
oidcIssuerProfile ManagedClusterOIDCIssuerProfile_STATUS
Optional
podIdentityProfile ManagedClusterPodIdentityProfile_STATUS
Optional
powerState PowerState_STATUS
Optional
privateFQDN string
Optional
privateLinkResources PrivateLinkResource_STATUS[]
Optional
provisioningState string
Optional
publicNetworkAccess ManagedClusterProperties_PublicNetworkAccess_STATUS
Optional
resourceUID string
Optional
safeguardsProfile SafeguardsProfile_STATUS
Optional
securityProfile ManagedClusterSecurityProfile_STATUS
Optional
serviceMeshProfile ServiceMeshProfile_STATUS
Optional
servicePrincipalProfile ManagedClusterServicePrincipalProfile_STATUS
Optional
sku ManagedClusterSKU_STATUS
Optional
storageProfile ManagedClusterStorageProfile_STATUS
Optional
supportPlan KubernetesSupportPlan_STATUS
Optional
systemData SystemData_STATUS
Optional
tags map[string]string
Optional
type string
Optional
upgradeSettings ClusterUpgradeSettings_STATUS
Optional
windowsProfile ManagedClusterWindowsProfile_STATUS
Optional
workloadAutoScalerProfile ManagedClusterWorkloadAutoScalerProfile_STATUS
Optional

ManagedClusterList

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items ManagedCluster[]
Optional

ManagedClustersAgentPool

Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/managedClusters.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}

Used by: ManagedClustersAgentPoolList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec ManagedClustersAgentPool_Spec
Optional
status ManagedClustersAgentPool_STATUS
Optional

ManagedClustersAgentPool_Spec

Property Description Type
artifactStreamingProfile Configuration for using artifact streaming on AKS. AgentPoolArtifactStreamingProfile
Optional
availabilityZones The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. string[]
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
capacityReservationGroupReference AKS will associate the specified agent pool with the Capacity Reservation Group. genruntime.ResourceReference
Optional
count 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. int
Optional
creationData CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. CreationData
Optional
enableAutoScaling Whether to enable auto-scaler bool
Optional
enableCustomCATrust When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false. bool
Optional
enableEncryptionAtHost 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 bool
Optional
enableFIPS See Add a FIPS-enabled node pool for more details. bool
Optional
enableNodePublicIP 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. bool
Optional
enableUltraSSD Whether to enable UltraSSD bool
Optional
gpuInstanceProfile GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. GPUInstanceProfile
Optional
gpuProfile The GPU settings of an agent pool. AgentPoolGPUProfile
Optional
hostGroupReference This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. genruntime.ResourceReference
Optional
kubeletConfig The Kubelet configuration on the agent pool nodes. KubeletConfig
Optional
kubeletDiskType Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. KubeletDiskType
Optional
linuxOSConfig The OS configuration of Linux agent nodes. LinuxOSConfig
Optional
maxCount The maximum number of nodes for auto-scaling int
Optional
maxPods The maximum number of pods that can run on a node. int
Optional
messageOfTheDay A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). string
Optional
minCount The minimum number of nodes for auto-scaling int
Optional
mode 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 AgentPoolMode
Optional
networkProfile Network-related settings of an agent pool. AgentPoolNetworkProfile
Optional
nodeInitializationTaints These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example ‘key1=value1:NoSchedule’ that then can be removed with kubectl taint nodes node1 key1=value1:NoSchedule- string[]
Optional
nodeLabels The node labels to be persisted across all nodes in agent pool. map[string]string
Optional
nodePublicIPPrefixReference This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} genruntime.ResourceReference
Optional
nodeTaints The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. string[]
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ManagedClustersAgentPoolOperatorSpec
Optional
orchestratorVersion Both patch version <major.minor.patch> and <major.minor> are supported. When <major.minor> is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same <major.minor> once it has been created 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. string
Optional
osDiskSizeGB ContainerServiceOSDisk
Optional
osDiskType 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. OSDiskType
Optional
osSKU Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated. OSSKU
Optional
osType The operating system type. The default is Linux. OSType
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/ManagedCluster resource genruntime.KnownResourceReference
Required
podSubnetReference 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} genruntime.ResourceReference
Optional
powerState 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 PowerState
Optional
proximityPlacementGroupReference The ID for Proximity Placement Group. genruntime.ResourceReference
Optional
scaleDownMode This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ScaleDownMode
Optional
scaleSetEvictionPolicy This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. ScaleSetEvictionPolicy
Optional
scaleSetPriority The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. ScaleSetPriority
Optional
securityProfile The security settings of an agent pool. AgentPoolSecurityProfile
Optional
spotMaxPrice 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 float64
Optional
tags The tags to be persisted on the agent pool virtual machine scale set. map[string]string
Optional
type The type of Agent Pool. AgentPoolType
Optional
upgradeSettings Settings for upgrading the agentpool AgentPoolUpgradeSettings
Optional
virtualMachineNodesStatus VirtualMachineNodes[]
Optional
virtualMachinesProfile Specifications on VirtualMachines agent pool. VirtualMachinesProfile
Optional
vmSize 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 string
Optional
vnetSubnetReference 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} genruntime.ResourceReference
Optional
windowsProfile The Windows agent pool’s specific profile. AgentPoolWindowsProfile
Optional
workloadRuntime Determines the type of workload a node can run. WorkloadRuntime
Optional

ManagedClustersAgentPool_STATUS

Property Description Type
artifactStreamingProfile Configuration for using artifact streaming on AKS. AgentPoolArtifactStreamingProfile_STATUS
Optional
availabilityZones The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. string[]
Optional
capacityReservationGroupID AKS will associate the specified agent pool with the Capacity Reservation Group. string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
count 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. int
Optional
creationData CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. CreationData_STATUS
Optional
currentOrchestratorVersion If orchestratorVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used. string
Optional
enableAutoScaling Whether to enable auto-scaler bool
Optional
enableCustomCATrust When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false. bool
Optional
enableEncryptionAtHost 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 bool
Optional
enableFIPS See Add a FIPS-enabled node pool for more details. bool
Optional
enableNodePublicIP 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. bool
Optional
enableUltraSSD Whether to enable UltraSSD bool
Optional
gpuInstanceProfile GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. GPUInstanceProfile_STATUS
Optional
gpuProfile The GPU settings of an agent pool. AgentPoolGPUProfile_STATUS
Optional
hostGroupID This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. string
Optional
id Resource ID. string
Optional
kubeletConfig The Kubelet configuration on the agent pool nodes. KubeletConfig_STATUS
Optional
kubeletDiskType Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. KubeletDiskType_STATUS
Optional
linuxOSConfig The OS configuration of Linux agent nodes. LinuxOSConfig_STATUS
Optional
maxCount The maximum number of nodes for auto-scaling int
Optional
maxPods The maximum number of pods that can run on a node. int
Optional
messageOfTheDay A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). string
Optional
minCount The minimum number of nodes for auto-scaling int
Optional
mode 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 AgentPoolMode_STATUS
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
networkProfile Network-related settings of an agent pool. AgentPoolNetworkProfile_STATUS
Optional
nodeImageVersion The version of node image string
Optional
nodeInitializationTaints These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example ‘key1=value1:NoSchedule’ that then can be removed with kubectl taint nodes node1 key1=value1:NoSchedule- string[]
Optional
nodeLabels The node labels to be persisted across all nodes in agent pool. map[string]string
Optional
nodePublicIPPrefixID This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} string
Optional
nodeTaints The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. string[]
Optional
orchestratorVersion Both patch version <major.minor.patch> and <major.minor> are supported. When <major.minor> is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same <major.minor> once it has been created 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. string
Optional
osDiskSizeGB int
Optional
osDiskType 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. OSDiskType_STATUS
Optional
osSKU Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated. OSSKU_STATUS
Optional
osType The operating system type. The default is Linux. OSType_STATUS
Optional
podSubnetID 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} string
Optional
powerState 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 PowerState_STATUS
Optional
properties_type The type of Agent Pool. AgentPoolType_STATUS
Optional
provisioningState The current deployment or provisioning state. string
Optional
proximityPlacementGroupID The ID for Proximity Placement Group. string
Optional
scaleDownMode This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ScaleDownMode_STATUS
Optional
scaleSetEvictionPolicy This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. ScaleSetEvictionPolicy_STATUS
Optional
scaleSetPriority The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. ScaleSetPriority_STATUS
Optional
securityProfile The security settings of an agent pool. AgentPoolSecurityProfile_STATUS
Optional
spotMaxPrice 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 float64
Optional
tags The tags to be persisted on the agent pool virtual machine scale set. map[string]string
Optional
type Resource type string
Optional
upgradeSettings Settings for upgrading the agentpool AgentPoolUpgradeSettings_STATUS
Optional
virtualMachineNodesStatus VirtualMachineNodes_STATUS[]
Optional
virtualMachinesProfile Specifications on VirtualMachines agent pool. VirtualMachinesProfile_STATUS
Optional
vmSize 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 string
Optional
vnetSubnetID 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} string
Optional
windowsProfile The Windows agent pool’s specific profile. AgentPoolWindowsProfile_STATUS
Optional
workloadRuntime Determines the type of workload a node can run. WorkloadRuntime_STATUS
Optional

ManagedClustersAgentPoolList

Generator information: - Generated from: /containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/managedClusters.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items ManagedClustersAgentPool[]
Optional

ManagedCluster_Spec

Used by: ManagedCluster.

Property Description Type
aadProfile ManagedClusterAADProfile
Optional
addonProfiles map[string]ManagedClusterAddonProfile
Optional
agentPoolProfiles ManagedClusterAgentPoolProfile[]
Optional
aiToolchainOperatorProfile ManagedClusterAIToolchainOperatorProfile
Optional
apiServerAccessProfile ManagedClusterAPIServerAccessProfile
Optional
autoScalerProfile ManagedClusterProperties_AutoScalerProfile
Optional
autoUpgradeProfile ManagedClusterAutoUpgradeProfile
Optional
azureMonitorProfile ManagedClusterAzureMonitorProfile
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
creationData CreationData
Optional
disableLocalAccounts bool
Optional
diskEncryptionSetReference genruntime.ResourceReference
Optional
dnsPrefix string
Optional
enableNamespaceResources bool
Optional
enablePodSecurityPolicy bool
Optional
enableRBAC bool
Optional
extendedLocation ExtendedLocation
Optional
fqdnSubdomain string
Optional
httpProxyConfig ManagedClusterHTTPProxyConfig
Optional
identity ManagedClusterIdentity
Optional
identityProfile map[string]UserAssignedIdentity
Optional
ingressProfile ManagedClusterIngressProfile
Optional
kubernetesVersion string
Optional
linuxProfile ContainerServiceLinuxProfile
Optional
location string
Required
metricsProfile ManagedClusterMetricsProfile
Optional
networkProfile ContainerServiceNetworkProfile
Optional
nodeProvisioningProfile ManagedClusterNodeProvisioningProfile
Optional
nodeResourceGroup string
Optional
nodeResourceGroupProfile ManagedClusterNodeResourceGroupProfile
Optional
oidcIssuerProfile ManagedClusterOIDCIssuerProfile
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ManagedClusterOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
podIdentityProfile ManagedClusterPodIdentityProfile
Optional
privateLinkResources PrivateLinkResource[]
Optional
publicNetworkAccess ManagedClusterProperties_PublicNetworkAccess
Optional
safeguardsProfile SafeguardsProfile
Optional
securityProfile ManagedClusterSecurityProfile
Optional
serviceMeshProfile ServiceMeshProfile
Optional
servicePrincipalProfile ManagedClusterServicePrincipalProfile
Optional
sku ManagedClusterSKU
Optional
storageProfile ManagedClusterStorageProfile
Optional
supportPlan KubernetesSupportPlan
Optional
tags map[string]string
Optional
upgradeSettings ClusterUpgradeSettings
Optional
windowsProfile ManagedClusterWindowsProfile
Optional
workloadAutoScalerProfile ManagedClusterWorkloadAutoScalerProfile
Optional

ManagedCluster_STATUS

Used by: ManagedCluster.

Property Description Type
aadProfile ManagedClusterAADProfile_STATUS
Optional
addonProfiles map[string]ManagedClusterAddonProfile_STATUS
Optional
agentPoolProfiles ManagedClusterAgentPoolProfile_STATUS[]
Optional
aiToolchainOperatorProfile ManagedClusterAIToolchainOperatorProfile_STATUS
Optional
apiServerAccessProfile ManagedClusterAPIServerAccessProfile_STATUS
Optional
autoScalerProfile ManagedClusterProperties_AutoScalerProfile_STATUS
Optional
autoUpgradeProfile ManagedClusterAutoUpgradeProfile_STATUS
Optional
azureMonitorProfile ManagedClusterAzureMonitorProfile_STATUS
Optional
azurePortalFQDN string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
creationData CreationData_STATUS
Optional
currentKubernetesVersion string
Optional
disableLocalAccounts bool
Optional
diskEncryptionSetID string
Optional
dnsPrefix string
Optional
enableNamespaceResources bool
Optional
enablePodSecurityPolicy bool
Optional
enableRBAC bool
Optional
extendedLocation ExtendedLocation_STATUS
Optional
fqdn string
Optional
fqdnSubdomain string
Optional
httpProxyConfig ManagedClusterHTTPProxyConfig_STATUS
Optional
id string
Optional
identity ManagedClusterIdentity_STATUS
Optional
identityProfile map[string]UserAssignedIdentity_STATUS
Optional
ingressProfile ManagedClusterIngressProfile_STATUS
Optional
kubernetesVersion string
Optional
linuxProfile ContainerServiceLinuxProfile_STATUS
Optional
location string
Optional
maxAgentPools int
Optional
metricsProfile ManagedClusterMetricsProfile_STATUS
Optional
name string
Optional
networkProfile ContainerServiceNetworkProfile_STATUS
Optional
nodeProvisioningProfile ManagedClusterNodeProvisioningProfile_STATUS
Optional
nodeResourceGroup string
Optional
nodeResourceGroupProfile ManagedClusterNodeResourceGroupProfile_STATUS
Optional
oidcIssuerProfile ManagedClusterOIDCIssuerProfile_STATUS
Optional
podIdentityProfile ManagedClusterPodIdentityProfile_STATUS
Optional
powerState PowerState_STATUS
Optional
privateFQDN string
Optional
privateLinkResources PrivateLinkResource_STATUS[]
Optional
provisioningState string
Optional
publicNetworkAccess ManagedClusterProperties_PublicNetworkAccess_STATUS
Optional
resourceUID string
Optional
safeguardsProfile SafeguardsProfile_STATUS
Optional
securityProfile ManagedClusterSecurityProfile_STATUS
Optional
serviceMeshProfile ServiceMeshProfile_STATUS
Optional
servicePrincipalProfile ManagedClusterServicePrincipalProfile_STATUS
Optional
sku ManagedClusterSKU_STATUS
Optional
storageProfile ManagedClusterStorageProfile_STATUS
Optional
supportPlan KubernetesSupportPlan_STATUS
Optional
systemData SystemData_STATUS
Optional
tags map[string]string
Optional
type string
Optional
upgradeSettings ClusterUpgradeSettings_STATUS
Optional
windowsProfile ManagedClusterWindowsProfile_STATUS
Optional
workloadAutoScalerProfile ManagedClusterWorkloadAutoScalerProfile_STATUS
Optional

ManagedClustersAgentPool_Spec

Used by: ManagedClustersAgentPool.

Property Description Type
artifactStreamingProfile Configuration for using artifact streaming on AKS. AgentPoolArtifactStreamingProfile
Optional
availabilityZones The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. string[]
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
capacityReservationGroupReference AKS will associate the specified agent pool with the Capacity Reservation Group. genruntime.ResourceReference
Optional
count 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. int
Optional
creationData CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. CreationData
Optional
enableAutoScaling Whether to enable auto-scaler bool
Optional
enableCustomCATrust When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false. bool
Optional
enableEncryptionAtHost 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 bool
Optional
enableFIPS See Add a FIPS-enabled node pool for more details. bool
Optional
enableNodePublicIP 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. bool
Optional
enableUltraSSD Whether to enable UltraSSD bool
Optional
gpuInstanceProfile GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. GPUInstanceProfile
Optional
gpuProfile The GPU settings of an agent pool. AgentPoolGPUProfile
Optional
hostGroupReference This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. genruntime.ResourceReference
Optional
kubeletConfig The Kubelet configuration on the agent pool nodes. KubeletConfig
Optional
kubeletDiskType Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. KubeletDiskType
Optional
linuxOSConfig The OS configuration of Linux agent nodes. LinuxOSConfig
Optional
maxCount The maximum number of nodes for auto-scaling int
Optional
maxPods The maximum number of pods that can run on a node. int
Optional
messageOfTheDay A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). string
Optional
minCount The minimum number of nodes for auto-scaling int
Optional
mode 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 AgentPoolMode
Optional
networkProfile Network-related settings of an agent pool. AgentPoolNetworkProfile
Optional
nodeInitializationTaints These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example ‘key1=value1:NoSchedule’ that then can be removed with kubectl taint nodes node1 key1=value1:NoSchedule- string[]
Optional
nodeLabels The node labels to be persisted across all nodes in agent pool. map[string]string
Optional
nodePublicIPPrefixReference This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} genruntime.ResourceReference
Optional
nodeTaints The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. string[]
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ManagedClustersAgentPoolOperatorSpec
Optional
orchestratorVersion Both patch version <major.minor.patch> and <major.minor> are supported. When <major.minor> is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same <major.minor> once it has been created 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. string
Optional
osDiskSizeGB ContainerServiceOSDisk
Optional
osDiskType 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. OSDiskType
Optional
osSKU Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated. OSSKU
Optional
osType The operating system type. The default is Linux. OSType
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a containerservice.azure.com/ManagedCluster resource genruntime.KnownResourceReference
Required
podSubnetReference 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} genruntime.ResourceReference
Optional
powerState 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 PowerState
Optional
proximityPlacementGroupReference The ID for Proximity Placement Group. genruntime.ResourceReference
Optional
scaleDownMode This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ScaleDownMode
Optional
scaleSetEvictionPolicy This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. ScaleSetEvictionPolicy
Optional
scaleSetPriority The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. ScaleSetPriority
Optional
securityProfile The security settings of an agent pool. AgentPoolSecurityProfile
Optional
spotMaxPrice 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 float64
Optional
tags The tags to be persisted on the agent pool virtual machine scale set. map[string]string
Optional
type The type of Agent Pool. AgentPoolType
Optional
upgradeSettings Settings for upgrading the agentpool AgentPoolUpgradeSettings
Optional
virtualMachineNodesStatus VirtualMachineNodes[]
Optional
virtualMachinesProfile Specifications on VirtualMachines agent pool. VirtualMachinesProfile
Optional
vmSize 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 string
Optional
vnetSubnetReference 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} genruntime.ResourceReference
Optional
windowsProfile The Windows agent pool’s specific profile. AgentPoolWindowsProfile
Optional
workloadRuntime Determines the type of workload a node can run. WorkloadRuntime
Optional

ManagedClustersAgentPool_STATUS

Used by: ManagedClustersAgentPool.

Property Description Type
artifactStreamingProfile Configuration for using artifact streaming on AKS. AgentPoolArtifactStreamingProfile_STATUS
Optional
availabilityZones The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’. string[]
Optional
capacityReservationGroupID AKS will associate the specified agent pool with the Capacity Reservation Group. string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
count 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. int
Optional
creationData CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. CreationData_STATUS
Optional
currentOrchestratorVersion If orchestratorVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used. string
Optional
enableAutoScaling Whether to enable auto-scaler bool
Optional
enableCustomCATrust When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false. bool
Optional
enableEncryptionAtHost 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 bool
Optional
enableFIPS See Add a FIPS-enabled node pool for more details. bool
Optional
enableNodePublicIP 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. bool
Optional
enableUltraSSD Whether to enable UltraSSD bool
Optional
gpuInstanceProfile GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. GPUInstanceProfile_STATUS
Optional
gpuProfile The GPU settings of an agent pool. AgentPoolGPUProfile_STATUS
Optional
hostGroupID This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. string
Optional
id Resource ID. string
Optional
kubeletConfig The Kubelet configuration on the agent pool nodes. KubeletConfig_STATUS
Optional
kubeletDiskType Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. KubeletDiskType_STATUS
Optional
linuxOSConfig The OS configuration of Linux agent nodes. LinuxOSConfig_STATUS
Optional
maxCount The maximum number of nodes for auto-scaling int
Optional
maxPods The maximum number of pods that can run on a node. int
Optional
messageOfTheDay A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). string
Optional
minCount The minimum number of nodes for auto-scaling int
Optional
mode 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 AgentPoolMode_STATUS
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
networkProfile Network-related settings of an agent pool. AgentPoolNetworkProfile_STATUS
Optional
nodeImageVersion The version of node image string
Optional
nodeInitializationTaints These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example ‘key1=value1:NoSchedule’ that then can be removed with kubectl taint nodes node1 key1=value1:NoSchedule- string[]
Optional
nodeLabels The node labels to be persisted across all nodes in agent pool. map[string]string
Optional
nodePublicIPPrefixID This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} string
Optional
nodeTaints The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. string[]
Optional
orchestratorVersion Both patch version <major.minor.patch> and <major.minor> are supported. When <major.minor> is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same <major.minor> once it has been created 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. string
Optional
osDiskSizeGB int
Optional
osDiskType 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. OSDiskType_STATUS
Optional
osSKU Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated. OSSKU_STATUS
Optional
osType The operating system type. The default is Linux. OSType_STATUS
Optional
podSubnetID 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} string
Optional
powerState 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 PowerState_STATUS
Optional
properties_type The type of Agent Pool. AgentPoolType_STATUS
Optional
provisioningState The current deployment or provisioning state. string
Optional
proximityPlacementGroupID The ID for Proximity Placement Group. string
Optional
scaleDownMode This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ScaleDownMode_STATUS
Optional
scaleSetEvictionPolicy This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’. ScaleSetEvictionPolicy_STATUS
Optional
scaleSetPriority The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’. ScaleSetPriority_STATUS
Optional
securityProfile The security settings of an agent pool. AgentPoolSecurityProfile_STATUS
Optional
spotMaxPrice 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 float64
Optional
tags The tags to be persisted on the agent pool virtual machine scale set. map[string]string
Optional
type Resource type string
Optional
upgradeSettings Settings for upgrading the agentpool AgentPoolUpgradeSettings_STATUS
Optional
virtualMachineNodesStatus VirtualMachineNodes_STATUS[]
Optional
virtualMachinesProfile Specifications on VirtualMachines agent pool. VirtualMachinesProfile_STATUS
Optional
vmSize 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 string
Optional
vnetSubnetID 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} string
Optional
windowsProfile The Windows agent pool’s specific profile. AgentPoolWindowsProfile_STATUS
Optional
workloadRuntime Determines the type of workload a node can run. WorkloadRuntime_STATUS
Optional

AgentPoolArtifactStreamingProfile

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
enabled bool
Optional

AgentPoolArtifactStreamingProfile_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
enabled bool
Optional

AgentPoolGPUProfile

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
installGPUDriver bool
Optional

AgentPoolGPUProfile_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
installGPUDriver bool
Optional

AgentPoolMode

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“System”
“User”

AgentPoolMode_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“System”
“User”

AgentPoolNetworkProfile

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
allowedHostPorts PortRange[]
Optional
applicationSecurityGroupsReferences genruntime.ResourceReference[]
Optional
nodePublicIPTags IPTag[]
Optional

AgentPoolNetworkProfile_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
allowedHostPorts PortRange_STATUS[]
Optional
applicationSecurityGroups string[]
Optional
nodePublicIPTags IPTag_STATUS[]
Optional

AgentPoolSecurityProfile

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
enableSecureBoot bool
Optional
enableVTPM bool
Optional
sshAccess AgentPoolSSHAccess
Optional

AgentPoolSecurityProfile_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
enableSecureBoot bool
Optional
enableVTPM bool
Optional
sshAccess AgentPoolSSHAccess_STATUS
Optional

AgentPoolType

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“AvailabilitySet”
“VirtualMachineScaleSets”
“VirtualMachines”

AgentPoolType_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“AvailabilitySet”
“VirtualMachineScaleSets”
“VirtualMachines”

AgentPoolUpgradeSettings

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
drainTimeoutInMinutes int
Optional
maxSurge string
Optional
nodeSoakDurationInMinutes int
Optional

AgentPoolUpgradeSettings_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
drainTimeoutInMinutes int
Optional
maxSurge string
Optional
nodeSoakDurationInMinutes int
Optional

AgentPoolWindowsProfile

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
disableOutboundNat bool
Optional

AgentPoolWindowsProfile_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
disableOutboundNat bool
Optional

ClusterUpgradeSettings

Used by: ManagedCluster_Spec.

Property Description Type
overrideSettings UpgradeOverrideSettings
Optional

ClusterUpgradeSettings_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
overrideSettings UpgradeOverrideSettings_STATUS
Optional

ContainerServiceLinuxProfile

Used by: ManagedCluster_Spec.

Property Description Type
adminUsername string
Required
ssh ContainerServiceSshConfiguration
Required

ContainerServiceLinuxProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
adminUsername string
Optional
ssh ContainerServiceSshConfiguration_STATUS
Optional

ContainerServiceNetworkProfile

Used by: ManagedCluster_Spec.

Property Description Type
dnsServiceIP string
Optional
ipFamilies IpFamily[]
Optional
kubeProxyConfig ContainerServiceNetworkProfile_KubeProxyConfig
Optional
loadBalancerProfile ManagedClusterLoadBalancerProfile
Optional
loadBalancerSku LoadBalancerSku
Optional
monitoring NetworkMonitoring
Optional
natGatewayProfile ManagedClusterNATGatewayProfile
Optional
networkDataplane NetworkDataplane
Optional
networkMode NetworkMode
Optional
networkPlugin NetworkPlugin
Optional
networkPluginMode NetworkPluginMode
Optional
networkPolicy NetworkPolicy
Optional
outboundType ContainerServiceNetworkProfile_OutboundType
Optional
podCidr string
Optional
podCidrs string[]
Optional
serviceCidr string
Optional
serviceCidrs string[]
Optional

ContainerServiceNetworkProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
dnsServiceIP string
Optional
ipFamilies IpFamily_STATUS[]
Optional
kubeProxyConfig ContainerServiceNetworkProfile_KubeProxyConfig_STATUS
Optional
loadBalancerProfile ManagedClusterLoadBalancerProfile_STATUS
Optional
loadBalancerSku LoadBalancerSku_STATUS
Optional
monitoring NetworkMonitoring_STATUS
Optional
natGatewayProfile ManagedClusterNATGatewayProfile_STATUS
Optional
networkDataplane NetworkDataplane_STATUS
Optional
networkMode NetworkMode_STATUS
Optional
networkPlugin NetworkPlugin_STATUS
Optional
networkPluginMode NetworkPluginMode_STATUS
Optional
networkPolicy NetworkPolicy_STATUS
Optional
outboundType ContainerServiceNetworkProfile_OutboundType_STATUS
Optional
podCidr string
Optional
podCidrs string[]
Optional
serviceCidr string
Optional
serviceCidrs string[]
Optional

ContainerServiceOSDisk

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

CreationData

Used by: ManagedCluster_Spec, ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
sourceResourceReference genruntime.ResourceReference
Optional

CreationData_STATUS

Used by: ManagedCluster_STATUS, ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
sourceResourceId string
Optional

ExtendedLocation

Used by: ManagedCluster_Spec.

Property Description Type
name string
Optional
type ExtendedLocationType
Optional

ExtendedLocation_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
name string
Optional
type ExtendedLocationType_STATUS
Optional

GPUInstanceProfile

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“MIG1g”
“MIG2g”
“MIG3g”
“MIG4g”
“MIG7g”

GPUInstanceProfile_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“MIG1g”
“MIG2g”
“MIG3g”
“MIG4g”
“MIG7g”

KubeletConfig

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
allowedUnsafeSysctls string[]
Optional
containerLogMaxFiles int
Optional
containerLogMaxSizeMB int
Optional
cpuCfsQuota bool
Optional
cpuCfsQuotaPeriod string
Optional
cpuManagerPolicy string
Optional
failSwapOn bool
Optional
imageGcHighThreshold int
Optional
imageGcLowThreshold int
Optional
podMaxPids int
Optional
topologyManagerPolicy string
Optional

KubeletConfig_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
allowedUnsafeSysctls string[]
Optional
containerLogMaxFiles int
Optional
containerLogMaxSizeMB int
Optional
cpuCfsQuota bool
Optional
cpuCfsQuotaPeriod string
Optional
cpuManagerPolicy string
Optional
failSwapOn bool
Optional
imageGcHighThreshold int
Optional
imageGcLowThreshold int
Optional
podMaxPids int
Optional
topologyManagerPolicy string
Optional

KubeletDiskType

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“OS”
“Temporary”

KubeletDiskType_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“OS”
“Temporary”

KubernetesSupportPlan

Used by: ManagedCluster_Spec.

Value Description
“AKSLongTermSupport”
“KubernetesOfficial”

KubernetesSupportPlan_STATUS

Used by: ManagedCluster_STATUS.

Value Description
“AKSLongTermSupport”
“KubernetesOfficial”

LinuxOSConfig

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
swapFileSizeMB int
Optional
sysctls SysctlConfig
Optional
transparentHugePageDefrag string
Optional
transparentHugePageEnabled string
Optional

LinuxOSConfig_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
swapFileSizeMB int
Optional
sysctls SysctlConfig_STATUS
Optional
transparentHugePageDefrag string
Optional
transparentHugePageEnabled string
Optional

ManagedClusterAADProfile

Used by: ManagedCluster_Spec.

Property Description Type
adminGroupObjectIDs string[]
Optional
clientAppID string
Optional
enableAzureRBAC bool
Optional
managed bool
Optional
serverAppID string
Optional
serverAppSecret string
Optional
tenantID string
Optional

ManagedClusterAADProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
adminGroupObjectIDs string[]
Optional
clientAppID string
Optional
enableAzureRBAC bool
Optional
managed bool
Optional
serverAppID string
Optional
serverAppSecret string
Optional
tenantID string
Optional

ManagedClusterAddonProfile

Used by: ManagedCluster_Spec.

Property Description Type
config map[string]string
Optional
enabled bool
Required

ManagedClusterAddonProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
config map[string]string
Optional
enabled bool
Optional
identity UserAssignedIdentity_STATUS
Optional

ManagedClusterAgentPoolProfile

Used by: ManagedCluster_Spec.

Property Description Type
artifactStreamingProfile AgentPoolArtifactStreamingProfile
Optional
availabilityZones string[]
Optional
capacityReservationGroupReference genruntime.ResourceReference
Optional
count int
Optional
creationData CreationData
Optional
enableAutoScaling bool
Optional
enableCustomCATrust bool
Optional
enableEncryptionAtHost bool
Optional
enableFIPS bool
Optional
enableNodePublicIP bool
Optional
enableUltraSSD bool
Optional
gpuInstanceProfile GPUInstanceProfile
Optional
gpuProfile AgentPoolGPUProfile
Optional
hostGroupReference genruntime.ResourceReference
Optional
kubeletConfig KubeletConfig
Optional
kubeletDiskType KubeletDiskType
Optional
linuxOSConfig LinuxOSConfig
Optional
maxCount int
Optional
maxPods int
Optional
messageOfTheDay string
Optional
minCount int
Optional
mode AgentPoolMode
Optional
name string
Required
networkProfile AgentPoolNetworkProfile
Optional
nodeInitializationTaints string[]
Optional
nodeLabels map[string]string
Optional
nodePublicIPPrefixReference genruntime.ResourceReference
Optional
nodeTaints string[]
Optional
orchestratorVersion string
Optional
osDiskSizeGB ContainerServiceOSDisk
Optional
osDiskType OSDiskType
Optional
osSKU OSSKU
Optional
osType OSType
Optional
podSubnetReference genruntime.ResourceReference
Optional
powerState PowerState
Optional
proximityPlacementGroupReference genruntime.ResourceReference
Optional
scaleDownMode ScaleDownMode
Optional
scaleSetEvictionPolicy ScaleSetEvictionPolicy
Optional
scaleSetPriority ScaleSetPriority
Optional
securityProfile AgentPoolSecurityProfile
Optional
spotMaxPrice float64
Optional
tags map[string]string
Optional
type AgentPoolType
Optional
upgradeSettings AgentPoolUpgradeSettings
Optional
virtualMachineNodesStatus VirtualMachineNodes[]
Optional
virtualMachinesProfile VirtualMachinesProfile
Optional
vmSize string
Optional
vnetSubnetReference genruntime.ResourceReference
Optional
windowsProfile AgentPoolWindowsProfile
Optional
workloadRuntime WorkloadRuntime
Optional

ManagedClusterAgentPoolProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
artifactStreamingProfile AgentPoolArtifactStreamingProfile_STATUS
Optional
availabilityZones string[]
Optional
capacityReservationGroupID string
Optional
count int
Optional
creationData CreationData_STATUS
Optional
currentOrchestratorVersion string
Optional
enableAutoScaling bool
Optional
enableCustomCATrust bool
Optional
enableEncryptionAtHost bool
Optional
enableFIPS bool
Optional
enableNodePublicIP bool
Optional
enableUltraSSD bool
Optional
gpuInstanceProfile GPUInstanceProfile_STATUS
Optional
gpuProfile AgentPoolGPUProfile_STATUS
Optional
hostGroupID string
Optional
kubeletConfig KubeletConfig_STATUS
Optional
kubeletDiskType KubeletDiskType_STATUS
Optional
linuxOSConfig LinuxOSConfig_STATUS
Optional
maxCount int
Optional
maxPods int
Optional
messageOfTheDay string
Optional
minCount int
Optional
mode AgentPoolMode_STATUS
Optional
name string
Optional
networkProfile AgentPoolNetworkProfile_STATUS
Optional
nodeImageVersion string
Optional
nodeInitializationTaints string[]
Optional
nodeLabels map[string]string
Optional
nodePublicIPPrefixID string
Optional
nodeTaints string[]
Optional
orchestratorVersion string
Optional
osDiskSizeGB int
Optional
osDiskType OSDiskType_STATUS
Optional
osSKU OSSKU_STATUS
Optional
osType OSType_STATUS
Optional
podSubnetID string
Optional
powerState PowerState_STATUS
Optional
provisioningState string
Optional
proximityPlacementGroupID string
Optional
scaleDownMode ScaleDownMode_STATUS
Optional
scaleSetEvictionPolicy ScaleSetEvictionPolicy_STATUS
Optional
scaleSetPriority ScaleSetPriority_STATUS
Optional
securityProfile AgentPoolSecurityProfile_STATUS
Optional
spotMaxPrice float64
Optional
tags map[string]string
Optional
type AgentPoolType_STATUS
Optional
upgradeSettings AgentPoolUpgradeSettings_STATUS
Optional
virtualMachineNodesStatus VirtualMachineNodes_STATUS[]
Optional
virtualMachinesProfile VirtualMachinesProfile_STATUS
Optional
vmSize string
Optional
vnetSubnetID string
Optional
windowsProfile AgentPoolWindowsProfile_STATUS
Optional
workloadRuntime WorkloadRuntime_STATUS
Optional

ManagedClusterAIToolchainOperatorProfile

Used by: ManagedCluster_Spec.

Property Description Type
enabled bool
Optional

ManagedClusterAIToolchainOperatorProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterAPIServerAccessProfile

Used by: ManagedCluster_Spec.

Property Description Type
authorizedIPRanges string[]
Optional
disableRunCommand bool
Optional
enablePrivateCluster bool
Optional
enablePrivateClusterPublicFQDN bool
Optional
enableVnetIntegration bool
Optional
privateDNSZone string
Optional
subnetId string
Optional

ManagedClusterAPIServerAccessProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
authorizedIPRanges string[]
Optional
disableRunCommand bool
Optional
enablePrivateCluster bool
Optional
enablePrivateClusterPublicFQDN bool
Optional
enableVnetIntegration bool
Optional
privateDNSZone string
Optional
subnetId string
Optional

ManagedClusterAutoUpgradeProfile

Used by: ManagedCluster_Spec.

Property Description Type
nodeOSUpgradeChannel ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel
Optional
upgradeChannel ManagedClusterAutoUpgradeProfile_UpgradeChannel
Optional

ManagedClusterAutoUpgradeProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
nodeOSUpgradeChannel ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel_STATUS
Optional
upgradeChannel ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS
Optional

ManagedClusterAzureMonitorProfile

Used by: ManagedCluster_Spec.

Property Description Type
logs ManagedClusterAzureMonitorProfileLogs
Optional
metrics ManagedClusterAzureMonitorProfileMetrics
Optional

ManagedClusterAzureMonitorProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
logs ManagedClusterAzureMonitorProfileLogs_STATUS
Optional
metrics ManagedClusterAzureMonitorProfileMetrics_STATUS
Optional

ManagedClusterHTTPProxyConfig

Used by: ManagedCluster_Spec.

Property Description Type
httpProxy string
Optional
httpsProxy string
Optional
noProxy string[]
Optional
trustedCa string
Optional

ManagedClusterHTTPProxyConfig_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
effectiveNoProxy string[]
Optional
httpProxy string
Optional
httpsProxy string
Optional
noProxy string[]
Optional
trustedCa string
Optional

ManagedClusterIdentity

Used by: ManagedCluster_Spec.

Property Description Type
delegatedResources map[string]DelegatedResource
Optional
type ManagedClusterIdentity_Type
Optional
userAssignedIdentities UserAssignedIdentityDetails[]
Optional

ManagedClusterIdentity_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
delegatedResources map[string]DelegatedResource_STATUS
Optional
principalId string
Optional
tenantId string
Optional
type ManagedClusterIdentity_Type_STATUS
Optional
userAssignedIdentities map[string]ManagedClusterIdentity_UserAssignedIdentities_STATUS
Optional

ManagedClusterIngressProfile

Used by: ManagedCluster_Spec.

Property Description Type
webAppRouting ManagedClusterIngressProfileWebAppRouting
Optional

ManagedClusterIngressProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
webAppRouting ManagedClusterIngressProfileWebAppRouting_STATUS
Optional

ManagedClusterMetricsProfile

Used by: ManagedCluster_Spec.

Property Description Type
costAnalysis ManagedClusterCostAnalysis
Optional

ManagedClusterMetricsProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
costAnalysis ManagedClusterCostAnalysis_STATUS
Optional

ManagedClusterNodeProvisioningProfile

Used by: ManagedCluster_Spec.

Property Description Type
mode ManagedClusterNodeProvisioningProfile_Mode
Optional

ManagedClusterNodeProvisioningProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
mode ManagedClusterNodeProvisioningProfile_Mode_STATUS
Optional

ManagedClusterNodeResourceGroupProfile

Used by: ManagedCluster_Spec.

Property Description Type
restrictionLevel ManagedClusterNodeResourceGroupProfile_RestrictionLevel
Optional

ManagedClusterNodeResourceGroupProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
restrictionLevel ManagedClusterNodeResourceGroupProfile_RestrictionLevel_STATUS
Optional

ManagedClusterOIDCIssuerProfile

Used by: ManagedCluster_Spec.

Property Description Type
enabled bool
Optional

ManagedClusterOIDCIssuerProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
enabled bool
Optional
issuerURL string
Optional

ManagedClusterOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: ManagedCluster_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
configMaps configures where to place operator written ConfigMaps. ManagedClusterOperatorConfigMaps
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional
secrets configures where to place Azure generated secrets. ManagedClusterOperatorSecrets
Optional

ManagedClusterPodIdentityProfile

Used by: ManagedCluster_Spec.

Property Description Type
allowNetworkPluginKubenet bool
Optional
enabled bool
Optional
userAssignedIdentities ManagedClusterPodIdentity[]
Optional
userAssignedIdentityExceptions ManagedClusterPodIdentityException[]
Optional

ManagedClusterPodIdentityProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
allowNetworkPluginKubenet bool
Optional
enabled bool
Optional
userAssignedIdentities ManagedClusterPodIdentity_STATUS[]
Optional
userAssignedIdentityExceptions ManagedClusterPodIdentityException_STATUS[]
Optional

ManagedClusterProperties_AutoScalerProfile

Used by: ManagedCluster_Spec.

Property Description Type
balance-similar-node-groups string
Optional
daemonset-eviction-for-empty-nodes bool
Optional
daemonset-eviction-for-occupied-nodes bool
Optional
expander Expander
Optional
ignore-daemonsets-utilization bool
Optional
max-empty-bulk-delete string
Optional
max-graceful-termination-sec string
Optional
max-node-provision-time string
Optional
max-total-unready-percentage string
Optional
new-pod-scale-up-delay string
Optional
ok-total-unready-count string
Optional
scale-down-delay-after-add string
Optional
scale-down-delay-after-delete string
Optional
scale-down-delay-after-failure string
Optional
scale-down-unneeded-time string
Optional
scale-down-unready-time string
Optional
scale-down-utilization-threshold string
Optional
scan-interval string
Optional
skip-nodes-with-local-storage string
Optional
skip-nodes-with-system-pods string
Optional

ManagedClusterProperties_AutoScalerProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
balance-similar-node-groups string
Optional
daemonset-eviction-for-empty-nodes bool
Optional
daemonset-eviction-for-occupied-nodes bool
Optional
expander Expander_STATUS
Optional
ignore-daemonsets-utilization bool
Optional
max-empty-bulk-delete string
Optional
max-graceful-termination-sec string
Optional
max-node-provision-time string
Optional
max-total-unready-percentage string
Optional
new-pod-scale-up-delay string
Optional
ok-total-unready-count string
Optional
scale-down-delay-after-add string
Optional
scale-down-delay-after-delete string
Optional
scale-down-delay-after-failure string
Optional
scale-down-unneeded-time string
Optional
scale-down-unready-time string
Optional
scale-down-utilization-threshold string
Optional
scan-interval string
Optional
skip-nodes-with-local-storage string
Optional
skip-nodes-with-system-pods string
Optional

ManagedClusterProperties_PublicNetworkAccess

Used by: ManagedCluster_Spec.

Value Description
“Disabled”
“Enabled”
“SecuredByPerimeter”

ManagedClusterProperties_PublicNetworkAccess_STATUS

Used by: ManagedCluster_STATUS.

Value Description
“Disabled”
“Enabled”
“SecuredByPerimeter”

ManagedClustersAgentPoolOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: ManagedClustersAgentPool_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

ManagedClusterSecurityProfile

Used by: ManagedCluster_Spec.

Property Description Type
azureKeyVaultKms AzureKeyVaultKms
Optional
customCATrustCertificates ManagedClusterSecurityProfileCustomCATrustCertificates
Optional
defender ManagedClusterSecurityProfileDefender
Optional
imageCleaner ManagedClusterSecurityProfileImageCleaner
Optional
imageIntegrity ManagedClusterSecurityProfileImageIntegrity
Optional
nodeRestriction ManagedClusterSecurityProfileNodeRestriction
Optional
workloadIdentity ManagedClusterSecurityProfileWorkloadIdentity
Optional

ManagedClusterSecurityProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
azureKeyVaultKms AzureKeyVaultKms_STATUS
Optional
customCATrustCertificates string[]
Optional
defender ManagedClusterSecurityProfileDefender_STATUS
Optional
imageCleaner ManagedClusterSecurityProfileImageCleaner_STATUS
Optional
imageIntegrity ManagedClusterSecurityProfileImageIntegrity_STATUS
Optional
nodeRestriction ManagedClusterSecurityProfileNodeRestriction_STATUS
Optional
workloadIdentity ManagedClusterSecurityProfileWorkloadIdentity_STATUS
Optional

ManagedClusterServicePrincipalProfile

Used by: ManagedCluster_Spec.

Property Description Type
clientId string
Required
secret genruntime.SecretReference
Optional

ManagedClusterServicePrincipalProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
clientId string
Optional

ManagedClusterSKU

Used by: ManagedCluster_Spec.

Property Description Type
name ManagedClusterSKU_Name
Optional
tier ManagedClusterSKU_Tier
Optional

ManagedClusterSKU_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
name ManagedClusterSKU_Name_STATUS
Optional
tier ManagedClusterSKU_Tier_STATUS
Optional

ManagedClusterStorageProfile

Used by: ManagedCluster_Spec.

Property Description Type
blobCSIDriver ManagedClusterStorageProfileBlobCSIDriver
Optional
diskCSIDriver ManagedClusterStorageProfileDiskCSIDriver
Optional
fileCSIDriver ManagedClusterStorageProfileFileCSIDriver
Optional
snapshotController ManagedClusterStorageProfileSnapshotController
Optional

ManagedClusterStorageProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
blobCSIDriver ManagedClusterStorageProfileBlobCSIDriver_STATUS
Optional
diskCSIDriver ManagedClusterStorageProfileDiskCSIDriver_STATUS
Optional
fileCSIDriver ManagedClusterStorageProfileFileCSIDriver_STATUS
Optional
snapshotController ManagedClusterStorageProfileSnapshotController_STATUS
Optional

ManagedClusterWindowsProfile

Used by: ManagedCluster_Spec.

Property Description Type
adminPassword genruntime.SecretReference
Optional
adminUsername string
Required
enableCSIProxy bool
Optional
gmsaProfile WindowsGmsaProfile
Optional
licenseType ManagedClusterWindowsProfile_LicenseType
Optional

ManagedClusterWindowsProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
adminUsername string
Optional
enableCSIProxy bool
Optional
gmsaProfile WindowsGmsaProfile_STATUS
Optional
licenseType ManagedClusterWindowsProfile_LicenseType_STATUS
Optional

ManagedClusterWorkloadAutoScalerProfile

Used by: ManagedCluster_Spec.

Property Description Type
keda ManagedClusterWorkloadAutoScalerProfileKeda
Optional
verticalPodAutoscaler ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler
Optional

ManagedClusterWorkloadAutoScalerProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
keda ManagedClusterWorkloadAutoScalerProfileKeda_STATUS
Optional
verticalPodAutoscaler ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS
Optional

OSDiskType

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“Ephemeral”
“Managed”

OSDiskType_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“Ephemeral”
“Managed”

OSSKU

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“AzureLinux”
“CBLMariner”
“Mariner”
“Ubuntu”
“Windows2019”
“Windows2022”
“WindowsAnnual”

OSSKU_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“AzureLinux”
“CBLMariner”
“Mariner”
“Ubuntu”
“Windows2019”
“Windows2022”
“WindowsAnnual”

OSType

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“Linux”
“Windows”

OSType_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“Linux”
“Windows”

PowerState

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
code PowerState_Code
Optional

PowerState_STATUS

Used by: ManagedCluster_STATUS, ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
code PowerState_Code_STATUS
Optional

PrivateLinkResource

Used by: ManagedCluster_Spec.

Property Description Type
groupId string
Optional
name string
Optional
reference genruntime.ResourceReference
Optional
requiredMembers string[]
Optional
type string
Optional

PrivateLinkResource_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
groupId string
Optional
id string
Optional
name string
Optional
privateLinkServiceID string
Optional
requiredMembers string[]
Optional
type string
Optional

SafeguardsProfile

Used by: ManagedCluster_Spec.

Property Description Type
excludedNamespaces string[]
Optional
level SafeguardsProfile_Level
Required
version string
Optional

SafeguardsProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
excludedNamespaces string[]
Optional
level SafeguardsProfile_Level_STATUS
Optional
systemExcludedNamespaces string[]
Optional
version string
Optional

ScaleDownMode

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“Deallocate”
“Delete”

ScaleDownMode_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“Deallocate”
“Delete”

ScaleSetEvictionPolicy

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“Deallocate”
“Delete”

ScaleSetEvictionPolicy_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“Deallocate”
“Delete”

ScaleSetPriority

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“Regular”
“Spot”

ScaleSetPriority_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“Regular”
“Spot”

ServiceMeshProfile

Used by: ManagedCluster_Spec.

Property Description Type
istio IstioServiceMesh
Optional
mode ServiceMeshProfile_Mode
Required

ServiceMeshProfile_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
istio IstioServiceMesh_STATUS
Optional
mode ServiceMeshProfile_Mode_STATUS
Optional

SystemData_STATUS

Used by: ManagedCluster_STATUS.

Property Description Type
createdAt string
Optional
createdBy string
Optional
createdByType SystemData_CreatedByType_STATUS
Optional
lastModifiedAt string
Optional
lastModifiedBy string
Optional
lastModifiedByType SystemData_LastModifiedByType_STATUS
Optional

UserAssignedIdentity

Used by: ManagedCluster_Spec, and ManagedClusterPodIdentity.

Property Description Type
clientId string
Optional
objectId string
Optional
resourceReference genruntime.ResourceReference
Optional

UserAssignedIdentity_STATUS

Used by: ManagedCluster_STATUS, ManagedClusterAddonProfile_STATUS, ManagedClusterIngressProfileWebAppRouting_STATUS, and ManagedClusterPodIdentity_STATUS.

Property Description Type
clientId string
Optional
objectId string
Optional
resourceId string
Optional

VirtualMachineNodes

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
count int
Optional
size string
Optional

VirtualMachineNodes_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
count int
Optional
size string
Optional

VirtualMachinesProfile

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Property Description Type
scale ScaleProfile
Optional

VirtualMachinesProfile_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Property Description Type
scale ScaleProfile_STATUS
Optional

WorkloadRuntime

Used by: ManagedClusterAgentPoolProfile, and ManagedClustersAgentPool_Spec.

Value Description
“KataMshvVmIsolation”
“OCIContainer”
“WasmWasi”

WorkloadRuntime_STATUS

Used by: ManagedClusterAgentPoolProfile_STATUS, and ManagedClustersAgentPool_STATUS.

Value Description
“KataMshvVmIsolation”
“OCIContainer”
“WasmWasi”

AgentPoolSSHAccess

Used by: AgentPoolSecurityProfile.

Value Description
“Disabled”
“LocalUser”

AgentPoolSSHAccess_STATUS

Used by: AgentPoolSecurityProfile_STATUS.

Value Description
“Disabled”
“LocalUser”

AzureKeyVaultKms

Used by: ManagedClusterSecurityProfile.

Property Description Type
enabled bool
Optional
keyId string
Optional
keyVaultNetworkAccess AzureKeyVaultKms_KeyVaultNetworkAccess
Optional
keyVaultResourceReference genruntime.ResourceReference
Optional

AzureKeyVaultKms_STATUS

Used by: ManagedClusterSecurityProfile_STATUS.

Property Description Type
enabled bool
Optional
keyId string
Optional
keyVaultNetworkAccess AzureKeyVaultKms_KeyVaultNetworkAccess_STATUS
Optional
keyVaultResourceId string
Optional

ContainerServiceNetworkProfile_KubeProxyConfig

Used by: ContainerServiceNetworkProfile.

Property Description Type
enabled bool
Optional
ipvsConfig ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig
Optional
mode ContainerServiceNetworkProfile_KubeProxyConfig_Mode
Optional

ContainerServiceNetworkProfile_KubeProxyConfig_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Property Description Type
enabled bool
Optional
ipvsConfig ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS
Optional
mode ContainerServiceNetworkProfile_KubeProxyConfig_Mode_STATUS
Optional

ContainerServiceNetworkProfile_OutboundType

Used by: ContainerServiceNetworkProfile.

Value Description
“loadBalancer”
“managedNATGateway”
“userAssignedNATGateway”
“userDefinedRouting”

ContainerServiceNetworkProfile_OutboundType_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Value Description
“loadBalancer”
“managedNATGateway”
“userAssignedNATGateway”
“userDefinedRouting”

ContainerServiceSshConfiguration

Used by: ContainerServiceLinuxProfile.

Property Description Type
publicKeys ContainerServiceSshPublicKey[]
Required

ContainerServiceSshConfiguration_STATUS

Used by: ContainerServiceLinuxProfile_STATUS.

Property Description Type
publicKeys ContainerServiceSshPublicKey_STATUS[]
Optional

DelegatedResource

Used by: ManagedClusterIdentity.

Property Description Type
location string
Optional
referralResource string
Optional
resourceReference genruntime.ResourceReference
Optional
tenantId string
Optional

DelegatedResource_STATUS

Used by: ManagedClusterIdentity_STATUS.

Property Description Type
location string
Optional
referralResource string
Optional
resourceId string
Optional
tenantId string
Optional

Expander

Used by: ManagedClusterProperties_AutoScalerProfile.

Value Description
“least-waste”
“most-pods”
“priority”
“random”

Expander_STATUS

Used by: ManagedClusterProperties_AutoScalerProfile_STATUS.

Value Description
“least-waste”
“most-pods”
“priority”
“random”

ExtendedLocationType

Used by: ExtendedLocation.

Value Description
“EdgeZone”

ExtendedLocationType_STATUS

Used by: ExtendedLocation_STATUS.

Value Description
“EdgeZone”

IpFamily

Used by: ContainerServiceNetworkProfile.

Value Description
“IPv4”
“IPv6”

IpFamily_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Value Description
“IPv4”
“IPv6”

IPTag

Used by: AgentPoolNetworkProfile.

Property Description Type
ipTagType string
Optional
tag string
Optional

IPTag_STATUS

Used by: AgentPoolNetworkProfile_STATUS.

Property Description Type
ipTagType string
Optional
tag string
Optional

IstioServiceMesh

Used by: ServiceMeshProfile.

Property Description Type
certificateAuthority IstioCertificateAuthority
Optional
components IstioComponents
Optional
revisions string[]
Optional

IstioServiceMesh_STATUS

Used by: ServiceMeshProfile_STATUS.

Property Description Type
certificateAuthority IstioCertificateAuthority_STATUS
Optional
components IstioComponents_STATUS
Optional
revisions string[]
Optional

LoadBalancerSku

Used by: ContainerServiceNetworkProfile.

Value Description
“basic”
“standard”

LoadBalancerSku_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Value Description
“basic”
“standard”

ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel

Used by: ManagedClusterAutoUpgradeProfile.

Value Description
“NodeImage”
“None”
“SecurityPatch”
“Unmanaged”

ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel_STATUS

Used by: ManagedClusterAutoUpgradeProfile_STATUS.

Value Description
“NodeImage”
“None”
“SecurityPatch”
“Unmanaged”

ManagedClusterAutoUpgradeProfile_UpgradeChannel

Used by: ManagedClusterAutoUpgradeProfile.

Value Description
“node-image”
“none”
“patch”
“rapid”
“stable”

ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS

Used by: ManagedClusterAutoUpgradeProfile_STATUS.

Value Description
“node-image”
“none”
“patch”
“rapid”
“stable”

ManagedClusterAzureMonitorProfileLogs

Used by: ManagedClusterAzureMonitorProfile.

Property Description Type
appMonitoring ManagedClusterAzureMonitorProfileAppMonitoring
Optional
containerInsights ManagedClusterAzureMonitorProfileContainerInsights
Optional

ManagedClusterAzureMonitorProfileLogs_STATUS

Used by: ManagedClusterAzureMonitorProfile_STATUS.

Property Description Type
appMonitoring ManagedClusterAzureMonitorProfileAppMonitoring_STATUS
Optional
containerInsights ManagedClusterAzureMonitorProfileContainerInsights_STATUS
Optional

ManagedClusterAzureMonitorProfileMetrics

Used by: ManagedClusterAzureMonitorProfile.

Property Description Type
appMonitoringOpenTelemetryMetrics ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics
Optional
enabled bool
Required
kubeStateMetrics ManagedClusterAzureMonitorProfileKubeStateMetrics
Optional

ManagedClusterAzureMonitorProfileMetrics_STATUS

Used by: ManagedClusterAzureMonitorProfile_STATUS.

Property Description Type
appMonitoringOpenTelemetryMetrics ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics_STATUS
Optional
enabled bool
Optional
kubeStateMetrics ManagedClusterAzureMonitorProfileKubeStateMetrics_STATUS
Optional

ManagedClusterCostAnalysis

Used by: ManagedClusterMetricsProfile.

Property Description Type
enabled bool
Optional

ManagedClusterCostAnalysis_STATUS

Used by: ManagedClusterMetricsProfile_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterIdentity_Type

Used by: ManagedClusterIdentity.

Value Description
“None”
“SystemAssigned”
“UserAssigned”

ManagedClusterIdentity_Type_STATUS

Used by: ManagedClusterIdentity_STATUS.

Value Description
“None”
“SystemAssigned”
“UserAssigned”

ManagedClusterIdentity_UserAssignedIdentities_STATUS

Used by: ManagedClusterIdentity_STATUS.

Property Description Type
clientId string
Optional
principalId string
Optional

ManagedClusterIngressProfileWebAppRouting

Used by: ManagedClusterIngressProfile.

Property Description Type
dnsZoneResourceReferences genruntime.ResourceReference[]
Optional
enabled bool
Optional

ManagedClusterIngressProfileWebAppRouting_STATUS

Used by: ManagedClusterIngressProfile_STATUS.

Property Description Type
dnsZoneResourceIds string[]
Optional
enabled bool
Optional
identity UserAssignedIdentity_STATUS
Optional

ManagedClusterLoadBalancerProfile

Used by: ContainerServiceNetworkProfile.

Property Description Type
allocatedOutboundPorts int
Optional
backendPoolType ManagedClusterLoadBalancerProfile_BackendPoolType
Optional
effectiveOutboundIPs ResourceReference[]
Optional
enableMultipleStandardLoadBalancers bool
Optional
idleTimeoutInMinutes int
Optional
managedOutboundIPs ManagedClusterLoadBalancerProfile_ManagedOutboundIPs
Optional
outboundIPPrefixes ManagedClusterLoadBalancerProfile_OutboundIPPrefixes
Optional
outboundIPs ManagedClusterLoadBalancerProfile_OutboundIPs
Optional

ManagedClusterLoadBalancerProfile_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Property Description Type
allocatedOutboundPorts int
Optional
backendPoolType ManagedClusterLoadBalancerProfile_BackendPoolType_STATUS
Optional
effectiveOutboundIPs ResourceReference_STATUS[]
Optional
enableMultipleStandardLoadBalancers bool
Optional
idleTimeoutInMinutes int
Optional
managedOutboundIPs ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS
Optional
outboundIPPrefixes ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS
Optional
outboundIPs ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS
Optional

ManagedClusterNATGatewayProfile

Used by: ContainerServiceNetworkProfile.

Property Description Type
effectiveOutboundIPs ResourceReference[]
Optional
idleTimeoutInMinutes int
Optional
managedOutboundIPProfile ManagedClusterManagedOutboundIPProfile
Optional

ManagedClusterNATGatewayProfile_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Property Description Type
effectiveOutboundIPs ResourceReference_STATUS[]
Optional
idleTimeoutInMinutes int
Optional
managedOutboundIPProfile ManagedClusterManagedOutboundIPProfile_STATUS
Optional

ManagedClusterNodeProvisioningProfile_Mode

Used by: ManagedClusterNodeProvisioningProfile.

Value Description
“Auto”
“Manual”

ManagedClusterNodeProvisioningProfile_Mode_STATUS

Used by: ManagedClusterNodeProvisioningProfile_STATUS.

Value Description
“Auto”
“Manual”

ManagedClusterNodeResourceGroupProfile_RestrictionLevel

Used by: ManagedClusterNodeResourceGroupProfile.

Value Description
“ReadOnly”
“Unrestricted”

ManagedClusterNodeResourceGroupProfile_RestrictionLevel_STATUS

Used by: ManagedClusterNodeResourceGroupProfile_STATUS.

Value Description
“ReadOnly”
“Unrestricted”

ManagedClusterOperatorConfigMaps

Used by: ManagedClusterOperatorSpec.

Property Description Type
oidcIssuerProfile indicates where the OIDCIssuerProfile config map should be placed. If omitted, no config map will be created. genruntime.ConfigMapDestination
Optional

ManagedClusterOperatorSecrets

Used by: ManagedClusterOperatorSpec.

Property Description Type
adminCredentials indicates where the AdminCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure. genruntime.SecretDestination
Optional
userCredentials indicates where the UserCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure. genruntime.SecretDestination
Optional

ManagedClusterPodIdentity

Used by: ManagedClusterPodIdentityProfile.

Property Description Type
bindingSelector string
Optional
identity UserAssignedIdentity
Required
name string
Required
namespace string
Required

ManagedClusterPodIdentity_STATUS

Used by: ManagedClusterPodIdentityProfile_STATUS.

Property Description Type
bindingSelector string
Optional
identity UserAssignedIdentity_STATUS
Optional
name string
Optional
namespace string
Optional
provisioningInfo ManagedClusterPodIdentity_ProvisioningInfo_STATUS
Optional
provisioningState ManagedClusterPodIdentity_ProvisioningState_STATUS
Optional

ManagedClusterPodIdentityException

Used by: ManagedClusterPodIdentityProfile.

Property Description Type
name string
Required
namespace string
Required
podLabels map[string]string
Required

ManagedClusterPodIdentityException_STATUS

Used by: ManagedClusterPodIdentityProfile_STATUS.

Property Description Type
name string
Optional
namespace string
Optional
podLabels map[string]string
Optional

ManagedClusterSecurityProfileDefender

Used by: ManagedClusterSecurityProfile.

Property Description Type
logAnalyticsWorkspaceResourceReference genruntime.ResourceReference
Optional
securityMonitoring ManagedClusterSecurityProfileDefenderSecurityMonitoring
Optional

ManagedClusterSecurityProfileDefender_STATUS

Used by: ManagedClusterSecurityProfile_STATUS.

Property Description Type
logAnalyticsWorkspaceResourceId string
Optional
securityMonitoring ManagedClusterSecurityProfileDefenderSecurityMonitoring_STATUS
Optional

ManagedClusterSecurityProfileImageCleaner

Used by: ManagedClusterSecurityProfile.

Property Description Type
enabled bool
Optional
intervalHours int
Optional

ManagedClusterSecurityProfileImageCleaner_STATUS

Used by: ManagedClusterSecurityProfile_STATUS.

Property Description Type
enabled bool
Optional
intervalHours int
Optional

ManagedClusterSecurityProfileImageIntegrity

Used by: ManagedClusterSecurityProfile.

Property Description Type
enabled bool
Optional

ManagedClusterSecurityProfileImageIntegrity_STATUS

Used by: ManagedClusterSecurityProfile_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterSecurityProfileNodeRestriction

Used by: ManagedClusterSecurityProfile.

Property Description Type
enabled bool
Optional

ManagedClusterSecurityProfileNodeRestriction_STATUS

Used by: ManagedClusterSecurityProfile_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterSecurityProfileWorkloadIdentity

Used by: ManagedClusterSecurityProfile.

Property Description Type
enabled bool
Optional

ManagedClusterSecurityProfileWorkloadIdentity_STATUS

Used by: ManagedClusterSecurityProfile_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterSKU_Name

Used by: ManagedClusterSKU.

Value Description
“Base”

ManagedClusterSKU_Name_STATUS

Used by: ManagedClusterSKU_STATUS.

Value Description
“Base”

ManagedClusterSKU_Tier

Used by: ManagedClusterSKU.

Value Description
“Free”
“Premium”
“Standard”

ManagedClusterSKU_Tier_STATUS

Used by: ManagedClusterSKU_STATUS.

Value Description
“Free”
“Premium”
“Standard”

ManagedClusterStorageProfileBlobCSIDriver

Used by: ManagedClusterStorageProfile.

Property Description Type
enabled bool
Optional

ManagedClusterStorageProfileBlobCSIDriver_STATUS

Used by: ManagedClusterStorageProfile_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterStorageProfileDiskCSIDriver

Used by: ManagedClusterStorageProfile.

Property Description Type
enabled bool
Optional
version string
Optional

ManagedClusterStorageProfileDiskCSIDriver_STATUS

Used by: ManagedClusterStorageProfile_STATUS.

Property Description Type
enabled bool
Optional
version string
Optional

ManagedClusterStorageProfileFileCSIDriver

Used by: ManagedClusterStorageProfile.

Property Description Type
enabled bool
Optional

ManagedClusterStorageProfileFileCSIDriver_STATUS

Used by: ManagedClusterStorageProfile_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterStorageProfileSnapshotController

Used by: ManagedClusterStorageProfile.

Property Description Type
enabled bool
Optional

ManagedClusterStorageProfileSnapshotController_STATUS

Used by: ManagedClusterStorageProfile_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterWindowsProfile_LicenseType

Used by: ManagedClusterWindowsProfile.

Value Description
“None”
“Windows_Server”

ManagedClusterWindowsProfile_LicenseType_STATUS

Used by: ManagedClusterWindowsProfile_STATUS.

Value Description
“None”
“Windows_Server”

ManagedClusterWorkloadAutoScalerProfileKeda

Used by: ManagedClusterWorkloadAutoScalerProfile.

Property Description Type
enabled bool
Required

ManagedClusterWorkloadAutoScalerProfileKeda_STATUS

Used by: ManagedClusterWorkloadAutoScalerProfile_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

Used by: ManagedClusterWorkloadAutoScalerProfile.

Property Description Type
addonAutoscaling ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_AddonAutoscaling
Optional
enabled bool
Required

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS

Used by: ManagedClusterWorkloadAutoScalerProfile_STATUS.

Property Description Type
addonAutoscaling ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_AddonAutoscaling_STATUS
Optional
enabled bool
Optional

NetworkDataplane

Used by: ContainerServiceNetworkProfile.

Value Description
“azure”
“cilium”

NetworkDataplane_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Value Description
“azure”
“cilium”

NetworkMode

Used by: ContainerServiceNetworkProfile.

Value Description
“bridge”
“transparent”

NetworkMode_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Value Description
“bridge”
“transparent”

NetworkMonitoring

Used by: ContainerServiceNetworkProfile.

Property Description Type
enabled bool
Optional

NetworkMonitoring_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Property Description Type
enabled bool
Optional

NetworkPlugin

Used by: ContainerServiceNetworkProfile.

Value Description
“azure”
“kubenet”
“none”

NetworkPlugin_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Value Description
“azure”
“kubenet”
“none”

NetworkPluginMode

Used by: ContainerServiceNetworkProfile.

Value Description
“overlay”

NetworkPluginMode_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Value Description
“overlay”

NetworkPolicy

Used by: ContainerServiceNetworkProfile.

Value Description
“azure”
“calico”
“cilium”
“none”

NetworkPolicy_STATUS

Used by: ContainerServiceNetworkProfile_STATUS.

Value Description
“azure”
“calico”
“cilium”
“none”

PortRange

Used by: AgentPoolNetworkProfile.

Property Description Type
portEnd int
Optional
portStart int
Optional
protocol PortRange_Protocol
Optional

PortRange_STATUS

Used by: AgentPoolNetworkProfile_STATUS.

Property Description Type
portEnd int
Optional
portStart int
Optional
protocol PortRange_Protocol_STATUS
Optional

PowerState_Code

Used by: PowerState.

Value Description
“Running”
“Stopped”

PowerState_Code_STATUS

Used by: PowerState_STATUS.

Value Description
“Running”
“Stopped”

SafeguardsProfile_Level

Used by: SafeguardsProfile.

Value Description
“Enforcement”
“Off”
“Warning”

SafeguardsProfile_Level_STATUS

Used by: SafeguardsProfile_STATUS.

Value Description
“Enforcement”
“Off”
“Warning”

ScaleProfile

Used by: VirtualMachinesProfile.

Property Description Type
manual ManualScaleProfile[]
Optional

ScaleProfile_STATUS

Used by: VirtualMachinesProfile_STATUS.

Property Description Type
manual ManualScaleProfile_STATUS[]
Optional

ServiceMeshProfile_Mode

Used by: ServiceMeshProfile.

Value Description
“Disabled”
“Istio”

ServiceMeshProfile_Mode_STATUS

Used by: ServiceMeshProfile_STATUS.

Value Description
“Disabled”
“Istio”

SysctlConfig

Used by: LinuxOSConfig.

Property Description Type
fsAioMaxNr int
Optional
fsFileMax int
Optional
fsInotifyMaxUserWatches int
Optional
fsNrOpen int
Optional
kernelThreadsMax int
Optional
netCoreNetdevMaxBacklog int
Optional
netCoreOptmemMax int
Optional
netCoreRmemDefault int
Optional
netCoreRmemMax int
Optional
netCoreSomaxconn int
Optional
netCoreWmemDefault int
Optional
netCoreWmemMax int
Optional
netIpv4IpLocalPortRange string
Optional
netIpv4NeighDefaultGcThresh1 int
Optional
netIpv4NeighDefaultGcThresh2 int
Optional
netIpv4NeighDefaultGcThresh3 int
Optional
netIpv4TcpFinTimeout int
Optional
netIpv4TcpkeepaliveIntvl int
Optional
netIpv4TcpKeepaliveProbes int
Optional
netIpv4TcpKeepaliveTime int
Optional
netIpv4TcpMaxSynBacklog int
Optional
netIpv4TcpMaxTwBuckets int
Optional
netIpv4TcpTwReuse bool
Optional
netNetfilterNfConntrackBuckets int
Optional
netNetfilterNfConntrackMax int
Optional
vmMaxMapCount int
Optional
vmSwappiness int
Optional
vmVfsCachePressure int
Optional

SysctlConfig_STATUS

Used by: LinuxOSConfig_STATUS.

Property Description Type
fsAioMaxNr int
Optional
fsFileMax int
Optional
fsInotifyMaxUserWatches int
Optional
fsNrOpen int
Optional
kernelThreadsMax int
Optional
netCoreNetdevMaxBacklog int
Optional
netCoreOptmemMax int
Optional
netCoreRmemDefault int
Optional
netCoreRmemMax int
Optional
netCoreSomaxconn int
Optional
netCoreWmemDefault int
Optional
netCoreWmemMax int
Optional
netIpv4IpLocalPortRange string
Optional
netIpv4NeighDefaultGcThresh1 int
Optional
netIpv4NeighDefaultGcThresh2 int
Optional
netIpv4NeighDefaultGcThresh3 int
Optional
netIpv4TcpFinTimeout int
Optional
netIpv4TcpkeepaliveIntvl int
Optional
netIpv4TcpKeepaliveProbes int
Optional
netIpv4TcpKeepaliveTime int
Optional
netIpv4TcpMaxSynBacklog int
Optional
netIpv4TcpMaxTwBuckets int
Optional
netIpv4TcpTwReuse bool
Optional
netNetfilterNfConntrackBuckets int
Optional
netNetfilterNfConntrackMax int
Optional
vmMaxMapCount int
Optional
vmSwappiness int
Optional
vmVfsCachePressure int
Optional

SystemData_CreatedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_LastModifiedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

UpgradeOverrideSettings

Used by: ClusterUpgradeSettings.

Property Description Type
forceUpgrade bool
Optional
until string
Optional

UpgradeOverrideSettings_STATUS

Used by: ClusterUpgradeSettings_STATUS.

Property Description Type
forceUpgrade bool
Optional
until string
Optional

UserAssignedIdentityDetails

Used by: ManagedClusterIdentity.

Property Description Type
reference genruntime.ResourceReference
Optional

WindowsGmsaProfile

Used by: ManagedClusterWindowsProfile.

Property Description Type
dnsServer string
Optional
enabled bool
Optional
rootDomainName string
Optional

WindowsGmsaProfile_STATUS

Used by: ManagedClusterWindowsProfile_STATUS.

Property Description Type
dnsServer string
Optional
enabled bool
Optional
rootDomainName string
Optional

AzureKeyVaultKms_KeyVaultNetworkAccess

Used by: AzureKeyVaultKms.

Value Description
“Private”
“Public”

AzureKeyVaultKms_KeyVaultNetworkAccess_STATUS

Used by: AzureKeyVaultKms_STATUS.

Value Description
“Private”
“Public”

ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig

Used by: ContainerServiceNetworkProfile_KubeProxyConfig.

Property Description Type
scheduler ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler
Optional
tcpFinTimeoutSeconds int
Optional
tcpTimeoutSeconds int
Optional
udpTimeoutSeconds int
Optional

ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS

Used by: ContainerServiceNetworkProfile_KubeProxyConfig_STATUS.

Property Description Type
scheduler ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler_STATUS
Optional
tcpFinTimeoutSeconds int
Optional
tcpTimeoutSeconds int
Optional
udpTimeoutSeconds int
Optional

ContainerServiceNetworkProfile_KubeProxyConfig_Mode

Used by: ContainerServiceNetworkProfile_KubeProxyConfig.

Value Description
“IPTABLES”
“IPVS”

ContainerServiceNetworkProfile_KubeProxyConfig_Mode_STATUS

Used by: ContainerServiceNetworkProfile_KubeProxyConfig_STATUS.

Value Description
“IPTABLES”
“IPVS”

ContainerServiceSshPublicKey

Used by: ContainerServiceSshConfiguration.

Property Description Type
keyData string
Required

ContainerServiceSshPublicKey_STATUS

Used by: ContainerServiceSshConfiguration_STATUS.

Property Description Type
keyData string
Optional

IstioCertificateAuthority

Used by: IstioServiceMesh.

Property Description Type
plugin IstioPluginCertificateAuthority
Optional

IstioCertificateAuthority_STATUS

Used by: IstioServiceMesh_STATUS.

Property Description Type
plugin IstioPluginCertificateAuthority_STATUS
Optional

IstioComponents

Used by: IstioServiceMesh.

Property Description Type
egressGateways IstioEgressGateway[]
Optional
ingressGateways IstioIngressGateway[]
Optional

IstioComponents_STATUS

Used by: IstioServiceMesh_STATUS.

Property Description Type
egressGateways IstioEgressGateway_STATUS[]
Optional
ingressGateways IstioIngressGateway_STATUS[]
Optional

ManagedClusterAzureMonitorProfileAppMonitoring

Used by: ManagedClusterAzureMonitorProfileLogs.

Property Description Type
enabled bool
Optional

ManagedClusterAzureMonitorProfileAppMonitoring_STATUS

Used by: ManagedClusterAzureMonitorProfileLogs_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics

Used by: ManagedClusterAzureMonitorProfileMetrics.

Property Description Type
enabled bool
Optional

ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics_STATUS

Used by: ManagedClusterAzureMonitorProfileMetrics_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterAzureMonitorProfileContainerInsights

Used by: ManagedClusterAzureMonitorProfileLogs.

Property Description Type
enabled bool
Optional
logAnalyticsWorkspaceResourceReference genruntime.ResourceReference
Optional
windowsHostLogs ManagedClusterAzureMonitorProfileWindowsHostLogs
Optional

ManagedClusterAzureMonitorProfileContainerInsights_STATUS

Used by: ManagedClusterAzureMonitorProfileLogs_STATUS.

Property Description Type
enabled bool
Optional
logAnalyticsWorkspaceResourceId string
Optional
windowsHostLogs ManagedClusterAzureMonitorProfileWindowsHostLogs_STATUS
Optional

ManagedClusterAzureMonitorProfileKubeStateMetrics

Used by: ManagedClusterAzureMonitorProfileMetrics.

Property Description Type
metricAnnotationsAllowList string
Optional
metricLabelsAllowlist string
Optional

ManagedClusterAzureMonitorProfileKubeStateMetrics_STATUS

Used by: ManagedClusterAzureMonitorProfileMetrics_STATUS.

Property Description Type
metricAnnotationsAllowList string
Optional
metricLabelsAllowlist string
Optional

ManagedClusterLoadBalancerProfile_BackendPoolType

Used by: ManagedClusterLoadBalancerProfile.

Value Description
“NodeIP”
“NodeIPConfiguration”

ManagedClusterLoadBalancerProfile_BackendPoolType_STATUS

Used by: ManagedClusterLoadBalancerProfile_STATUS.

Value Description
“NodeIP”
“NodeIPConfiguration”

ManagedClusterLoadBalancerProfile_ManagedOutboundIPs

Used by: ManagedClusterLoadBalancerProfile.

Property Description Type
count int
Optional
countIPv6 int
Optional

ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS

Used by: ManagedClusterLoadBalancerProfile_STATUS.

Property Description Type
count int
Optional
countIPv6 int
Optional

ManagedClusterLoadBalancerProfile_OutboundIPPrefixes

Used by: ManagedClusterLoadBalancerProfile.

Property Description Type
publicIPPrefixes ResourceReference[]
Optional

ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS

Used by: ManagedClusterLoadBalancerProfile_STATUS.

Property Description Type
publicIPPrefixes ResourceReference_STATUS[]
Optional

ManagedClusterLoadBalancerProfile_OutboundIPs

Used by: ManagedClusterLoadBalancerProfile.

Property Description Type
publicIPs ResourceReference[]
Optional

ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS

Used by: ManagedClusterLoadBalancerProfile_STATUS.

Property Description Type
publicIPs ResourceReference_STATUS[]
Optional

ManagedClusterManagedOutboundIPProfile

Used by: ManagedClusterNATGatewayProfile.

Property Description Type
count int
Optional

ManagedClusterManagedOutboundIPProfile_STATUS

Used by: ManagedClusterNATGatewayProfile_STATUS.

Property Description Type
count int
Optional

ManagedClusterPodIdentity_ProvisioningInfo_STATUS

Used by: ManagedClusterPodIdentity_STATUS.

Property Description Type
error ManagedClusterPodIdentityProvisioningError_STATUS
Optional

ManagedClusterPodIdentity_ProvisioningState_STATUS

Used by: ManagedClusterPodIdentity_STATUS.

Value Description
“Assigned”
“Canceled”
“Deleting”
“Failed”
“Succeeded”
“Updating”

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Used by: ManagedClusterSecurityProfileDefender.

Property Description Type
enabled bool
Optional

ManagedClusterSecurityProfileDefenderSecurityMonitoring_STATUS

Used by: ManagedClusterSecurityProfileDefender_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_AddonAutoscaling

Used by: ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler.

Value Description
“Disabled”
“Enabled”

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_AddonAutoscaling_STATUS

Used by: ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS.

Value Description
“Disabled”
“Enabled”

ManualScaleProfile

Used by: ScaleProfile.

Property Description Type
count int
Optional
sizes string[]
Optional

ManualScaleProfile_STATUS

Used by: ScaleProfile_STATUS.

Property Description Type
count int
Optional
sizes string[]
Optional

PortRange_Protocol

Used by: PortRange.

Value Description
“TCP”
“UDP”

PortRange_Protocol_STATUS

Used by: PortRange_STATUS.

Value Description
“TCP”
“UDP”

ResourceReference

Used by: ManagedClusterLoadBalancerProfile, ManagedClusterLoadBalancerProfile_OutboundIPPrefixes, ManagedClusterLoadBalancerProfile_OutboundIPs, and ManagedClusterNATGatewayProfile.

Property Description Type
reference genruntime.ResourceReference
Optional

ResourceReference_STATUS

Used by: ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS, ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS, ManagedClusterLoadBalancerProfile_STATUS, and ManagedClusterNATGatewayProfile_STATUS.

Property Description Type
id string
Optional

ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler

Used by: ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig.

Value Description
“LeastConnection”
“RoundRobin”

ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler_STATUS

Used by: ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS.

Value Description
“LeastConnection”
“RoundRobin”

IstioEgressGateway

Used by: IstioComponents.

Property Description Type
enabled bool
Required
nodeSelector map[string]string
Optional

IstioEgressGateway_STATUS

Used by: IstioComponents_STATUS.

Property Description Type
enabled bool
Optional
nodeSelector map[string]string
Optional

IstioIngressGateway

Used by: IstioComponents.

Property Description Type
enabled bool
Required
mode IstioIngressGateway_Mode
Required

IstioIngressGateway_STATUS

Used by: IstioComponents_STATUS.

Property Description Type
enabled bool
Optional
mode IstioIngressGateway_Mode_STATUS
Optional

IstioPluginCertificateAuthority

Used by: IstioCertificateAuthority.

Property Description Type
certChainObjectName string
Optional
certObjectName string
Optional
keyObjectName string
Optional
keyVaultReference genruntime.ResourceReference
Optional
rootCertObjectName string
Optional

IstioPluginCertificateAuthority_STATUS

Used by: IstioCertificateAuthority_STATUS.

Property Description Type
certChainObjectName string
Optional
certObjectName string
Optional
keyObjectName string
Optional
keyVaultId string
Optional
rootCertObjectName string
Optional

ManagedClusterAzureMonitorProfileWindowsHostLogs

Used by: ManagedClusterAzureMonitorProfileContainerInsights.

Property Description Type
enabled bool
Optional

ManagedClusterAzureMonitorProfileWindowsHostLogs_STATUS

Used by: ManagedClusterAzureMonitorProfileContainerInsights_STATUS.

Property Description Type
enabled bool
Optional

ManagedClusterPodIdentityProvisioningError_STATUS

Used by: ManagedClusterPodIdentity_ProvisioningInfo_STATUS.

Property Description Type
error ManagedClusterPodIdentityProvisioningErrorBody_STATUS
Optional

IstioIngressGateway_Mode

Used by: IstioIngressGateway.

Value Description
“External”
“Internal”

IstioIngressGateway_Mode_STATUS

Used by: IstioIngressGateway_STATUS.

Value Description
“External”
“Internal”

ManagedClusterPodIdentityProvisioningErrorBody_STATUS

Used by: ManagedClusterPodIdentityProvisioningError_STATUS.

Property Description Type
code string
Optional
details ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled[]
Optional
message string
Optional
target string
Optional

ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled

Used by: ManagedClusterPodIdentityProvisioningErrorBody_STATUS.

Property Description Type
code string
Optional
message string
Optional
target string
Optional