containerservice.azure.com/v1api20230202preview

containerservice.azure.com/v1api20230202preview

Package v1api20230202preview contains API Schema definitions for the containerservice v1api20230202preview API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2023-02-02-preview"

    AgentPoolMode (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    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

    Value Description

    "System"

    "User"

    AgentPoolMode_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

    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

    Value Description

    "System"

    "User"

    AgentPoolNetworkProfile

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusters_AgentPool_Spec)

    Network settings of an agent pool.

    Field Description
    allowedHostPorts
    []PortRange

    AllowedHostPorts: The port ranges that are allowed to access. The specified ranges are allowed to overlap.

    applicationSecurityGroupsReferences
    []genruntime.ResourceReference

    ApplicationSecurityGroupsReferences: The IDs of the application security groups which agent pool will associate when created.

    nodePublicIPTags
    []IPTag

    NodePublicIPTags: IPTags of instance-level public IPs.

    AgentPoolNetworkProfile_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM)

    Network settings of an agent pool.

    Field Description
    allowedHostPorts
    []PortRange_ARM

    AllowedHostPorts: The port ranges that are allowed to access. The specified ranges are allowed to overlap.

    applicationSecurityGroups
    []string
    nodePublicIPTags
    []IPTag_ARM

    NodePublicIPTags: IPTags of instance-level public IPs.

    AgentPoolNetworkProfile_STATUS

    (Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClusters_AgentPool_STATUS)

    Network settings of an agent pool.

    Field Description
    allowedHostPorts
    []PortRange_STATUS

    AllowedHostPorts: The port ranges that are allowed to access. The specified ranges are allowed to overlap.

    applicationSecurityGroups
    []string

    ApplicationSecurityGroups: The IDs of the application security groups which agent pool will associate when created.

    nodePublicIPTags
    []IPTag_STATUS

    NodePublicIPTags: IPTags of instance-level public IPs.

    AgentPoolNetworkProfile_STATUS_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS_ARM)

    Network settings of an agent pool.

    Field Description
    allowedHostPorts
    []PortRange_STATUS_ARM

    AllowedHostPorts: The port ranges that are allowed to access. The specified ranges are allowed to overlap.

    applicationSecurityGroups
    []string

    ApplicationSecurityGroups: The IDs of the application security groups which agent pool will associate when created.

    nodePublicIPTags
    []IPTag_STATUS_ARM

    NodePublicIPTags: IPTags of instance-level public IPs.

    AgentPoolType (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    The type of Agent Pool.

    Value Description

    "AvailabilitySet"

    "VirtualMachineScaleSets"

    AgentPoolType_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

    The type of Agent Pool.

    Value Description

    "AvailabilitySet"

    "VirtualMachineScaleSets"

    AgentPoolUpgradeSettings

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusters_AgentPool_Spec)

    Settings for upgrading an agentpool

    Field Description
    maxSurge
    string

    MaxSurge: This can either be set to an integer (e.g. ‘5’) or a percentage (e.g. ‘50%’). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

    AgentPoolUpgradeSettings_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM)

    Settings for upgrading an agentpool

    Field Description
    maxSurge
    string

    MaxSurge: This can either be set to an integer (e.g. ‘5’) or a percentage (e.g. ‘50%’). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

    AgentPoolUpgradeSettings_STATUS

    (Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClusters_AgentPool_STATUS)

    Settings for upgrading an agentpool

    Field Description
    maxSurge
    string

    MaxSurge: This can either be set to an integer (e.g. ‘5’) or a percentage (e.g. ‘50%’). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

    AgentPoolUpgradeSettings_STATUS_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS_ARM)

    Settings for upgrading an agentpool

    Field Description
    maxSurge
    string

    MaxSurge: This can either be set to an integer (e.g. ‘5’) or a percentage (e.g. ‘50%’). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

    AgentPoolWindowsProfile

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusters_AgentPool_Spec)

    The Windows agent pool’s specific profile.

    Field Description
    disableOutboundNat
    bool

    DisableOutboundNat: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

    AgentPoolWindowsProfile_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM)

    The Windows agent pool’s specific profile.

    Field Description
    disableOutboundNat
    bool

    DisableOutboundNat: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

    AgentPoolWindowsProfile_STATUS

    (Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClusters_AgentPool_STATUS)

    The Windows agent pool’s specific profile.

    Field Description
    disableOutboundNat
    bool

    DisableOutboundNat: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

    AgentPoolWindowsProfile_STATUS_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS_ARM)

    The Windows agent pool’s specific profile.

    Field Description
    disableOutboundNat
    bool

    DisableOutboundNat: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

    AzureKeyVaultKms

    (Appears on:ManagedClusterSecurityProfile)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable Azure Key Vault key management service. The default is false.

    keyId
    string

    KeyId: Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

    keyVaultNetworkAccess
    AzureKeyVaultKms_KeyVaultNetworkAccess

    KeyVaultNetworkAccess: Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

    keyVaultResourceReference
    genruntime.ResourceReference

    KeyVaultResourceReference: Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

    AzureKeyVaultKms_ARM

    (Appears on:ManagedClusterSecurityProfile_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable Azure Key Vault key management service. The default is false.

    keyId
    string

    KeyId: Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

    keyVaultNetworkAccess
    AzureKeyVaultKms_KeyVaultNetworkAccess

    KeyVaultNetworkAccess: Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

    keyVaultResourceId
    string

    AzureKeyVaultKms_KeyVaultNetworkAccess (string alias)

    (Appears on:AzureKeyVaultKms, AzureKeyVaultKms_ARM)

    Value Description

    "Private"

    "Public"

    AzureKeyVaultKms_KeyVaultNetworkAccess_STATUS (string alias)

    (Appears on:AzureKeyVaultKms_STATUS, AzureKeyVaultKms_STATUS_ARM)

    Value Description

    "Private"

    "Public"

    AzureKeyVaultKms_STATUS

    (Appears on:ManagedClusterSecurityProfile_STATUS)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable Azure Key Vault key management service. The default is false.

    keyId
    string

    KeyId: Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

    keyVaultNetworkAccess
    AzureKeyVaultKms_KeyVaultNetworkAccess_STATUS

    KeyVaultNetworkAccess: Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

    keyVaultResourceId
    string

    KeyVaultResourceId: Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

    AzureKeyVaultKms_STATUS_ARM

    (Appears on:ManagedClusterSecurityProfile_STATUS_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable Azure Key Vault key management service. The default is false.

    keyId
    string

    KeyId: Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

    keyVaultNetworkAccess
    AzureKeyVaultKms_KeyVaultNetworkAccess_STATUS

    KeyVaultNetworkAccess: Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

    keyVaultResourceId
    string

    KeyVaultResourceId: Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

    ClusterUpgradeSettings

    (Appears on:ManagedCluster_Spec)

    Settings for upgrading a cluster.

    Field Description
    overrideSettings
    UpgradeOverrideSettings

    OverrideSettings: Settings for overrides.

    ClusterUpgradeSettings_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Settings for upgrading a cluster.

    Field Description
    overrideSettings
    UpgradeOverrideSettings_ARM

    OverrideSettings: Settings for overrides.

    ClusterUpgradeSettings_STATUS

    (Appears on:ManagedCluster_STATUS)

    Settings for upgrading a cluster.

    Field Description
    overrideSettings
    UpgradeOverrideSettings_STATUS

    OverrideSettings: Settings for overrides.

    ClusterUpgradeSettings_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Settings for upgrading a cluster.

    Field Description
    overrideSettings
    UpgradeOverrideSettings_STATUS_ARM

    OverrideSettings: Settings for overrides.

    ContainerServiceLinuxProfile

    (Appears on:ManagedCluster_Spec)

    Profile for Linux VMs in the container service cluster.

    Field Description
    adminUsername
    string

    AdminUsername: The administrator username to use for Linux VMs.

    ssh
    ContainerServiceSshConfiguration

    Ssh: The SSH configuration for Linux-based VMs running on Azure.

    ContainerServiceLinuxProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Profile for Linux VMs in the container service cluster.

    Field Description
    adminUsername
    string

    AdminUsername: The administrator username to use for Linux VMs.

    ssh
    ContainerServiceSshConfiguration_ARM

    Ssh: The SSH configuration for Linux-based VMs running on Azure.

    ContainerServiceLinuxProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Profile for Linux VMs in the container service cluster.

    Field Description
    adminUsername
    string

    AdminUsername: The administrator username to use for Linux VMs.

    ssh
    ContainerServiceSshConfiguration_STATUS

    Ssh: The SSH configuration for Linux-based VMs running on Azure.

    ContainerServiceLinuxProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Profile for Linux VMs in the container service cluster.

    Field Description
    adminUsername
    string

    AdminUsername: The administrator username to use for Linux VMs.

    ssh
    ContainerServiceSshConfiguration_STATUS_ARM

    Ssh: The SSH configuration for Linux-based VMs running on Azure.

    ContainerServiceNetworkProfile

    (Appears on:ManagedCluster_Spec)

    Profile of network configuration.

    Field Description
    dnsServiceIP
    string

    DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

    dockerBridgeCidr
    string

    DockerBridgeCidr: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.

    ipFamilies
    []ContainerServiceNetworkProfile_IpFamilies

    IpFamilies: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

    kubeProxyConfig
    ContainerServiceNetworkProfile_KubeProxyConfig

    KubeProxyConfig: Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be ‘1-23’.

    loadBalancerProfile
    ManagedClusterLoadBalancerProfile

    LoadBalancerProfile: Profile of the cluster load balancer.

    loadBalancerSku
    LoadBalancerSku

    LoadBalancerSku: The default is ‘standard’. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

    natGatewayProfile
    ManagedClusterNATGatewayProfile

    NatGatewayProfile: Profile of the cluster NAT gateway.

    networkDataplane
    NetworkDataplane

    NetworkDataplane: Network dataplane used in the Kubernetes cluster.

    networkMode
    NetworkMode

    NetworkMode: This cannot be specified if networkPlugin is anything other than ‘azure’.

    networkPlugin
    NetworkPlugin

    NetworkPlugin: Network plugin used for building the Kubernetes network.

    networkPluginMode
    NetworkPluginMode

    NetworkPluginMode: Network plugin mode used for building the Kubernetes network.

    networkPolicy
    NetworkPolicy

    NetworkPolicy: Network policy used for building the Kubernetes network.

    outboundType
    ContainerServiceNetworkProfile_OutboundType

    OutboundType: This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

    podCidr
    string

    PodCidr: A CIDR notation IP range from which to assign pod IPs when kubenet is used.

    podCidrs
    []string

    PodCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

    serviceCidr
    string

    ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

    serviceCidrs
    []string

    ServiceCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

    ContainerServiceNetworkProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Profile of network configuration.

    Field Description
    dnsServiceIP
    string

    DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

    dockerBridgeCidr
    string

    DockerBridgeCidr: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.

    ipFamilies
    []ContainerServiceNetworkProfile_IpFamilies

    IpFamilies: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

    kubeProxyConfig
    ContainerServiceNetworkProfile_KubeProxyConfig_ARM

    KubeProxyConfig: Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be ‘1-23’.

    loadBalancerProfile
    ManagedClusterLoadBalancerProfile_ARM

    LoadBalancerProfile: Profile of the cluster load balancer.

    loadBalancerSku
    LoadBalancerSku

    LoadBalancerSku: The default is ‘standard’. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

    natGatewayProfile
    ManagedClusterNATGatewayProfile_ARM

    NatGatewayProfile: Profile of the cluster NAT gateway.

    networkDataplane
    NetworkDataplane

    NetworkDataplane: Network dataplane used in the Kubernetes cluster.

    networkMode
    NetworkMode

    NetworkMode: This cannot be specified if networkPlugin is anything other than ‘azure’.

    networkPlugin
    NetworkPlugin

    NetworkPlugin: Network plugin used for building the Kubernetes network.

    networkPluginMode
    NetworkPluginMode

    NetworkPluginMode: Network plugin mode used for building the Kubernetes network.

    networkPolicy
    NetworkPolicy

    NetworkPolicy: Network policy used for building the Kubernetes network.

    outboundType
    ContainerServiceNetworkProfile_OutboundType

    OutboundType: This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

    podCidr
    string

    PodCidr: A CIDR notation IP range from which to assign pod IPs when kubenet is used.

    podCidrs
    []string

    PodCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

    serviceCidr
    string

    ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

    serviceCidrs
    []string

    ServiceCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

    ContainerServiceNetworkProfile_IpFamilies (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfile_ARM)

    Value Description

    "IPv4"

    "IPv6"

    ContainerServiceNetworkProfile_IpFamilies_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_STATUS, ContainerServiceNetworkProfile_STATUS_ARM)

    Value Description

    "IPv4"

    "IPv6"

    ContainerServiceNetworkProfile_KubeProxyConfig

    (Appears on:ContainerServiceNetworkProfile)

    Field Description
    enabled
    bool

    Enabled: Whether to enable on kube-proxy on the cluster (if no ‘kubeProxyConfig’ exists, kube-proxy is enabled in AKS by default without these customizations).

    ipvsConfig
    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig

    IpvsConfig: Holds configuration customizations for IPVS. May only be specified if ‘mode’ is set to ‘IPVS’.

    mode
    ContainerServiceNetworkProfile_KubeProxyConfig_Mode

    Mode: Specify which proxy mode to use (‘IPTABLES’ or ‘IPVS’)

    ContainerServiceNetworkProfile_KubeProxyConfig_ARM

    (Appears on:ContainerServiceNetworkProfile_ARM)

    Field Description
    enabled
    bool

    Enabled: Whether to enable on kube-proxy on the cluster (if no ‘kubeProxyConfig’ exists, kube-proxy is enabled in AKS by default without these customizations).

    ipvsConfig
    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_ARM

    IpvsConfig: Holds configuration customizations for IPVS. May only be specified if ‘mode’ is set to ‘IPVS’.

    mode
    ContainerServiceNetworkProfile_KubeProxyConfig_Mode

    Mode: Specify which proxy mode to use (‘IPTABLES’ or ‘IPVS’)

    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig

    (Appears on:ContainerServiceNetworkProfile_KubeProxyConfig)

    Field Description
    scheduler
    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler

    Scheduler: IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html.

    tcpFinTimeoutSeconds
    int

    TcpFinTimeoutSeconds: The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value.

    tcpTimeoutSeconds
    int

    TcpTimeoutSeconds: The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value.

    udpTimeoutSeconds
    int

    UdpTimeoutSeconds: The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value.

    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_ARM

    (Appears on:ContainerServiceNetworkProfile_KubeProxyConfig_ARM)

    Field Description
    scheduler
    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler

    Scheduler: IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html.

    tcpFinTimeoutSeconds
    int

    TcpFinTimeoutSeconds: The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value.

    tcpTimeoutSeconds
    int

    TcpTimeoutSeconds: The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value.

    udpTimeoutSeconds
    int

    UdpTimeoutSeconds: The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value.

    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS

    (Appears on:ContainerServiceNetworkProfile_KubeProxyConfig_STATUS)

    Field Description
    scheduler
    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler_STATUS

    Scheduler: IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html.

    tcpFinTimeoutSeconds
    int

    TcpFinTimeoutSeconds: The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value.

    tcpTimeoutSeconds
    int

    TcpTimeoutSeconds: The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value.

    udpTimeoutSeconds
    int

    UdpTimeoutSeconds: The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value.

    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS_ARM

    (Appears on:ContainerServiceNetworkProfile_KubeProxyConfig_STATUS_ARM)

    Field Description
    scheduler
    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler_STATUS

    Scheduler: IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html.

    tcpFinTimeoutSeconds
    int

    TcpFinTimeoutSeconds: The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value.

    tcpTimeoutSeconds
    int

    TcpTimeoutSeconds: The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value.

    udpTimeoutSeconds
    int

    UdpTimeoutSeconds: The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value.

    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler (string alias)

    (Appears on:ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig, ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_ARM)

    Value Description

    "LeastConnection"

    "RoundRobin"

    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_Scheduler_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS, ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS_ARM)

    Value Description

    "LeastConnection"

    "RoundRobin"

    ContainerServiceNetworkProfile_KubeProxyConfig_Mode (string alias)

    (Appears on:ContainerServiceNetworkProfile_KubeProxyConfig, ContainerServiceNetworkProfile_KubeProxyConfig_ARM)

    Value Description

    "IPTABLES"

    "IPVS"

    ContainerServiceNetworkProfile_KubeProxyConfig_Mode_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_KubeProxyConfig_STATUS, ContainerServiceNetworkProfile_KubeProxyConfig_STATUS_ARM)

    Value Description

    "IPTABLES"

    "IPVS"

    ContainerServiceNetworkProfile_KubeProxyConfig_STATUS

    (Appears on:ContainerServiceNetworkProfile_STATUS)

    Field Description
    enabled
    bool

    Enabled: Whether to enable on kube-proxy on the cluster (if no ‘kubeProxyConfig’ exists, kube-proxy is enabled in AKS by default without these customizations).

    ipvsConfig
    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS

    IpvsConfig: Holds configuration customizations for IPVS. May only be specified if ‘mode’ is set to ‘IPVS’.

    mode
    ContainerServiceNetworkProfile_KubeProxyConfig_Mode_STATUS

    Mode: Specify which proxy mode to use (‘IPTABLES’ or ‘IPVS’)

    ContainerServiceNetworkProfile_KubeProxyConfig_STATUS_ARM

    (Appears on:ContainerServiceNetworkProfile_STATUS_ARM)

    Field Description
    enabled
    bool

    Enabled: Whether to enable on kube-proxy on the cluster (if no ‘kubeProxyConfig’ exists, kube-proxy is enabled in AKS by default without these customizations).

    ipvsConfig
    ContainerServiceNetworkProfile_KubeProxyConfig_IpvsConfig_STATUS_ARM

    IpvsConfig: Holds configuration customizations for IPVS. May only be specified if ‘mode’ is set to ‘IPVS’.

    mode
    ContainerServiceNetworkProfile_KubeProxyConfig_Mode_STATUS

    Mode: Specify which proxy mode to use (‘IPTABLES’ or ‘IPVS’)

    ContainerServiceNetworkProfile_OutboundType (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfile_ARM)

    Value Description

    "loadBalancer"

    "managedNATGateway"

    "userAssignedNATGateway"

    "userDefinedRouting"

    ContainerServiceNetworkProfile_OutboundType_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_STATUS, ContainerServiceNetworkProfile_STATUS_ARM)

    Value Description

    "loadBalancer"

    "managedNATGateway"

    "userAssignedNATGateway"

    "userDefinedRouting"

    ContainerServiceNetworkProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Profile of network configuration.

    Field Description
    dnsServiceIP
    string

    DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

    dockerBridgeCidr
    string

    DockerBridgeCidr: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.

    ipFamilies
    []ContainerServiceNetworkProfile_IpFamilies_STATUS

    IpFamilies: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

    kubeProxyConfig
    ContainerServiceNetworkProfile_KubeProxyConfig_STATUS

    KubeProxyConfig: Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be ‘1-23’.

    loadBalancerProfile
    ManagedClusterLoadBalancerProfile_STATUS

    LoadBalancerProfile: Profile of the cluster load balancer.

    loadBalancerSku
    LoadBalancerSku_STATUS

    LoadBalancerSku: The default is ‘standard’. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

    natGatewayProfile
    ManagedClusterNATGatewayProfile_STATUS

    NatGatewayProfile: Profile of the cluster NAT gateway.

    networkDataplane
    NetworkDataplane_STATUS

    NetworkDataplane: Network dataplane used in the Kubernetes cluster.

    networkMode
    NetworkMode_STATUS

    NetworkMode: This cannot be specified if networkPlugin is anything other than ‘azure’.

    networkPlugin
    NetworkPlugin_STATUS

    NetworkPlugin: Network plugin used for building the Kubernetes network.

    networkPluginMode
    NetworkPluginMode_STATUS

    NetworkPluginMode: Network plugin mode used for building the Kubernetes network.

    networkPolicy
    NetworkPolicy_STATUS

    NetworkPolicy: Network policy used for building the Kubernetes network.

    outboundType
    ContainerServiceNetworkProfile_OutboundType_STATUS

    OutboundType: This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

    podCidr
    string

    PodCidr: A CIDR notation IP range from which to assign pod IPs when kubenet is used.

    podCidrs
    []string

    PodCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

    serviceCidr
    string

    ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

    serviceCidrs
    []string

    ServiceCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

    ContainerServiceNetworkProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Profile of network configuration.

    Field Description
    dnsServiceIP
    string

    DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

    dockerBridgeCidr
    string

    DockerBridgeCidr: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.

    ipFamilies
    []ContainerServiceNetworkProfile_IpFamilies_STATUS

    IpFamilies: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

    kubeProxyConfig
    ContainerServiceNetworkProfile_KubeProxyConfig_STATUS_ARM

    KubeProxyConfig: Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be ‘1-23’.

    loadBalancerProfile
    ManagedClusterLoadBalancerProfile_STATUS_ARM

    LoadBalancerProfile: Profile of the cluster load balancer.

    loadBalancerSku
    LoadBalancerSku_STATUS

    LoadBalancerSku: The default is ‘standard’. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

    natGatewayProfile
    ManagedClusterNATGatewayProfile_STATUS_ARM

    NatGatewayProfile: Profile of the cluster NAT gateway.

    networkDataplane
    NetworkDataplane_STATUS

    NetworkDataplane: Network dataplane used in the Kubernetes cluster.

    networkMode
    NetworkMode_STATUS

    NetworkMode: This cannot be specified if networkPlugin is anything other than ‘azure’.

    networkPlugin
    NetworkPlugin_STATUS

    NetworkPlugin: Network plugin used for building the Kubernetes network.

    networkPluginMode
    NetworkPluginMode_STATUS

    NetworkPluginMode: Network plugin mode used for building the Kubernetes network.

    networkPolicy
    NetworkPolicy_STATUS

    NetworkPolicy: Network policy used for building the Kubernetes network.

    outboundType
    ContainerServiceNetworkProfile_OutboundType_STATUS

    OutboundType: This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

    podCidr
    string

    PodCidr: A CIDR notation IP range from which to assign pod IPs when kubenet is used.

    podCidrs
    []string

    PodCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

    serviceCidr
    string

    ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

    serviceCidrs
    []string

    ServiceCidrs: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

    ContainerServiceOSDisk (int alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    ContainerServiceSshConfiguration

    (Appears on:ContainerServiceLinuxProfile)

    SSH configuration for Linux-based VMs running on Azure.

    Field Description
    publicKeys
    []ContainerServiceSshPublicKey

    PublicKeys: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

    ContainerServiceSshConfiguration_ARM

    (Appears on:ContainerServiceLinuxProfile_ARM)

    SSH configuration for Linux-based VMs running on Azure.

    Field Description
    publicKeys
    []ContainerServiceSshPublicKey_ARM

    PublicKeys: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

    ContainerServiceSshConfiguration_STATUS

    (Appears on:ContainerServiceLinuxProfile_STATUS)

    SSH configuration for Linux-based VMs running on Azure.

    Field Description
    publicKeys
    []ContainerServiceSshPublicKey_STATUS

    PublicKeys: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

    ContainerServiceSshConfiguration_STATUS_ARM

    (Appears on:ContainerServiceLinuxProfile_STATUS_ARM)

    SSH configuration for Linux-based VMs running on Azure.

    Field Description
    publicKeys
    []ContainerServiceSshPublicKey_STATUS_ARM

    PublicKeys: The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified.

    ContainerServiceSshPublicKey

    (Appears on:ContainerServiceSshConfiguration)

    Contains information about SSH certificate public key data.

    Field Description
    keyData
    string

    KeyData: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

    ContainerServiceSshPublicKey_ARM

    (Appears on:ContainerServiceSshConfiguration_ARM)

    Contains information about SSH certificate public key data.

    Field Description
    keyData
    string

    KeyData: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

    ContainerServiceSshPublicKey_STATUS

    (Appears on:ContainerServiceSshConfiguration_STATUS)

    Contains information about SSH certificate public key data.

    Field Description
    keyData
    string

    KeyData: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

    ContainerServiceSshPublicKey_STATUS_ARM

    (Appears on:ContainerServiceSshConfiguration_STATUS_ARM)

    Contains information about SSH certificate public key data.

    Field Description
    keyData
    string

    KeyData: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

    ControlPlaneUpgradeOverride (string alias)

    (Appears on:UpgradeOverrideSettings, UpgradeOverrideSettings_ARM)

    The list of control plane upgrade override settings.

    Value Description

    "IgnoreKubernetesDeprecations"

    ControlPlaneUpgradeOverride_STATUS (string alias)

    (Appears on:UpgradeOverrideSettings_STATUS, UpgradeOverrideSettings_STATUS_ARM)

    The list of control plane upgrade override settings.

    Value Description

    "IgnoreKubernetesDeprecations"

    CreationData

    (Appears on:ManagedClusterAgentPoolProfile, ManagedCluster_Spec, ManagedClusters_AgentPool_Spec)

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

    Field Description
    sourceResourceReference
    genruntime.ResourceReference

    SourceResourceReference: This is the ARM ID of the source object to be used to create the target object.

    CreationData_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusterProperties_ARM)

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

    Field Description
    sourceResourceId
    string

    CreationData_STATUS

    (Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedCluster_STATUS, ManagedClusters_AgentPool_STATUS)

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

    Field Description
    sourceResourceId
    string

    SourceResourceId: This is the ARM ID of the source object to be used to create the target object.

    CreationData_STATUS_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusterProperties_STATUS_ARM)

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

    Field Description
    sourceResourceId
    string

    SourceResourceId: This is the ARM ID of the source object to be used to create the target object.

    ExtendedLocation

    (Appears on:ManagedCluster_Spec)

    The complex type of the extended location.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocationType (string alias)

    (Appears on:ExtendedLocation, ExtendedLocation_ARM)

    The type of extendedLocation.

    Value Description

    "EdgeZone"

    ExtendedLocationType_STATUS (string alias)

    (Appears on:ExtendedLocation_STATUS, ExtendedLocation_STATUS_ARM)

    The type of extendedLocation.

    Value Description

    "EdgeZone"

    ExtendedLocation_ARM

    (Appears on:ManagedCluster_Spec_ARM)

    The complex type of the extended location.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocation_STATUS

    (Appears on:ManagedCluster_STATUS)

    The complex type of the extended location.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_STATUS

    Type: The type of the extended location.

    ExtendedLocation_STATUS_ARM

    (Appears on:ManagedCluster_STATUS_ARM)

    The complex type of the extended location.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_STATUS

    Type: The type of the extended location.

    GPUInstanceProfile (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

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

    Value Description

    "MIG1g"

    "MIG2g"

    "MIG3g"

    "MIG4g"

    "MIG7g"

    GPUInstanceProfile_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

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

    Value Description

    "MIG1g"

    "MIG2g"

    "MIG3g"

    "MIG4g"

    "MIG7g"

    GuardrailsProfile

    (Appears on:ManagedCluster_Spec)

    The Guardrails profile.

    Field Description
    excludedNamespaces
    []string

    ExcludedNamespaces: List of namespaces excluded from guardrails checks

    level
    GuardrailsProfile_Level

    Level: The guardrails level to be used. By default, Guardrails is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces

    version
    string

    Version: The version of constraints to use

    GuardrailsProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    The Guardrails profile.

    Field Description
    excludedNamespaces
    []string

    ExcludedNamespaces: List of namespaces excluded from guardrails checks

    level
    GuardrailsProfile_Level

    Level: The guardrails level to be used. By default, Guardrails is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces

    version
    string

    Version: The version of constraints to use

    GuardrailsProfile_Level (string alias)

    (Appears on:GuardrailsProfile, GuardrailsProfile_ARM)

    Value Description

    "Enforcement"

    "Off"

    "Warning"

    GuardrailsProfile_Level_STATUS (string alias)

    (Appears on:GuardrailsProfile_STATUS, GuardrailsProfile_STATUS_ARM)

    Value Description

    "Enforcement"

    "Off"

    "Warning"

    GuardrailsProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    The Guardrails profile.

    Field Description
    excludedNamespaces
    []string

    ExcludedNamespaces: List of namespaces excluded from guardrails checks

    level
    GuardrailsProfile_Level_STATUS

    Level: The guardrails level to be used. By default, Guardrails is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces

    systemExcludedNamespaces
    []string

    SystemExcludedNamespaces: List of namespaces specified by AKS to be excluded from Guardrails

    version
    string

    Version: The version of constraints to use

    GuardrailsProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    The Guardrails profile.

    Field Description
    excludedNamespaces
    []string

    ExcludedNamespaces: List of namespaces excluded from guardrails checks

    level
    GuardrailsProfile_Level_STATUS

    Level: The guardrails level to be used. By default, Guardrails is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces

    systemExcludedNamespaces
    []string

    SystemExcludedNamespaces: List of namespaces specified by AKS to be excluded from Guardrails

    version
    string

    Version: The version of constraints to use

    IPTag

    (Appears on:AgentPoolNetworkProfile)

    Contains the IPTag associated with the object.

    Field Description
    ipTagType
    string

    IpTagType: The IP tag type. Example: RoutingPreference.

    tag
    string

    Tag: The value of the IP tag associated with the public IP. Example: Internet.

    IPTag_ARM

    (Appears on:AgentPoolNetworkProfile_ARM)

    Contains the IPTag associated with the object.

    Field Description
    ipTagType
    string

    IpTagType: The IP tag type. Example: RoutingPreference.

    tag
    string

    Tag: The value of the IP tag associated with the public IP. Example: Internet.

    IPTag_STATUS

    (Appears on:AgentPoolNetworkProfile_STATUS)

    Contains the IPTag associated with the object.

    Field Description
    ipTagType
    string

    IpTagType: The IP tag type. Example: RoutingPreference.

    tag
    string

    Tag: The value of the IP tag associated with the public IP. Example: Internet.

    IPTag_STATUS_ARM

    (Appears on:AgentPoolNetworkProfile_STATUS_ARM)

    Contains the IPTag associated with the object.

    Field Description
    ipTagType
    string

    IpTagType: The IP tag type. Example: RoutingPreference.

    tag
    string

    Tag: The value of the IP tag associated with the public IP. Example: Internet.

    IstioComponents

    (Appears on:IstioServiceMesh)

    Istio components configuration.

    Field Description
    ingressGateways
    []IstioIngressGateway

    IngressGateways: Istio ingress gateways.

    IstioComponents_ARM

    (Appears on:IstioServiceMesh_ARM)

    Istio components configuration.

    Field Description
    ingressGateways
    []IstioIngressGateway_ARM

    IngressGateways: Istio ingress gateways.

    IstioComponents_STATUS

    (Appears on:IstioServiceMesh_STATUS)

    Istio components configuration.

    Field Description
    ingressGateways
    []IstioIngressGateway_STATUS

    IngressGateways: Istio ingress gateways.

    IstioComponents_STATUS_ARM

    (Appears on:IstioServiceMesh_STATUS_ARM)

    Istio components configuration.

    Field Description
    ingressGateways
    []IstioIngressGateway_STATUS_ARM

    IngressGateways: Istio ingress gateways.

    IstioIngressGateway

    (Appears on:IstioComponents)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable the ingress gateway.

    mode
    IstioIngressGateway_Mode

    Mode: Mode of an ingress gateway.

    IstioIngressGateway_ARM

    (Appears on:IstioComponents_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable the ingress gateway.

    mode
    IstioIngressGateway_Mode

    Mode: Mode of an ingress gateway.

    IstioIngressGateway_Mode (string alias)

    (Appears on:IstioIngressGateway, IstioIngressGateway_ARM)

    Value Description

    "External"

    "Internal"

    IstioIngressGateway_Mode_STATUS (string alias)

    (Appears on:IstioIngressGateway_STATUS, IstioIngressGateway_STATUS_ARM)

    Value Description

    "External"

    "Internal"

    IstioIngressGateway_STATUS

    (Appears on:IstioComponents_STATUS)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable the ingress gateway.

    mode
    IstioIngressGateway_Mode_STATUS

    Mode: Mode of an ingress gateway.

    IstioIngressGateway_STATUS_ARM

    (Appears on:IstioComponents_STATUS_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable the ingress gateway.

    mode
    IstioIngressGateway_Mode_STATUS

    Mode: Mode of an ingress gateway.

    IstioServiceMesh

    (Appears on:ServiceMeshProfile)

    Istio service mesh configuration.

    Field Description
    components
    IstioComponents

    Components: Istio components configuration.

    IstioServiceMesh_ARM

    (Appears on:ServiceMeshProfile_ARM)

    Istio service mesh configuration.

    Field Description
    components
    IstioComponents_ARM

    Components: Istio components configuration.

    IstioServiceMesh_STATUS

    (Appears on:ServiceMeshProfile_STATUS)

    Istio service mesh configuration.

    Field Description
    components
    IstioComponents_STATUS

    Components: Istio components configuration.

    IstioServiceMesh_STATUS_ARM

    (Appears on:ServiceMeshProfile_STATUS_ARM)

    Istio service mesh configuration.

    Field Description
    components
    IstioComponents_STATUS_ARM

    Components: Istio components configuration.

    KubeletConfig

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusters_AgentPool_Spec)

    See AKS custom node configuration for more details.

    Field Description
    allowedUnsafeSysctls
    []string

    AllowedUnsafeSysctls: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

    containerLogMaxFiles
    int

    ContainerLogMaxFiles: The maximum number of container log files that can be present for a container. The number must be ≥ 2.

    containerLogMaxSizeMB
    int

    ContainerLogMaxSizeMB: The maximum size (e.g. 10Mi) of container log file before it is rotated.

    cpuCfsQuota
    bool

    CpuCfsQuota: The default is true.

    cpuCfsQuotaPeriod
    string

    CpuCfsQuotaPeriod: The default is ‘100ms.’ Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: ‘300ms’, ‘2h45m’. Supported units are ‘ns’, ‘us’, ‘ms’, ’s’, ’m’, and ‘h’.

    cpuManagerPolicy
    string

    CpuManagerPolicy: The default is ‘none’. See Kubernetes CPU management policies for more information. Allowed values are ‘none’ and ‘static’.

    failSwapOn
    bool

    FailSwapOn: If set to true it will make the Kubelet fail to start if swap is enabled on the node.

    imageGcHighThreshold
    int

    ImageGcHighThreshold: To disable image garbage collection, set to 100. The default is 85%

    imageGcLowThreshold
    int

    ImageGcLowThreshold: This cannot be set higher than imageGcHighThreshold. The default is 80%

    podMaxPids
    int

    PodMaxPids: The maximum number of processes per pod.

    topologyManagerPolicy
    string

    TopologyManagerPolicy: For more information see Kubernetes Topology Manager. The default is ‘none’. Allowed values are ‘none’, ‘best-effort’, ‘restricted’, and ‘single-numa-node’.

    KubeletConfig_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM)

    See AKS custom node configuration for more details.

    Field Description
    allowedUnsafeSysctls
    []string

    AllowedUnsafeSysctls: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

    containerLogMaxFiles
    int

    ContainerLogMaxFiles: The maximum number of container log files that can be present for a container. The number must be ≥ 2.

    containerLogMaxSizeMB
    int

    ContainerLogMaxSizeMB: The maximum size (e.g. 10Mi) of container log file before it is rotated.

    cpuCfsQuota
    bool

    CpuCfsQuota: The default is true.

    cpuCfsQuotaPeriod
    string

    CpuCfsQuotaPeriod: The default is ‘100ms.’ Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: ‘300ms’, ‘2h45m’. Supported units are ‘ns’, ‘us’, ‘ms’, ’s’, ’m’, and ‘h’.

    cpuManagerPolicy
    string

    CpuManagerPolicy: The default is ‘none’. See Kubernetes CPU management policies for more information. Allowed values are ‘none’ and ‘static’.

    failSwapOn
    bool

    FailSwapOn: If set to true it will make the Kubelet fail to start if swap is enabled on the node.

    imageGcHighThreshold
    int

    ImageGcHighThreshold: To disable image garbage collection, set to 100. The default is 85%

    imageGcLowThreshold
    int

    ImageGcLowThreshold: This cannot be set higher than imageGcHighThreshold. The default is 80%

    podMaxPids
    int

    PodMaxPids: The maximum number of processes per pod.

    topologyManagerPolicy
    string

    TopologyManagerPolicy: For more information see Kubernetes Topology Manager. The default is ‘none’. Allowed values are ‘none’, ‘best-effort’, ‘restricted’, and ‘single-numa-node’.

    KubeletConfig_STATUS

    (Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClusters_AgentPool_STATUS)

    See AKS custom node configuration for more details.

    Field Description
    allowedUnsafeSysctls
    []string

    AllowedUnsafeSysctls: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

    containerLogMaxFiles
    int

    ContainerLogMaxFiles: The maximum number of container log files that can be present for a container. The number must be ≥ 2.

    containerLogMaxSizeMB
    int

    ContainerLogMaxSizeMB: The maximum size (e.g. 10Mi) of container log file before it is rotated.

    cpuCfsQuota
    bool

    CpuCfsQuota: The default is true.

    cpuCfsQuotaPeriod
    string

    CpuCfsQuotaPeriod: The default is ‘100ms.’ Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: ‘300ms’, ‘2h45m’. Supported units are ‘ns’, ‘us’, ‘ms’, ’s’, ’m’, and ‘h’.

    cpuManagerPolicy
    string

    CpuManagerPolicy: The default is ‘none’. See Kubernetes CPU management policies for more information. Allowed values are ‘none’ and ‘static’.

    failSwapOn
    bool

    FailSwapOn: If set to true it will make the Kubelet fail to start if swap is enabled on the node.

    imageGcHighThreshold
    int

    ImageGcHighThreshold: To disable image garbage collection, set to 100. The default is 85%

    imageGcLowThreshold
    int

    ImageGcLowThreshold: This cannot be set higher than imageGcHighThreshold. The default is 80%

    podMaxPids
    int

    PodMaxPids: The maximum number of processes per pod.

    topologyManagerPolicy
    string

    TopologyManagerPolicy: For more information see Kubernetes Topology Manager. The default is ‘none’. Allowed values are ‘none’, ‘best-effort’, ‘restricted’, and ‘single-numa-node’.

    KubeletConfig_STATUS_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS_ARM)

    See AKS custom node configuration for more details.

    Field Description
    allowedUnsafeSysctls
    []string

    AllowedUnsafeSysctls: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

    containerLogMaxFiles
    int

    ContainerLogMaxFiles: The maximum number of container log files that can be present for a container. The number must be ≥ 2.

    containerLogMaxSizeMB
    int

    ContainerLogMaxSizeMB: The maximum size (e.g. 10Mi) of container log file before it is rotated.

    cpuCfsQuota
    bool

    CpuCfsQuota: The default is true.

    cpuCfsQuotaPeriod
    string

    CpuCfsQuotaPeriod: The default is ‘100ms.’ Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: ‘300ms’, ‘2h45m’. Supported units are ‘ns’, ‘us’, ‘ms’, ’s’, ’m’, and ‘h’.

    cpuManagerPolicy
    string

    CpuManagerPolicy: The default is ‘none’. See Kubernetes CPU management policies for more information. Allowed values are ‘none’ and ‘static’.

    failSwapOn
    bool

    FailSwapOn: If set to true it will make the Kubelet fail to start if swap is enabled on the node.

    imageGcHighThreshold
    int

    ImageGcHighThreshold: To disable image garbage collection, set to 100. The default is 85%

    imageGcLowThreshold
    int

    ImageGcLowThreshold: This cannot be set higher than imageGcHighThreshold. The default is 80%

    podMaxPids
    int

    PodMaxPids: The maximum number of processes per pod.

    topologyManagerPolicy
    string

    TopologyManagerPolicy: For more information see Kubernetes Topology Manager. The default is ‘none’. Allowed values are ‘none’, ‘best-effort’, ‘restricted’, and ‘single-numa-node’.

    KubeletDiskType (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

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

    Value Description

    "OS"

    "Temporary"

    KubeletDiskType_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

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

    Value Description

    "OS"

    "Temporary"

    LinuxOSConfig

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusters_AgentPool_Spec)

    See AKS custom node configuration for more details.

    Field Description
    swapFileSizeMB
    int

    SwapFileSizeMB: The size in MB of a swap file that will be created on each node.

    sysctls
    SysctlConfig

    Sysctls: Sysctl settings for Linux agent nodes.

    transparentHugePageDefrag
    string

    TransparentHugePageDefrag: Valid values are ‘always’, ‘defer’, ‘defer+madvise’, ‘madvise’ and ‘never’. The default is ‘madvise’. For more information see Transparent Hugepages.

    transparentHugePageEnabled
    string

    TransparentHugePageEnabled: Valid values are ‘always’, ‘madvise’, and ‘never’. The default is ‘always’. For more information see Transparent Hugepages.

    LinuxOSConfig_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM)

    See AKS custom node configuration for more details.

    Field Description
    swapFileSizeMB
    int

    SwapFileSizeMB: The size in MB of a swap file that will be created on each node.

    sysctls
    SysctlConfig_ARM

    Sysctls: Sysctl settings for Linux agent nodes.

    transparentHugePageDefrag
    string

    TransparentHugePageDefrag: Valid values are ‘always’, ‘defer’, ‘defer+madvise’, ‘madvise’ and ‘never’. The default is ‘madvise’. For more information see Transparent Hugepages.

    transparentHugePageEnabled
    string

    TransparentHugePageEnabled: Valid values are ‘always’, ‘madvise’, and ‘never’. The default is ‘always’. For more information see Transparent Hugepages.

    LinuxOSConfig_STATUS

    (Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedClusters_AgentPool_STATUS)

    See AKS custom node configuration for more details.

    Field Description
    swapFileSizeMB
    int

    SwapFileSizeMB: The size in MB of a swap file that will be created on each node.

    sysctls
    SysctlConfig_STATUS

    Sysctls: Sysctl settings for Linux agent nodes.

    transparentHugePageDefrag
    string

    TransparentHugePageDefrag: Valid values are ‘always’, ‘defer’, ‘defer+madvise’, ‘madvise’ and ‘never’. The default is ‘madvise’. For more information see Transparent Hugepages.

    transparentHugePageEnabled
    string

    TransparentHugePageEnabled: Valid values are ‘always’, ‘madvise’, and ‘never’. The default is ‘always’. For more information see Transparent Hugepages.

    LinuxOSConfig_STATUS_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS_ARM)

    See AKS custom node configuration for more details.

    Field Description
    swapFileSizeMB
    int

    SwapFileSizeMB: The size in MB of a swap file that will be created on each node.

    sysctls
    SysctlConfig_STATUS_ARM

    Sysctls: Sysctl settings for Linux agent nodes.

    transparentHugePageDefrag
    string

    TransparentHugePageDefrag: Valid values are ‘always’, ‘defer’, ‘defer+madvise’, ‘madvise’ and ‘never’. The default is ‘madvise’. For more information see Transparent Hugepages.

    transparentHugePageEnabled
    string

    TransparentHugePageEnabled: Valid values are ‘always’, ‘madvise’, and ‘never’. The default is ‘always’. For more information see Transparent Hugepages.

    LoadBalancerSku (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfile_ARM)

    The default is ‘standard’. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

    Value Description

    "basic"

    "standard"

    LoadBalancerSku_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_STATUS, ContainerServiceNetworkProfile_STATUS_ARM)

    The default is ‘standard’. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

    Value Description

    "basic"

    "standard"

    ManagedCluster

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ManagedCluster_Spec


    aadProfile
    ManagedClusterAADProfile

    AadProfile: The Azure Active Directory configuration.

    addonProfiles
    map[string]./api/containerservice/v1api20230202preview.ManagedClusterAddonProfile

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfile

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfile

    ApiServerAccessProfile: The access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterProperties_AutoScalerProfile

    AutoScalerProfile: Parameters to be applied to the cluster-autoscaler when enabled

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile

    AutoUpgradeProfile: The auto upgrade configuration.

    azureMonitorProfile
    ManagedClusterAzureMonitorProfile

    AzureMonitorProfile: Prometheus addon profile for the container service cluster

    azureName
    string

    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.

    creationData
    CreationData

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

    disableLocalAccounts
    bool

    DisableLocalAccounts: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

    diskEncryptionSetReference
    genruntime.ResourceReference

    DiskEncryptionSetReference: This is of the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​diskEncryptionSets/​{encryptionSetName}’

    dnsPrefix
    string

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

    enableNamespaceResources
    bool

    EnableNamespaceResources: The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

    enableRBAC
    bool

    EnableRBAC: Whether to enable Kubernetes Role-Based Access Control.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the Virtual Machine.

    fqdnSubdomain
    string

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

    guardrailsProfile
    GuardrailsProfile

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

    httpProxyConfig
    ManagedClusterHTTPProxyConfig

    HttpProxyConfig: Configurations for provisioning the cluster with HTTP proxy servers.

    identity
    ManagedClusterIdentity

    Identity: The identity of the managed cluster, if configured.

    identityProfile
    map[string]./api/containerservice/v1api20230202preview.UserAssignedIdentity

    IdentityProfile: Identities associated with the cluster.

    ingressProfile
    ManagedClusterIngressProfile

    IngressProfile: Ingress profile for the managed cluster.

    kubernetesVersion
    string

    KubernetesVersion: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

    linuxProfile
    ContainerServiceLinuxProfile

    LinuxProfile: The profile for Linux VMs in the Managed Cluster.

    location
    string

    Location: The geo-location where the resource lives

    networkProfile
    ContainerServiceNetworkProfile

    NetworkProfile: The network configuration profile.

    nodeResourceGroup
    string

    NodeResourceGroup: The name of the resource group containing agent pool nodes.

    nodeResourceGroupProfile
    ManagedClusterNodeResourceGroupProfile

    NodeResourceGroupProfile: The node resource group configuration profile.

    oidcIssuerProfile
    ManagedClusterOIDCIssuerProfile

    OidcIssuerProfile: The OIDC issuer profile of the Managed Cluster.

    operatorSpec
    ManagedClusterOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    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

    podIdentityProfile
    ManagedClusterPodIdentityProfile

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

    privateLinkResources
    []PrivateLinkResource

    PrivateLinkResources: Private link resources associated with the cluster.

    publicNetworkAccess
    ManagedClusterProperties_PublicNetworkAccess

    PublicNetworkAccess: Allow or deny public network access for AKS

    securityProfile
    ManagedClusterSecurityProfile

    SecurityProfile: Security profile for the managed cluster.

    serviceMeshProfile
    ServiceMeshProfile

    ServiceMeshProfile: Service mesh profile for a managed cluster.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfile

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

    sku
    ManagedClusterSKU

    Sku: The managed cluster SKU.

    storageProfile
    ManagedClusterStorageProfile

    StorageProfile: Storage profile for the managed cluster.

    tags
    map[string]string

    Tags: Resource tags.

    upgradeSettings
    ClusterUpgradeSettings

    UpgradeSettings: Settings for upgrading a cluster.

    windowsProfile
    ManagedClusterWindowsProfile

    WindowsProfile: The profile for Windows VMs in the Managed Cluster.

    workloadAutoScalerProfile
    ManagedClusterWorkloadAutoScalerProfile

    WorkloadAutoScalerProfile: Workload Auto-scaler profile for the managed cluster.

    status
    ManagedCluster_STATUS

    ManagedClusterAADProfile

    (Appears on:ManagedCluster_Spec)

    For more details see managed AAD on AKS.

    Field Description
    adminGroupObjectIDs
    []string

    AdminGroupObjectIDs: The list of AAD group object IDs that will have admin role of the cluster.

    clientAppID
    string

    ClientAppID: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

    enableAzureRBAC
    bool

    EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

    managed
    bool

    Managed: Whether to enable managed AAD.

    serverAppID
    string

    ServerAppID: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

    serverAppSecret
    string

    ServerAppSecret: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

    tenantID
    string

    TenantID: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

    ManagedClusterAADProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    For more details see managed AAD on AKS.

    Field Description
    adminGroupObjectIDs
    []string

    AdminGroupObjectIDs: The list of AAD group object IDs that will have admin role of the cluster.

    clientAppID
    string

    ClientAppID: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

    enableAzureRBAC
    bool

    EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

    managed
    bool

    Managed: Whether to enable managed AAD.

    serverAppID
    string

    ServerAppID: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

    serverAppSecret
    string

    ServerAppSecret: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

    tenantID
    string

    TenantID: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

    ManagedClusterAADProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    For more details see managed AAD on AKS.

    Field Description
    adminGroupObjectIDs
    []string

    AdminGroupObjectIDs: The list of AAD group object IDs that will have admin role of the cluster.

    clientAppID
    string

    ClientAppID: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

    enableAzureRBAC
    bool

    EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

    managed
    bool

    Managed: Whether to enable managed AAD.

    serverAppID
    string

    ServerAppID: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

    serverAppSecret
    string

    ServerAppSecret: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

    tenantID
    string

    TenantID: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

    ManagedClusterAADProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    For more details see managed AAD on AKS.

    Field Description
    adminGroupObjectIDs
    []string

    AdminGroupObjectIDs: The list of AAD group object IDs that will have admin role of the cluster.

    clientAppID
    string

    ClientAppID: (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

    enableAzureRBAC
    bool

    EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

    managed
    bool

    Managed: Whether to enable managed AAD.

    serverAppID
    string

    ServerAppID: (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy.

    serverAppSecret
    string

    ServerAppSecret: (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy.

    tenantID
    string

    TenantID: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

    ManagedClusterAPIServerAccessProfile

    (Appears on:ManagedCluster_Spec)

    Access profile for managed cluster API server.

    Field Description
    authorizedIPRanges
    []string

    AuthorizedIPRanges: IP ranges are specified in CIDR format, e.g. 137.117.106.8829. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

    disableRunCommand
    bool

    DisableRunCommand: Whether to disable run command for the cluster or not.

    enablePrivateCluster
    bool

    EnablePrivateCluster: For more details, see Creating a private AKS cluster.

    enablePrivateClusterPublicFQDN
    bool

    EnablePrivateClusterPublicFQDN: Whether to create additional public FQDN for private cluster or not.

    enableVnetIntegration
    bool

    EnableVnetIntegration: Whether to enable apiserver vnet integration for the cluster or not.

    privateDNSZone
    string

    PrivateDNSZone: The default is System. For more details see configure private DNS zone. Allowed values are ‘system’ and ‘none’.

    subnetId
    string

    SubnetId: It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration.

    ManagedClusterAPIServerAccessProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Access profile for managed cluster API server.

    Field Description
    authorizedIPRanges
    []string

    AuthorizedIPRanges: IP ranges are specified in CIDR format, e.g. 137.117.106.8829. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

    disableRunCommand
    bool

    DisableRunCommand: Whether to disable run command for the cluster or not.

    enablePrivateCluster
    bool

    EnablePrivateCluster: For more details, see Creating a private AKS cluster.

    enablePrivateClusterPublicFQDN
    bool

    EnablePrivateClusterPublicFQDN: Whether to create additional public FQDN for private cluster or not.

    enableVnetIntegration
    bool

    EnableVnetIntegration: Whether to enable apiserver vnet integration for the cluster or not.

    privateDNSZone
    string

    PrivateDNSZone: The default is System. For more details see configure private DNS zone. Allowed values are ‘system’ and ‘none’.

    subnetId
    string

    SubnetId: It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration.

    ManagedClusterAPIServerAccessProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Access profile for managed cluster API server.

    Field Description
    authorizedIPRanges
    []string

    AuthorizedIPRanges: IP ranges are specified in CIDR format, e.g. 137.117.106.8829. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

    disableRunCommand
    bool

    DisableRunCommand: Whether to disable run command for the cluster or not.

    enablePrivateCluster
    bool

    EnablePrivateCluster: For more details, see Creating a private AKS cluster.

    enablePrivateClusterPublicFQDN
    bool

    EnablePrivateClusterPublicFQDN: Whether to create additional public FQDN for private cluster or not.

    enableVnetIntegration
    bool

    EnableVnetIntegration: Whether to enable apiserver vnet integration for the cluster or not.

    privateDNSZone
    string

    PrivateDNSZone: The default is System. For more details see configure private DNS zone. Allowed values are ‘system’ and ‘none’.

    subnetId
    string

    SubnetId: It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration.

    ManagedClusterAPIServerAccessProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Access profile for managed cluster API server.

    Field Description
    authorizedIPRanges
    []string

    AuthorizedIPRanges: IP ranges are specified in CIDR format, e.g. 137.117.106.8829. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see API server authorized IP ranges.

    disableRunCommand
    bool

    DisableRunCommand: Whether to disable run command for the cluster or not.

    enablePrivateCluster
    bool

    EnablePrivateCluster: For more details, see Creating a private AKS cluster.

    enablePrivateClusterPublicFQDN
    bool

    EnablePrivateClusterPublicFQDN: Whether to create additional public FQDN for private cluster or not.

    enableVnetIntegration
    bool

    EnableVnetIntegration: Whether to enable apiserver vnet integration for the cluster or not.

    privateDNSZone
    string

    PrivateDNSZone: The default is System. For more details see configure private DNS zone. Allowed values are ‘system’ and ‘none’.

    subnetId
    string

    SubnetId: It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration.

    ManagedClusterAddonProfile

    (Appears on:ManagedCluster_Spec)

    A Kubernetes add-on profile for a managed cluster.

    Field Description
    config
    map[string]string

    Config: Key-value pairs for configuring an add-on.

    enabled
    bool

    Enabled: Whether the add-on is enabled or not.

    ManagedClusterAddonProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    A Kubernetes add-on profile for a managed cluster.

    Field Description
    config
    map[string]string

    Config: Key-value pairs for configuring an add-on.

    enabled
    bool

    Enabled: Whether the add-on is enabled or not.

    ManagedClusterAddonProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    A Kubernetes add-on profile for a managed cluster.

    Field Description
    config
    map[string]string

    Config: Key-value pairs for configuring an add-on.

    enabled
    bool

    Enabled: Whether the add-on is enabled or not.

    identity
    UserAssignedIdentity_STATUS

    Identity: Information of user assigned identity used by this add-on.

    ManagedClusterAddonProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    A Kubernetes add-on profile for a managed cluster.

    Field Description
    config
    map[string]string

    Config: Key-value pairs for configuring an add-on.

    enabled
    bool

    Enabled: Whether the add-on is enabled or not.

    identity
    UserAssignedIdentity_STATUS_ARM

    Identity: Information of user assigned identity used by this add-on.

    ManagedClusterAgentPoolProfile

    (Appears on:ManagedCluster_Spec)

    Profile for the container service agent pool.

    Field Description
    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    count
    int

    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.

    creationData
    CreationData

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

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile

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

    hostGroupReference
    genruntime.ResourceReference

    HostGroupReference: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

    kubeletConfig
    KubeletConfig

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType

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

    linuxOSConfig
    LinuxOSConfig

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode

    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

    name
    string

    Name: Windows agent pool names must be 6 characters or less.

    networkProfile
    AgentPoolNetworkProfile

    NetworkProfile: Network-related settings of an agent pool.

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixReference
    genruntime.ResourceReference

    NodePublicIPPrefixReference: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    ContainerServiceOSDisk
    osDiskType
    OSDiskType

    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.

    osSKU
    OSSKU

    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.

    osType
    OSType

    OsType: The operating system type. The default is Linux.

    podSubnetReference
    genruntime.ResourceReference

    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}

    powerState
    PowerState

    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

    proximityPlacementGroupReference
    genruntime.ResourceReference

    ProximityPlacementGroupReference: The ID for Proximity Placement Group.

    scaleDownMode
    ScaleDownMode

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    AgentPoolType

    Type: The type of Agent Pool.

    upgradeSettings
    AgentPoolUpgradeSettings

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetReference
    genruntime.ResourceReference

    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}

    windowsProfile
    AgentPoolWindowsProfile

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime

    WorkloadRuntime: Determines the type of workload a node can run.

    ManagedClusterAgentPoolProfileProperties_ARM

    (Appears on:ManagedClusters_AgentPool_Spec_ARM)

    Properties for the container service agent pool profile.

    Field Description
    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    count
    int

    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.

    creationData
    CreationData_ARM

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

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile

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

    hostGroupID
    string
    kubeletConfig
    KubeletConfig_ARM

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType

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

    linuxOSConfig
    LinuxOSConfig_ARM

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode

    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

    networkProfile
    AgentPoolNetworkProfile_ARM

    NetworkProfile: Network-related settings of an agent pool.

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixID
    string
    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    ContainerServiceOSDisk
    osDiskType
    OSDiskType

    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.

    osSKU
    OSSKU

    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.

    osType
    OSType

    OsType: The operating system type. The default is Linux.

    podSubnetID
    string
    powerState
    PowerState_ARM

    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

    proximityPlacementGroupID
    string
    scaleDownMode
    ScaleDownMode

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    AgentPoolType

    Type: The type of Agent Pool.

    upgradeSettings
    AgentPoolUpgradeSettings_ARM

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetID
    string
    windowsProfile
    AgentPoolWindowsProfile_ARM

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime

    WorkloadRuntime: Determines the type of workload a node can run.

    ManagedClusterAgentPoolProfileProperties_STATUS_ARM

    (Appears on:ManagedClusters_AgentPool_STATUS_ARM)

    Properties for the container service agent pool profile.

    Field Description
    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    count
    int

    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.

    creationData
    CreationData_STATUS_ARM

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

    currentOrchestratorVersion
    string

    CurrentOrchestratorVersion: If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile_STATUS

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

    hostGroupID
    string

    HostGroupID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

    kubeletConfig
    KubeletConfig_STATUS_ARM

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType_STATUS

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

    linuxOSConfig
    LinuxOSConfig_STATUS_ARM

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode_STATUS

    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

    networkProfile
    AgentPoolNetworkProfile_STATUS_ARM

    NetworkProfile: Network-related settings of an agent pool.

    nodeImageVersion
    string

    NodeImageVersion: The version of node image

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixID
    string

    NodePublicIPPrefixID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    int
    osDiskType
    OSDiskType_STATUS

    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.

    osSKU
    OSSKU_STATUS

    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.

    osType
    OSType_STATUS

    OsType: The operating system type. The default is Linux.

    podSubnetID
    string

    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}

    powerState
    PowerState_STATUS_ARM

    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

    provisioningState
    string

    ProvisioningState: The current deployment or provisioning state.

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleDownMode
    ScaleDownMode_STATUS

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy_STATUS

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority_STATUS

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    AgentPoolType_STATUS

    Type: The type of Agent Pool.

    upgradeSettings
    AgentPoolUpgradeSettings_STATUS_ARM

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetID
    string

    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}

    windowsProfile
    AgentPoolWindowsProfile_STATUS_ARM

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime_STATUS

    WorkloadRuntime: Determines the type of workload a node can run.

    ManagedClusterAgentPoolProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Profile for the container service agent pool.

    Field Description
    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    count
    int

    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.

    creationData
    CreationData_ARM

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

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile

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

    hostGroupID
    string
    kubeletConfig
    KubeletConfig_ARM

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType

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

    linuxOSConfig
    LinuxOSConfig_ARM

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode

    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

    name
    string

    Name: Windows agent pool names must be 6 characters or less.

    networkProfile
    AgentPoolNetworkProfile_ARM

    NetworkProfile: Network-related settings of an agent pool.

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixID
    string
    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    ContainerServiceOSDisk
    osDiskType
    OSDiskType

    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.

    osSKU
    OSSKU

    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.

    osType
    OSType

    OsType: The operating system type. The default is Linux.

    podSubnetID
    string
    powerState
    PowerState_ARM

    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

    proximityPlacementGroupID
    string
    scaleDownMode
    ScaleDownMode

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    AgentPoolType

    Type: The type of Agent Pool.

    upgradeSettings
    AgentPoolUpgradeSettings_ARM

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetID
    string
    windowsProfile
    AgentPoolWindowsProfile_ARM

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime

    WorkloadRuntime: Determines the type of workload a node can run.

    ManagedClusterAgentPoolProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Profile for the container service agent pool.

    Field Description
    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    count
    int

    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.

    creationData
    CreationData_STATUS

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

    currentOrchestratorVersion
    string

    CurrentOrchestratorVersion: If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile_STATUS

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

    hostGroupID
    string

    HostGroupID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

    kubeletConfig
    KubeletConfig_STATUS

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType_STATUS

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

    linuxOSConfig
    LinuxOSConfig_STATUS

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode_STATUS

    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

    name
    string

    Name: Windows agent pool names must be 6 characters or less.

    networkProfile
    AgentPoolNetworkProfile_STATUS

    NetworkProfile: Network-related settings of an agent pool.

    nodeImageVersion
    string

    NodeImageVersion: The version of node image

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixID
    string

    NodePublicIPPrefixID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    int
    osDiskType
    OSDiskType_STATUS

    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.

    osSKU
    OSSKU_STATUS

    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.

    osType
    OSType_STATUS

    OsType: The operating system type. The default is Linux.

    podSubnetID
    string

    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}

    powerState
    PowerState_STATUS

    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

    provisioningState
    string

    ProvisioningState: The current deployment or provisioning state.

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleDownMode
    ScaleDownMode_STATUS

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy_STATUS

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority_STATUS

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    AgentPoolType_STATUS

    Type: The type of Agent Pool.

    upgradeSettings
    AgentPoolUpgradeSettings_STATUS

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetID
    string

    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}

    windowsProfile
    AgentPoolWindowsProfile_STATUS

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime_STATUS

    WorkloadRuntime: Determines the type of workload a node can run.

    ManagedClusterAgentPoolProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Profile for the container service agent pool.

    Field Description
    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    count
    int

    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.

    creationData
    CreationData_STATUS_ARM

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

    currentOrchestratorVersion
    string

    CurrentOrchestratorVersion: If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile_STATUS

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

    hostGroupID
    string

    HostGroupID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

    kubeletConfig
    KubeletConfig_STATUS_ARM

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType_STATUS

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

    linuxOSConfig
    LinuxOSConfig_STATUS_ARM

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode_STATUS

    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

    name
    string

    Name: Windows agent pool names must be 6 characters or less.

    networkProfile
    AgentPoolNetworkProfile_STATUS_ARM

    NetworkProfile: Network-related settings of an agent pool.

    nodeImageVersion
    string

    NodeImageVersion: The version of node image

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixID
    string

    NodePublicIPPrefixID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    int
    osDiskType
    OSDiskType_STATUS

    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.

    osSKU
    OSSKU_STATUS

    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.

    osType
    OSType_STATUS

    OsType: The operating system type. The default is Linux.

    podSubnetID
    string

    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}

    powerState
    PowerState_STATUS_ARM

    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

    provisioningState
    string

    ProvisioningState: The current deployment or provisioning state.

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleDownMode
    ScaleDownMode_STATUS

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy_STATUS

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority_STATUS

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    AgentPoolType_STATUS

    Type: The type of Agent Pool.

    upgradeSettings
    AgentPoolUpgradeSettings_STATUS_ARM

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetID
    string

    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}

    windowsProfile
    AgentPoolWindowsProfile_STATUS_ARM

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime_STATUS

    WorkloadRuntime: Determines the type of workload a node can run.

    ManagedClusterAutoUpgradeProfile

    (Appears on:ManagedCluster_Spec)

    Auto upgrade profile for a managed cluster.

    Field Description
    nodeOSUpgradeChannel
    ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel

    NodeOSUpgradeChannel: The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA.

    upgradeChannel
    ManagedClusterAutoUpgradeProfile_UpgradeChannel

    UpgradeChannel: For more information see setting the AKS cluster auto-upgrade channel.

    ManagedClusterAutoUpgradeProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Auto upgrade profile for a managed cluster.

    Field Description
    nodeOSUpgradeChannel
    ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel

    NodeOSUpgradeChannel: The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA.

    upgradeChannel
    ManagedClusterAutoUpgradeProfile_UpgradeChannel

    UpgradeChannel: For more information see setting the AKS cluster auto-upgrade channel.

    ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel (string alias)

    (Appears on:ManagedClusterAutoUpgradeProfile, ManagedClusterAutoUpgradeProfile_ARM)

    Value Description

    "NodeImage"

    "None"

    "SecurityPatch"

    "Unmanaged"

    ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel_STATUS (string alias)

    (Appears on:ManagedClusterAutoUpgradeProfile_STATUS, ManagedClusterAutoUpgradeProfile_STATUS_ARM)

    Value Description

    "NodeImage"

    "None"

    "SecurityPatch"

    "Unmanaged"

    ManagedClusterAutoUpgradeProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Auto upgrade profile for a managed cluster.

    Field Description
    nodeOSUpgradeChannel
    ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel_STATUS

    NodeOSUpgradeChannel: The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA.

    upgradeChannel
    ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS

    UpgradeChannel: For more information see setting the AKS cluster auto-upgrade channel.

    ManagedClusterAutoUpgradeProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Auto upgrade profile for a managed cluster.

    Field Description
    nodeOSUpgradeChannel
    ManagedClusterAutoUpgradeProfile_NodeOSUpgradeChannel_STATUS

    NodeOSUpgradeChannel: The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA.

    upgradeChannel
    ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS

    UpgradeChannel: For more information see setting the AKS cluster auto-upgrade channel.

    ManagedClusterAutoUpgradeProfile_UpgradeChannel (string alias)

    (Appears on:ManagedClusterAutoUpgradeProfile, ManagedClusterAutoUpgradeProfile_ARM)

    Value Description

    "node-image"

    "none"

    "patch"

    "rapid"

    "stable"

    ManagedClusterAutoUpgradeProfile_UpgradeChannel_STATUS (string alias)

    (Appears on:ManagedClusterAutoUpgradeProfile_STATUS, ManagedClusterAutoUpgradeProfile_STATUS_ARM)

    Value Description

    "node-image"

    "none"

    "patch"

    "rapid"

    "stable"

    ManagedClusterAzureMonitorProfile

    (Appears on:ManagedCluster_Spec)

    Prometheus addon profile for the container service cluster

    Field Description
    metrics
    ManagedClusterAzureMonitorProfileMetrics

    Metrics: Metrics profile for the prometheus service addon

    ManagedClusterAzureMonitorProfileKubeStateMetrics

    (Appears on:ManagedClusterAzureMonitorProfileMetrics)

    Kube State Metrics for prometheus addon profile for the container service cluster

    Field Description
    metricAnnotationsAllowList
    string

    MetricAnnotationsAllowList: Comma-separated list of additional Kubernetes label keys that will be used in the resource’s labels metric.

    metricLabelsAllowlist
    string

    MetricLabelsAllowlist: Comma-separated list of Kubernetes annotations keys that will be used in the resource’s labels metric.

    ManagedClusterAzureMonitorProfileKubeStateMetrics_ARM

    (Appears on:ManagedClusterAzureMonitorProfileMetrics_ARM)

    Kube State Metrics for prometheus addon profile for the container service cluster

    Field Description
    metricAnnotationsAllowList
    string

    MetricAnnotationsAllowList: Comma-separated list of additional Kubernetes label keys that will be used in the resource’s labels metric.

    metricLabelsAllowlist
    string

    MetricLabelsAllowlist: Comma-separated list of Kubernetes annotations keys that will be used in the resource’s labels metric.

    ManagedClusterAzureMonitorProfileKubeStateMetrics_STATUS

    (Appears on:ManagedClusterAzureMonitorProfileMetrics_STATUS)

    Kube State Metrics for prometheus addon profile for the container service cluster

    Field Description
    metricAnnotationsAllowList
    string

    MetricAnnotationsAllowList: Comma-separated list of additional Kubernetes label keys that will be used in the resource’s labels metric.

    metricLabelsAllowlist
    string

    MetricLabelsAllowlist: Comma-separated list of Kubernetes annotations keys that will be used in the resource’s labels metric.

    ManagedClusterAzureMonitorProfileKubeStateMetrics_STATUS_ARM

    (Appears on:ManagedClusterAzureMonitorProfileMetrics_STATUS_ARM)

    Kube State Metrics for prometheus addon profile for the container service cluster

    Field Description
    metricAnnotationsAllowList
    string

    MetricAnnotationsAllowList: Comma-separated list of additional Kubernetes label keys that will be used in the resource’s labels metric.

    metricLabelsAllowlist
    string

    MetricLabelsAllowlist: Comma-separated list of Kubernetes annotations keys that will be used in the resource’s labels metric.

    ManagedClusterAzureMonitorProfileMetrics

    (Appears on:ManagedClusterAzureMonitorProfile)

    Metrics profile for the prometheus service addon

    Field Description
    enabled
    bool

    Enabled: Whether to enable the Prometheus collector

    kubeStateMetrics
    ManagedClusterAzureMonitorProfileKubeStateMetrics

    KubeStateMetrics: Kube State Metrics for prometheus addon profile for the container service cluster

    ManagedClusterAzureMonitorProfileMetrics_ARM

    (Appears on:ManagedClusterAzureMonitorProfile_ARM)

    Metrics profile for the prometheus service addon

    Field Description
    enabled
    bool

    Enabled: Whether to enable the Prometheus collector

    kubeStateMetrics
    ManagedClusterAzureMonitorProfileKubeStateMetrics_ARM

    KubeStateMetrics: Kube State Metrics for prometheus addon profile for the container service cluster

    ManagedClusterAzureMonitorProfileMetrics_STATUS

    (Appears on:ManagedClusterAzureMonitorProfile_STATUS)

    Metrics profile for the prometheus service addon

    Field Description
    enabled
    bool

    Enabled: Whether to enable the Prometheus collector

    kubeStateMetrics
    ManagedClusterAzureMonitorProfileKubeStateMetrics_STATUS

    KubeStateMetrics: Kube State Metrics for prometheus addon profile for the container service cluster

    ManagedClusterAzureMonitorProfileMetrics_STATUS_ARM

    (Appears on:ManagedClusterAzureMonitorProfile_STATUS_ARM)

    Metrics profile for the prometheus service addon

    Field Description
    enabled
    bool

    Enabled: Whether to enable the Prometheus collector

    kubeStateMetrics
    ManagedClusterAzureMonitorProfileKubeStateMetrics_STATUS_ARM

    KubeStateMetrics: Kube State Metrics for prometheus addon profile for the container service cluster

    ManagedClusterAzureMonitorProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Prometheus addon profile for the container service cluster

    Field Description
    metrics
    ManagedClusterAzureMonitorProfileMetrics_ARM

    Metrics: Metrics profile for the prometheus service addon

    ManagedClusterAzureMonitorProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Prometheus addon profile for the container service cluster

    Field Description
    metrics
    ManagedClusterAzureMonitorProfileMetrics_STATUS

    Metrics: Metrics profile for the prometheus service addon

    ManagedClusterAzureMonitorProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Prometheus addon profile for the container service cluster

    Field Description
    metrics
    ManagedClusterAzureMonitorProfileMetrics_STATUS_ARM

    Metrics: Metrics profile for the prometheus service addon

    ManagedClusterHTTPProxyConfig

    (Appears on:ManagedCluster_Spec)

    Cluster HTTP proxy configuration.

    Field Description
    httpProxy
    string

    HttpProxy: The HTTP proxy server endpoint to use.

    httpsProxy
    string

    HttpsProxy: The HTTPS proxy server endpoint to use.

    noProxy
    []string

    NoProxy: The endpoints that should not go through proxy.

    trustedCa
    string

    TrustedCa: Alternative CA cert to use for connecting to proxy servers.

    ManagedClusterHTTPProxyConfig_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Cluster HTTP proxy configuration.

    Field Description
    httpProxy
    string

    HttpProxy: The HTTP proxy server endpoint to use.

    httpsProxy
    string

    HttpsProxy: The HTTPS proxy server endpoint to use.

    noProxy
    []string

    NoProxy: The endpoints that should not go through proxy.

    trustedCa
    string

    TrustedCa: Alternative CA cert to use for connecting to proxy servers.

    ManagedClusterHTTPProxyConfig_STATUS

    (Appears on:ManagedCluster_STATUS)

    Cluster HTTP proxy configuration.

    Field Description
    effectiveNoProxy
    []string

    EffectiveNoProxy: A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS.

    httpProxy
    string

    HttpProxy: The HTTP proxy server endpoint to use.

    httpsProxy
    string

    HttpsProxy: The HTTPS proxy server endpoint to use.

    noProxy
    []string

    NoProxy: The endpoints that should not go through proxy.

    trustedCa
    string

    TrustedCa: Alternative CA cert to use for connecting to proxy servers.

    ManagedClusterHTTPProxyConfig_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Cluster HTTP proxy configuration.

    Field Description
    effectiveNoProxy
    []string

    EffectiveNoProxy: A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS.

    httpProxy
    string

    HttpProxy: The HTTP proxy server endpoint to use.

    httpsProxy
    string

    HttpsProxy: The HTTPS proxy server endpoint to use.

    noProxy
    []string

    NoProxy: The endpoints that should not go through proxy.

    trustedCa
    string

    TrustedCa: Alternative CA cert to use for connecting to proxy servers.

    ManagedClusterIdentity

    (Appears on:ManagedCluster_Spec)

    Identity for the managed cluster.

    Field Description
    type
    ManagedClusterIdentity_Type

    Type: For more information see use managed identities in AKS.

    userAssignedIdentities
    []UserAssignedIdentityDetails

    UserAssignedIdentities: The keys must be ARM resource IDs in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    ManagedClusterIdentity_ARM

    (Appears on:ManagedCluster_Spec_ARM)

    Identity for the managed cluster.

    Field Description
    type
    ManagedClusterIdentity_Type

    Type: For more information see use managed identities in AKS.

    userAssignedIdentities
    map[string]./api/containerservice/v1api20230202preview.UserAssignedIdentityDetails_ARM

    ManagedClusterIdentity_STATUS

    (Appears on:ManagedCluster_STATUS)

    Identity for the managed cluster.

    Field Description
    principalId
    string

    PrincipalId: The principal id of the system assigned identity which is used by master components.

    tenantId
    string

    TenantId: The tenant id of the system assigned identity which is used by master components.

    type
    ManagedClusterIdentity_Type_STATUS

    Type: For more information see use managed identities in AKS.

    userAssignedIdentities
    map[string]./api/containerservice/v1api20230202preview.ManagedClusterIdentity_UserAssignedIdentities_STATUS

    UserAssignedIdentities: The keys must be ARM resource IDs in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    ManagedClusterIdentity_STATUS_ARM

    (Appears on:ManagedCluster_STATUS_ARM)

    Identity for the managed cluster.

    Field Description
    principalId
    string

    PrincipalId: The principal id of the system assigned identity which is used by master components.

    tenantId
    string

    TenantId: The tenant id of the system assigned identity which is used by master components.

    type
    ManagedClusterIdentity_Type_STATUS

    Type: For more information see use managed identities in AKS.

    userAssignedIdentities
    map[string]./api/containerservice/v1api20230202preview.ManagedClusterIdentity_UserAssignedIdentities_STATUS_ARM

    UserAssignedIdentities: The keys must be ARM resource IDs in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    ManagedClusterIdentity_Type (string alias)

    (Appears on:ManagedClusterIdentity, ManagedClusterIdentity_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "UserAssigned"

    ManagedClusterIdentity_Type_STATUS (string alias)

    (Appears on:ManagedClusterIdentity_STATUS, ManagedClusterIdentity_STATUS_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "UserAssigned"

    ManagedClusterIdentity_UserAssignedIdentities_STATUS

    (Appears on:ManagedClusterIdentity_STATUS)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    ManagedClusterIdentity_UserAssignedIdentities_STATUS_ARM

    (Appears on:ManagedClusterIdentity_STATUS_ARM)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    ManagedClusterIngressProfile

    (Appears on:ManagedCluster_Spec)

    Ingress profile for the container service cluster.

    Field Description
    webAppRouting
    ManagedClusterIngressProfileWebAppRouting

    WebAppRouting: Web App Routing settings for the ingress profile.

    ManagedClusterIngressProfileWebAppRouting

    (Appears on:ManagedClusterIngressProfile)

    Web App Routing settings for the ingress profile.

    Field Description
    dnsZoneResourceReference
    genruntime.ResourceReference

    DnsZoneResourceReference: Resource ID of the DNS Zone to be associated with the web app. Used only when Web App Routing is enabled.

    enabled
    bool

    Enabled: Whether to enable Web App Routing.

    ManagedClusterIngressProfileWebAppRouting_ARM

    (Appears on:ManagedClusterIngressProfile_ARM)

    Web App Routing settings for the ingress profile.

    Field Description
    dnsZoneResourceId
    string
    enabled
    bool

    Enabled: Whether to enable Web App Routing.

    ManagedClusterIngressProfileWebAppRouting_STATUS

    (Appears on:ManagedClusterIngressProfile_STATUS)

    Web App Routing settings for the ingress profile.

    Field Description
    dnsZoneResourceId
    string

    DnsZoneResourceId: Resource ID of the DNS Zone to be associated with the web app. Used only when Web App Routing is enabled.

    enabled
    bool

    Enabled: Whether to enable Web App Routing.

    identity
    UserAssignedIdentity_STATUS

    Identity: Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See this overview of the add-on for more instructions.

    ManagedClusterIngressProfileWebAppRouting_STATUS_ARM

    (Appears on:ManagedClusterIngressProfile_STATUS_ARM)

    Web App Routing settings for the ingress profile.

    Field Description
    dnsZoneResourceId
    string

    DnsZoneResourceId: Resource ID of the DNS Zone to be associated with the web app. Used only when Web App Routing is enabled.

    enabled
    bool

    Enabled: Whether to enable Web App Routing.

    identity
    UserAssignedIdentity_STATUS_ARM

    Identity: Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See this overview of the add-on for more instructions.

    ManagedClusterIngressProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Ingress profile for the container service cluster.

    Field Description
    webAppRouting
    ManagedClusterIngressProfileWebAppRouting_ARM

    WebAppRouting: Web App Routing settings for the ingress profile.

    ManagedClusterIngressProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Ingress profile for the container service cluster.

    Field Description
    webAppRouting
    ManagedClusterIngressProfileWebAppRouting_STATUS

    WebAppRouting: Web App Routing settings for the ingress profile.

    ManagedClusterIngressProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Ingress profile for the container service cluster.

    Field Description
    webAppRouting
    ManagedClusterIngressProfileWebAppRouting_STATUS_ARM

    WebAppRouting: Web App Routing settings for the ingress profile.

    ManagedClusterLoadBalancerProfile

    (Appears on:ContainerServiceNetworkProfile)

    Profile of the managed cluster load balancer.

    Field Description
    allocatedOutboundPorts
    int

    AllocatedOutboundPorts: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.

    backendPoolType
    ManagedClusterLoadBalancerProfile_BackendPoolType

    BackendPoolType: The type of the managed inbound Load Balancer BackendPool.

    effectiveOutboundIPs
    []ResourceReference

    EffectiveOutboundIPs: The effective outbound IP resources of the cluster load balancer.

    enableMultipleStandardLoadBalancers
    bool

    EnableMultipleStandardLoadBalancers: Enable multiple standard load balancers per AKS cluster or not.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.

    managedOutboundIPs
    ManagedClusterLoadBalancerProfile_ManagedOutboundIPs

    ManagedOutboundIPs: Desired managed outbound IPs for the cluster load balancer.

    outboundIPPrefixes
    ManagedClusterLoadBalancerProfile_OutboundIPPrefixes

    OutboundIPPrefixes: Desired outbound IP Prefix resources for the cluster load balancer.

    outboundIPs
    ManagedClusterLoadBalancerProfile_OutboundIPs

    OutboundIPs: Desired outbound IP resources for the cluster load balancer.

    ManagedClusterLoadBalancerProfile_ARM

    (Appears on:ContainerServiceNetworkProfile_ARM)

    Profile of the managed cluster load balancer.

    Field Description
    allocatedOutboundPorts
    int

    AllocatedOutboundPorts: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.

    backendPoolType
    ManagedClusterLoadBalancerProfile_BackendPoolType

    BackendPoolType: The type of the managed inbound Load Balancer BackendPool.

    effectiveOutboundIPs
    []ResourceReference_ARM

    EffectiveOutboundIPs: The effective outbound IP resources of the cluster load balancer.

    enableMultipleStandardLoadBalancers
    bool

    EnableMultipleStandardLoadBalancers: Enable multiple standard load balancers per AKS cluster or not.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.

    managedOutboundIPs
    ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_ARM

    ManagedOutboundIPs: Desired managed outbound IPs for the cluster load balancer.

    outboundIPPrefixes
    ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_ARM

    OutboundIPPrefixes: Desired outbound IP Prefix resources for the cluster load balancer.

    outboundIPs
    ManagedClusterLoadBalancerProfile_OutboundIPs_ARM

    OutboundIPs: Desired outbound IP resources for the cluster load balancer.

    ManagedClusterLoadBalancerProfile_BackendPoolType (string alias)

    (Appears on:ManagedClusterLoadBalancerProfile, ManagedClusterLoadBalancerProfile_ARM)

    Value Description

    "NodeIP"

    "NodeIPConfiguration"

    ManagedClusterLoadBalancerProfile_BackendPoolType_STATUS (string alias)

    (Appears on:ManagedClusterLoadBalancerProfile_STATUS, ManagedClusterLoadBalancerProfile_STATUS_ARM)

    Value Description

    "NodeIP"

    "NodeIPConfiguration"

    ManagedClusterLoadBalancerProfile_ManagedOutboundIPs

    (Appears on:ManagedClusterLoadBalancerProfile)

    Field Description
    count
    int

    Count: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

    countIPv6
    int

    CountIPv6: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack.

    ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_ARM

    (Appears on:ManagedClusterLoadBalancerProfile_ARM)

    Field Description
    count
    int

    Count: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

    countIPv6
    int

    CountIPv6: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack.

    ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS

    (Appears on:ManagedClusterLoadBalancerProfile_STATUS)

    Field Description
    count
    int

    Count: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

    countIPv6
    int

    CountIPv6: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack.

    ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS_ARM

    (Appears on:ManagedClusterLoadBalancerProfile_STATUS_ARM)

    Field Description
    count
    int

    Count: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

    countIPv6
    int

    CountIPv6: The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack.

    ManagedClusterLoadBalancerProfile_OutboundIPPrefixes

    (Appears on:ManagedClusterLoadBalancerProfile)

    Field Description
    publicIPPrefixes
    []ResourceReference

    PublicIPPrefixes: A list of public IP prefix resources.

    ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_ARM

    (Appears on:ManagedClusterLoadBalancerProfile_ARM)

    Field Description
    publicIPPrefixes
    []ResourceReference_ARM

    PublicIPPrefixes: A list of public IP prefix resources.

    ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS

    (Appears on:ManagedClusterLoadBalancerProfile_STATUS)

    Field Description
    publicIPPrefixes
    []ResourceReference_STATUS

    PublicIPPrefixes: A list of public IP prefix resources.

    ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS_ARM

    (Appears on:ManagedClusterLoadBalancerProfile_STATUS_ARM)

    Field Description
    publicIPPrefixes
    []ResourceReference_STATUS_ARM

    PublicIPPrefixes: A list of public IP prefix resources.

    ManagedClusterLoadBalancerProfile_OutboundIPs

    (Appears on:ManagedClusterLoadBalancerProfile)

    Field Description
    publicIPs
    []ResourceReference

    PublicIPs: A list of public IP resources.

    ManagedClusterLoadBalancerProfile_OutboundIPs_ARM

    (Appears on:ManagedClusterLoadBalancerProfile_ARM)

    Field Description
    publicIPs
    []ResourceReference_ARM

    PublicIPs: A list of public IP resources.

    ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS

    (Appears on:ManagedClusterLoadBalancerProfile_STATUS)

    Field Description
    publicIPs
    []ResourceReference_STATUS

    PublicIPs: A list of public IP resources.

    ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS_ARM

    (Appears on:ManagedClusterLoadBalancerProfile_STATUS_ARM)

    Field Description
    publicIPs
    []ResourceReference_STATUS_ARM

    PublicIPs: A list of public IP resources.

    ManagedClusterLoadBalancerProfile_STATUS

    (Appears on:ContainerServiceNetworkProfile_STATUS)

    Profile of the managed cluster load balancer.

    Field Description
    allocatedOutboundPorts
    int

    AllocatedOutboundPorts: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.

    backendPoolType
    ManagedClusterLoadBalancerProfile_BackendPoolType_STATUS

    BackendPoolType: The type of the managed inbound Load Balancer BackendPool.

    effectiveOutboundIPs
    []ResourceReference_STATUS

    EffectiveOutboundIPs: The effective outbound IP resources of the cluster load balancer.

    enableMultipleStandardLoadBalancers
    bool

    EnableMultipleStandardLoadBalancers: Enable multiple standard load balancers per AKS cluster or not.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.

    managedOutboundIPs
    ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS

    ManagedOutboundIPs: Desired managed outbound IPs for the cluster load balancer.

    outboundIPPrefixes
    ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS

    OutboundIPPrefixes: Desired outbound IP Prefix resources for the cluster load balancer.

    outboundIPs
    ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS

    OutboundIPs: Desired outbound IP resources for the cluster load balancer.

    ManagedClusterLoadBalancerProfile_STATUS_ARM

    (Appears on:ContainerServiceNetworkProfile_STATUS_ARM)

    Profile of the managed cluster load balancer.

    Field Description
    allocatedOutboundPorts
    int

    AllocatedOutboundPorts: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.

    backendPoolType
    ManagedClusterLoadBalancerProfile_BackendPoolType_STATUS

    BackendPoolType: The type of the managed inbound Load Balancer BackendPool.

    effectiveOutboundIPs
    []ResourceReference_STATUS_ARM

    EffectiveOutboundIPs: The effective outbound IP resources of the cluster load balancer.

    enableMultipleStandardLoadBalancers
    bool

    EnableMultipleStandardLoadBalancers: Enable multiple standard load balancers per AKS cluster or not.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.

    managedOutboundIPs
    ManagedClusterLoadBalancerProfile_ManagedOutboundIPs_STATUS_ARM

    ManagedOutboundIPs: Desired managed outbound IPs for the cluster load balancer.

    outboundIPPrefixes
    ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS_ARM

    OutboundIPPrefixes: Desired outbound IP Prefix resources for the cluster load balancer.

    outboundIPs
    ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS_ARM

    OutboundIPs: Desired outbound IP resources for the cluster load balancer.

    ManagedClusterManagedOutboundIPProfile

    (Appears on:ManagedClusterNATGatewayProfile)

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

    Field Description
    count
    int

    Count: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1.

    ManagedClusterManagedOutboundIPProfile_ARM

    (Appears on:ManagedClusterNATGatewayProfile_ARM)

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

    Field Description
    count
    int

    Count: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1.

    ManagedClusterManagedOutboundIPProfile_STATUS

    (Appears on:ManagedClusterNATGatewayProfile_STATUS)

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

    Field Description
    count
    int

    Count: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1.

    ManagedClusterManagedOutboundIPProfile_STATUS_ARM

    (Appears on:ManagedClusterNATGatewayProfile_STATUS_ARM)

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

    Field Description
    count
    int

    Count: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1.

    ManagedClusterNATGatewayProfile

    (Appears on:ContainerServiceNetworkProfile)

    Profile of the managed cluster NAT gateway.

    Field Description
    effectiveOutboundIPs
    []ResourceReference

    EffectiveOutboundIPs: The effective outbound IP resources of the cluster NAT gateway.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.

    managedOutboundIPProfile
    ManagedClusterManagedOutboundIPProfile

    ManagedOutboundIPProfile: Profile of the managed outbound IP resources of the cluster NAT gateway.

    ManagedClusterNATGatewayProfile_ARM

    (Appears on:ContainerServiceNetworkProfile_ARM)

    Profile of the managed cluster NAT gateway.

    Field Description
    effectiveOutboundIPs
    []ResourceReference_ARM

    EffectiveOutboundIPs: The effective outbound IP resources of the cluster NAT gateway.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.

    managedOutboundIPProfile
    ManagedClusterManagedOutboundIPProfile_ARM

    ManagedOutboundIPProfile: Profile of the managed outbound IP resources of the cluster NAT gateway.

    ManagedClusterNATGatewayProfile_STATUS

    (Appears on:ContainerServiceNetworkProfile_STATUS)

    Profile of the managed cluster NAT gateway.

    Field Description
    effectiveOutboundIPs
    []ResourceReference_STATUS

    EffectiveOutboundIPs: The effective outbound IP resources of the cluster NAT gateway.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.

    managedOutboundIPProfile
    ManagedClusterManagedOutboundIPProfile_STATUS

    ManagedOutboundIPProfile: Profile of the managed outbound IP resources of the cluster NAT gateway.

    ManagedClusterNATGatewayProfile_STATUS_ARM

    (Appears on:ContainerServiceNetworkProfile_STATUS_ARM)

    Profile of the managed cluster NAT gateway.

    Field Description
    effectiveOutboundIPs
    []ResourceReference_STATUS_ARM

    EffectiveOutboundIPs: The effective outbound IP resources of the cluster NAT gateway.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.

    managedOutboundIPProfile
    ManagedClusterManagedOutboundIPProfile_STATUS_ARM

    ManagedOutboundIPProfile: Profile of the managed outbound IP resources of the cluster NAT gateway.

    ManagedClusterNodeResourceGroupProfile

    (Appears on:ManagedCluster_Spec)

    Node resource group lockdown profile for a managed cluster.

    Field Description
    restrictionLevel
    ManagedClusterNodeResourceGroupProfile_RestrictionLevel

    RestrictionLevel: The restriction level applied to the cluster’s node resource group

    ManagedClusterNodeResourceGroupProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Node resource group lockdown profile for a managed cluster.

    Field Description
    restrictionLevel
    ManagedClusterNodeResourceGroupProfile_RestrictionLevel

    RestrictionLevel: The restriction level applied to the cluster’s node resource group

    ManagedClusterNodeResourceGroupProfile_RestrictionLevel (string alias)

    (Appears on:ManagedClusterNodeResourceGroupProfile, ManagedClusterNodeResourceGroupProfile_ARM)

    Value Description

    "ReadOnly"

    "Unrestricted"

    ManagedClusterNodeResourceGroupProfile_RestrictionLevel_STATUS (string alias)

    (Appears on:ManagedClusterNodeResourceGroupProfile_STATUS, ManagedClusterNodeResourceGroupProfile_STATUS_ARM)

    Value Description

    "ReadOnly"

    "Unrestricted"

    ManagedClusterNodeResourceGroupProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Node resource group lockdown profile for a managed cluster.

    Field Description
    restrictionLevel
    ManagedClusterNodeResourceGroupProfile_RestrictionLevel_STATUS

    RestrictionLevel: The restriction level applied to the cluster’s node resource group

    ManagedClusterNodeResourceGroupProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Node resource group lockdown profile for a managed cluster.

    Field Description
    restrictionLevel
    ManagedClusterNodeResourceGroupProfile_RestrictionLevel_STATUS

    RestrictionLevel: The restriction level applied to the cluster’s node resource group

    ManagedClusterOIDCIssuerProfile

    (Appears on:ManagedCluster_Spec)

    The OIDC issuer profile of the Managed Cluster.

    Field Description
    enabled
    bool

    Enabled: Whether the OIDC issuer is enabled.

    ManagedClusterOIDCIssuerProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    The OIDC issuer profile of the Managed Cluster.

    Field Description
    enabled
    bool

    Enabled: Whether the OIDC issuer is enabled.

    ManagedClusterOIDCIssuerProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    The OIDC issuer profile of the Managed Cluster.

    Field Description
    enabled
    bool

    Enabled: Whether the OIDC issuer is enabled.

    issuerURL
    string

    IssuerURL: The OIDC issuer url of the Managed Cluster.

    ManagedClusterOIDCIssuerProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    The OIDC issuer profile of the Managed Cluster.

    Field Description
    enabled
    bool

    Enabled: Whether the OIDC issuer is enabled.

    issuerURL
    string

    IssuerURL: The OIDC issuer url of the Managed Cluster.

    ManagedClusterOperatorConfigMaps

    (Appears on:ManagedClusterOperatorSpec)

    Field Description
    oidcIssuerProfile
    genruntime.ConfigMapDestination

    OIDCIssuerProfile: indicates where the OIDCIssuerProfile config map should be placed. If omitted, no config map will be created.

    ManagedClusterOperatorSecrets

    (Appears on:ManagedClusterOperatorSpec)

    Field Description
    adminCredentials
    genruntime.SecretDestination

    AdminCredentials: indicates where the AdminCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure.

    userCredentials
    genruntime.SecretDestination

    UserCredentials: indicates where the UserCredentials secret should be placed. If omitted, the secret will not be retrieved from Azure.

    ManagedClusterOperatorSpec

    (Appears on:ManagedCluster_Spec)

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

    Field Description
    configMaps
    ManagedClusterOperatorConfigMaps

    ConfigMaps: configures where to place operator written ConfigMaps.

    secrets
    ManagedClusterOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    ManagedClusterPodIdentity

    (Appears on:ManagedClusterPodIdentityProfile)

    Details about the pod identity assigned to the Managed Cluster.

    Field Description
    bindingSelector
    string

    BindingSelector: The binding selector to use for the AzureIdentityBinding resource.

    identity
    UserAssignedIdentity

    Identity: The user assigned identity details.

    name
    string

    Name: The name of the pod identity.

    namespace
    string

    Namespace: The namespace of the pod identity.

    ManagedClusterPodIdentityException

    (Appears on:ManagedClusterPodIdentityProfile)

    Field Description
    name
    string

    Name: The name of the pod identity exception.

    namespace
    string

    Namespace: The namespace of the pod identity exception.

    podLabels
    map[string]string

    PodLabels: The pod labels to match.

    ManagedClusterPodIdentityException_ARM

    (Appears on:ManagedClusterPodIdentityProfile_ARM)

    Field Description
    name
    string

    Name: The name of the pod identity exception.

    namespace
    string

    Namespace: The namespace of the pod identity exception.

    podLabels
    map[string]string

    PodLabels: The pod labels to match.

    ManagedClusterPodIdentityException_STATUS

    (Appears on:ManagedClusterPodIdentityProfile_STATUS)

    Field Description
    name
    string

    Name: The name of the pod identity exception.

    namespace
    string

    Namespace: The namespace of the pod identity exception.

    podLabels
    map[string]string

    PodLabels: The pod labels to match.

    ManagedClusterPodIdentityException_STATUS_ARM

    (Appears on:ManagedClusterPodIdentityProfile_STATUS_ARM)

    Field Description
    name
    string

    Name: The name of the pod identity exception.

    namespace
    string

    Namespace: The namespace of the pod identity exception.

    podLabels
    map[string]string

    PodLabels: The pod labels to match.

    ManagedClusterPodIdentityProfile

    (Appears on:ManagedCluster_Spec)

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

    Field Description
    allowNetworkPluginKubenet
    bool

    AllowNetworkPluginKubenet: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See using Kubenet network plugin with AAD Pod Identity for more information.

    enabled
    bool

    Enabled: Whether the pod identity addon is enabled.

    userAssignedIdentities
    []ManagedClusterPodIdentity

    UserAssignedIdentities: The pod identities to use in the cluster.

    userAssignedIdentityExceptions
    []ManagedClusterPodIdentityException

    UserAssignedIdentityExceptions: The pod identity exceptions to allow.

    ManagedClusterPodIdentityProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

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

    Field Description
    allowNetworkPluginKubenet
    bool

    AllowNetworkPluginKubenet: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See using Kubenet network plugin with AAD Pod Identity for more information.

    enabled
    bool

    Enabled: Whether the pod identity addon is enabled.

    userAssignedIdentities
    []ManagedClusterPodIdentity_ARM

    UserAssignedIdentities: The pod identities to use in the cluster.

    userAssignedIdentityExceptions
    []ManagedClusterPodIdentityException_ARM

    UserAssignedIdentityExceptions: The pod identity exceptions to allow.

    ManagedClusterPodIdentityProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

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

    Field Description
    allowNetworkPluginKubenet
    bool

    AllowNetworkPluginKubenet: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See using Kubenet network plugin with AAD Pod Identity for more information.

    enabled
    bool

    Enabled: Whether the pod identity addon is enabled.

    userAssignedIdentities
    []ManagedClusterPodIdentity_STATUS

    UserAssignedIdentities: The pod identities to use in the cluster.

    userAssignedIdentityExceptions
    []ManagedClusterPodIdentityException_STATUS

    UserAssignedIdentityExceptions: The pod identity exceptions to allow.

    ManagedClusterPodIdentityProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

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

    Field Description
    allowNetworkPluginKubenet
    bool

    AllowNetworkPluginKubenet: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See using Kubenet network plugin with AAD Pod Identity for more information.

    enabled
    bool

    Enabled: Whether the pod identity addon is enabled.

    userAssignedIdentities
    []ManagedClusterPodIdentity_STATUS_ARM

    UserAssignedIdentities: The pod identities to use in the cluster.

    userAssignedIdentityExceptions
    []ManagedClusterPodIdentityException_STATUS_ARM

    UserAssignedIdentityExceptions: The pod identity exceptions to allow.

    ManagedClusterPodIdentityProvisioningErrorBody_STATUS

    (Appears on:ManagedClusterPodIdentityProvisioningError_STATUS)

    An error response from the pod identity provisioning.

    Field Description
    code
    string

    Code: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

    details
    []ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled

    Details: A list of additional details about the error.

    message
    string

    Message: A message describing the error, intended to be suitable for display in a user interface.

    target
    string

    Target: The target of the particular error. For example, the name of the property in error.

    ManagedClusterPodIdentityProvisioningErrorBody_STATUS_ARM

    (Appears on:ManagedClusterPodIdentityProvisioningError_STATUS_ARM)

    An error response from the pod identity provisioning.

    Field Description
    code
    string

    Code: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

    details
    []ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled_ARM

    Details: A list of additional details about the error.

    message
    string

    Message: A message describing the error, intended to be suitable for display in a user interface.

    target
    string

    Target: The target of the particular error. For example, the name of the property in error.

    ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled

    (Appears on:ManagedClusterPodIdentityProvisioningErrorBody_STATUS)

    Field Description
    code
    string

    Code: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

    message
    string

    Message: A message describing the error, intended to be suitable for display in a user interface.

    target
    string

    Target: The target of the particular error. For example, the name of the property in error.

    ManagedClusterPodIdentityProvisioningErrorBody_STATUS_Unrolled_ARM

    (Appears on:ManagedClusterPodIdentityProvisioningErrorBody_STATUS_ARM)

    Field Description
    code
    string

    Code: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

    message
    string

    Message: A message describing the error, intended to be suitable for display in a user interface.

    target
    string

    Target: The target of the particular error. For example, the name of the property in error.

    ManagedClusterPodIdentityProvisioningError_STATUS

    (Appears on:ManagedClusterPodIdentity_ProvisioningInfo_STATUS)

    An error response from the pod identity provisioning.

    Field Description
    error
    ManagedClusterPodIdentityProvisioningErrorBody_STATUS

    Error: Details about the error.

    ManagedClusterPodIdentityProvisioningError_STATUS_ARM

    (Appears on:ManagedClusterPodIdentity_ProvisioningInfo_STATUS_ARM)

    An error response from the pod identity provisioning.

    Field Description
    error
    ManagedClusterPodIdentityProvisioningErrorBody_STATUS_ARM

    Error: Details about the error.

    ManagedClusterPodIdentity_ARM

    (Appears on:ManagedClusterPodIdentityProfile_ARM)

    Details about the pod identity assigned to the Managed Cluster.

    Field Description
    bindingSelector
    string

    BindingSelector: The binding selector to use for the AzureIdentityBinding resource.

    identity
    UserAssignedIdentity_ARM

    Identity: The user assigned identity details.

    name
    string

    Name: The name of the pod identity.

    namespace
    string

    Namespace: The namespace of the pod identity.

    ManagedClusterPodIdentity_ProvisioningInfo_STATUS

    (Appears on:ManagedClusterPodIdentity_STATUS)

    Field Description
    error
    ManagedClusterPodIdentityProvisioningError_STATUS

    Error: Pod identity assignment error (if any).

    ManagedClusterPodIdentity_ProvisioningInfo_STATUS_ARM

    (Appears on:ManagedClusterPodIdentity_STATUS_ARM)

    Field Description
    error
    ManagedClusterPodIdentityProvisioningError_STATUS_ARM

    Error: Pod identity assignment error (if any).

    ManagedClusterPodIdentity_ProvisioningState_STATUS (string alias)

    (Appears on:ManagedClusterPodIdentity_STATUS, ManagedClusterPodIdentity_STATUS_ARM)

    Value Description

    "Assigned"

    "Canceled"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    ManagedClusterPodIdentity_STATUS

    (Appears on:ManagedClusterPodIdentityProfile_STATUS)

    Details about the pod identity assigned to the Managed Cluster.

    Field Description
    bindingSelector
    string

    BindingSelector: The binding selector to use for the AzureIdentityBinding resource.

    identity
    UserAssignedIdentity_STATUS

    Identity: The user assigned identity details.

    name
    string

    Name: The name of the pod identity.

    namespace
    string

    Namespace: The namespace of the pod identity.

    provisioningInfo
    ManagedClusterPodIdentity_ProvisioningInfo_STATUS
    provisioningState
    ManagedClusterPodIdentity_ProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the pod identity.

    ManagedClusterPodIdentity_STATUS_ARM

    (Appears on:ManagedClusterPodIdentityProfile_STATUS_ARM)

    Details about the pod identity assigned to the Managed Cluster.

    Field Description
    bindingSelector
    string

    BindingSelector: The binding selector to use for the AzureIdentityBinding resource.

    identity
    UserAssignedIdentity_STATUS_ARM

    Identity: The user assigned identity details.

    name
    string

    Name: The name of the pod identity.

    namespace
    string

    Namespace: The namespace of the pod identity.

    provisioningInfo
    ManagedClusterPodIdentity_ProvisioningInfo_STATUS_ARM
    provisioningState
    ManagedClusterPodIdentity_ProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the pod identity.

    ManagedClusterProperties_ARM

    (Appears on:ManagedCluster_Spec_ARM)

    Properties of the managed cluster.

    Field Description
    aadProfile
    ManagedClusterAADProfile_ARM

    AadProfile: The Azure Active Directory configuration.

    addonProfiles
    map[string]./api/containerservice/v1api20230202preview.ManagedClusterAddonProfile_ARM

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfile_ARM

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfile_ARM

    ApiServerAccessProfile: The access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterProperties_AutoScalerProfile_ARM

    AutoScalerProfile: Parameters to be applied to the cluster-autoscaler when enabled

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile_ARM

    AutoUpgradeProfile: The auto upgrade configuration.

    azureMonitorProfile
    ManagedClusterAzureMonitorProfile_ARM

    AzureMonitorProfile: Prometheus addon profile for the container service cluster

    creationData
    CreationData_ARM

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

    disableLocalAccounts
    bool

    DisableLocalAccounts: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

    diskEncryptionSetID
    string
    dnsPrefix
    string

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

    enableNamespaceResources
    bool

    EnableNamespaceResources: The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

    enableRBAC
    bool

    EnableRBAC: Whether to enable Kubernetes Role-Based Access Control.

    fqdnSubdomain
    string

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

    guardrailsProfile
    GuardrailsProfile_ARM

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

    httpProxyConfig
    ManagedClusterHTTPProxyConfig_ARM

    HttpProxyConfig: Configurations for provisioning the cluster with HTTP proxy servers.

    identityProfile
    map[string]./api/containerservice/v1api20230202preview.UserAssignedIdentity_ARM

    IdentityProfile: Identities associated with the cluster.

    ingressProfile
    ManagedClusterIngressProfile_ARM

    IngressProfile: Ingress profile for the managed cluster.

    kubernetesVersion
    string

    KubernetesVersion: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

    linuxProfile
    ContainerServiceLinuxProfile_ARM

    LinuxProfile: The profile for Linux VMs in the Managed Cluster.

    networkProfile
    ContainerServiceNetworkProfile_ARM

    NetworkProfile: The network configuration profile.

    nodeResourceGroup
    string

    NodeResourceGroup: The name of the resource group containing agent pool nodes.

    nodeResourceGroupProfile
    ManagedClusterNodeResourceGroupProfile_ARM

    NodeResourceGroupProfile: The node resource group configuration profile.

    oidcIssuerProfile
    ManagedClusterOIDCIssuerProfile_ARM

    OidcIssuerProfile: The OIDC issuer profile of the Managed Cluster.

    podIdentityProfile
    ManagedClusterPodIdentityProfile_ARM

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

    privateLinkResources
    []PrivateLinkResource_ARM

    PrivateLinkResources: Private link resources associated with the cluster.

    publicNetworkAccess
    ManagedClusterProperties_PublicNetworkAccess

    PublicNetworkAccess: Allow or deny public network access for AKS

    securityProfile
    ManagedClusterSecurityProfile_ARM

    SecurityProfile: Security profile for the managed cluster.

    serviceMeshProfile
    ServiceMeshProfile_ARM

    ServiceMeshProfile: Service mesh profile for a managed cluster.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfile_ARM

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

    storageProfile
    ManagedClusterStorageProfile_ARM

    StorageProfile: Storage profile for the managed cluster.

    upgradeSettings
    ClusterUpgradeSettings_ARM

    UpgradeSettings: Settings for upgrading a cluster.

    windowsProfile
    ManagedClusterWindowsProfile_ARM

    WindowsProfile: The profile for Windows VMs in the Managed Cluster.

    workloadAutoScalerProfile
    ManagedClusterWorkloadAutoScalerProfile_ARM

    WorkloadAutoScalerProfile: Workload Auto-scaler profile for the managed cluster.

    ManagedClusterProperties_AutoScalerProfile

    (Appears on:ManagedCluster_Spec)

    Field Description
    balance-similar-node-groups
    string

    BalanceSimilarNodeGroups: Valid values are ‘true’ and ‘false’

    expander
    ManagedClusterProperties_AutoScalerProfile_Expander

    Expander: If not specified, the default is ‘random’. See expanders for more information.

    max-empty-bulk-delete
    string

    MaxEmptyBulkDelete: The default is 10.

    max-graceful-termination-sec
    string

    MaxGracefulTerminationSec: The default is 600.

    max-node-provision-time
    string

    MaxNodeProvisionTime: The default is ‘15m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    max-total-unready-percentage
    string

    MaxTotalUnreadyPercentage: The default is 45. The maximum is 100 and the minimum is 0.

    new-pod-scale-up-delay
    string

    NewPodScaleUpDelay: For scenarios like burst/batch scale where you don’t want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they’re a certain age. The default is ‘0s’. Values must be an integer followed by a unit (’s’ for seconds, ’m’ for minutes, ‘h’ for hours, etc).

    ok-total-unready-count
    string

    OkTotalUnreadyCount: This must be an integer. The default is 3.

    scale-down-delay-after-add
    string

    ScaleDownDelayAfterAdd: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-delay-after-delete
    string

    ScaleDownDelayAfterDelete: The default is the scan-interval. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-delay-after-failure
    string

    ScaleDownDelayAfterFailure: The default is ‘3m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-unneeded-time
    string

    ScaleDownUnneededTime: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-unready-time
    string

    ScaleDownUnreadyTime: The default is ‘20m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-utilization-threshold
    string

    ScaleDownUtilizationThreshold: The default is ‘0.5’.

    scan-interval
    string

    ScanInterval: The default is ‘10’. Values must be an integer number of seconds.

    skip-nodes-with-local-storage
    string

    SkipNodesWithLocalStorage: The default is true.

    skip-nodes-with-system-pods
    string

    SkipNodesWithSystemPods: The default is true.

    ManagedClusterProperties_AutoScalerProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Field Description
    balance-similar-node-groups
    string

    BalanceSimilarNodeGroups: Valid values are ‘true’ and ‘false’

    expander
    ManagedClusterProperties_AutoScalerProfile_Expander

    Expander: If not specified, the default is ‘random’. See expanders for more information.

    max-empty-bulk-delete
    string

    MaxEmptyBulkDelete: The default is 10.

    max-graceful-termination-sec
    string

    MaxGracefulTerminationSec: The default is 600.

    max-node-provision-time
    string

    MaxNodeProvisionTime: The default is ‘15m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    max-total-unready-percentage
    string

    MaxTotalUnreadyPercentage: The default is 45. The maximum is 100 and the minimum is 0.

    new-pod-scale-up-delay
    string

    NewPodScaleUpDelay: For scenarios like burst/batch scale where you don’t want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they’re a certain age. The default is ‘0s’. Values must be an integer followed by a unit (’s’ for seconds, ’m’ for minutes, ‘h’ for hours, etc).

    ok-total-unready-count
    string

    OkTotalUnreadyCount: This must be an integer. The default is 3.

    scale-down-delay-after-add
    string

    ScaleDownDelayAfterAdd: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-delay-after-delete
    string

    ScaleDownDelayAfterDelete: The default is the scan-interval. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-delay-after-failure
    string

    ScaleDownDelayAfterFailure: The default is ‘3m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-unneeded-time
    string

    ScaleDownUnneededTime: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-unready-time
    string

    ScaleDownUnreadyTime: The default is ‘20m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-utilization-threshold
    string

    ScaleDownUtilizationThreshold: The default is ‘0.5’.

    scan-interval
    string

    ScanInterval: The default is ‘10’. Values must be an integer number of seconds.

    skip-nodes-with-local-storage
    string

    SkipNodesWithLocalStorage: The default is true.

    skip-nodes-with-system-pods
    string

    SkipNodesWithSystemPods: The default is true.

    ManagedClusterProperties_AutoScalerProfile_Expander (string alias)

    (Appears on:ManagedClusterProperties_AutoScalerProfile, ManagedClusterProperties_AutoScalerProfile_ARM)

    Value Description

    "least-waste"

    "most-pods"

    "priority"

    "random"

    ManagedClusterProperties_AutoScalerProfile_Expander_STATUS (string alias)

    (Appears on:ManagedClusterProperties_AutoScalerProfile_STATUS, ManagedClusterProperties_AutoScalerProfile_STATUS_ARM)

    Value Description

    "least-waste"

    "most-pods"

    "priority"

    "random"

    ManagedClusterProperties_AutoScalerProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Field Description
    balance-similar-node-groups
    string

    BalanceSimilarNodeGroups: Valid values are ‘true’ and ‘false’

    expander
    ManagedClusterProperties_AutoScalerProfile_Expander_STATUS

    Expander: If not specified, the default is ‘random’. See expanders for more information.

    max-empty-bulk-delete
    string

    MaxEmptyBulkDelete: The default is 10.

    max-graceful-termination-sec
    string

    MaxGracefulTerminationSec: The default is 600.

    max-node-provision-time
    string

    MaxNodeProvisionTime: The default is ‘15m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    max-total-unready-percentage
    string

    MaxTotalUnreadyPercentage: The default is 45. The maximum is 100 and the minimum is 0.

    new-pod-scale-up-delay
    string

    NewPodScaleUpDelay: For scenarios like burst/batch scale where you don’t want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they’re a certain age. The default is ‘0s’. Values must be an integer followed by a unit (’s’ for seconds, ’m’ for minutes, ‘h’ for hours, etc).

    ok-total-unready-count
    string

    OkTotalUnreadyCount: This must be an integer. The default is 3.

    scale-down-delay-after-add
    string

    ScaleDownDelayAfterAdd: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-delay-after-delete
    string

    ScaleDownDelayAfterDelete: The default is the scan-interval. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-delay-after-failure
    string

    ScaleDownDelayAfterFailure: The default is ‘3m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-unneeded-time
    string

    ScaleDownUnneededTime: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-unready-time
    string

    ScaleDownUnreadyTime: The default is ‘20m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-utilization-threshold
    string

    ScaleDownUtilizationThreshold: The default is ‘0.5’.

    scan-interval
    string

    ScanInterval: The default is ‘10’. Values must be an integer number of seconds.

    skip-nodes-with-local-storage
    string

    SkipNodesWithLocalStorage: The default is true.

    skip-nodes-with-system-pods
    string

    SkipNodesWithSystemPods: The default is true.

    ManagedClusterProperties_AutoScalerProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Field Description
    balance-similar-node-groups
    string

    BalanceSimilarNodeGroups: Valid values are ‘true’ and ‘false’

    expander
    ManagedClusterProperties_AutoScalerProfile_Expander_STATUS

    Expander: If not specified, the default is ‘random’. See expanders for more information.

    max-empty-bulk-delete
    string

    MaxEmptyBulkDelete: The default is 10.

    max-graceful-termination-sec
    string

    MaxGracefulTerminationSec: The default is 600.

    max-node-provision-time
    string

    MaxNodeProvisionTime: The default is ‘15m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    max-total-unready-percentage
    string

    MaxTotalUnreadyPercentage: The default is 45. The maximum is 100 and the minimum is 0.

    new-pod-scale-up-delay
    string

    NewPodScaleUpDelay: For scenarios like burst/batch scale where you don’t want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they’re a certain age. The default is ‘0s’. Values must be an integer followed by a unit (’s’ for seconds, ’m’ for minutes, ‘h’ for hours, etc).

    ok-total-unready-count
    string

    OkTotalUnreadyCount: This must be an integer. The default is 3.

    scale-down-delay-after-add
    string

    ScaleDownDelayAfterAdd: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-delay-after-delete
    string

    ScaleDownDelayAfterDelete: The default is the scan-interval. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-delay-after-failure
    string

    ScaleDownDelayAfterFailure: The default is ‘3m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-unneeded-time
    string

    ScaleDownUnneededTime: The default is ‘10m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-unready-time
    string

    ScaleDownUnreadyTime: The default is ‘20m’. Values must be an integer followed by an ’m’. No unit of time other than minutes (m) is supported.

    scale-down-utilization-threshold
    string

    ScaleDownUtilizationThreshold: The default is ‘0.5’.

    scan-interval
    string

    ScanInterval: The default is ‘10’. Values must be an integer number of seconds.

    skip-nodes-with-local-storage
    string

    SkipNodesWithLocalStorage: The default is true.

    skip-nodes-with-system-pods
    string

    SkipNodesWithSystemPods: The default is true.

    ManagedClusterProperties_PublicNetworkAccess (string alias)

    (Appears on:ManagedClusterProperties_ARM, ManagedCluster_Spec)

    Value Description

    "Disabled"

    "Enabled"

    "SecuredByPerimeter"

    ManagedClusterProperties_PublicNetworkAccess_STATUS (string alias)

    (Appears on:ManagedClusterProperties_STATUS_ARM, ManagedCluster_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    "SecuredByPerimeter"

    ManagedClusterProperties_STATUS_ARM

    (Appears on:ManagedCluster_STATUS_ARM)

    Properties of the managed cluster.

    Field Description
    aadProfile
    ManagedClusterAADProfile_STATUS_ARM

    AadProfile: The Azure Active Directory configuration.

    addonProfiles
    map[string]./api/containerservice/v1api20230202preview.ManagedClusterAddonProfile_STATUS_ARM

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfile_STATUS_ARM

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfile_STATUS_ARM

    ApiServerAccessProfile: The access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterProperties_AutoScalerProfile_STATUS_ARM

    AutoScalerProfile: Parameters to be applied to the cluster-autoscaler when enabled

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile_STATUS_ARM

    AutoUpgradeProfile: The auto upgrade configuration.

    azureMonitorProfile
    ManagedClusterAzureMonitorProfile_STATUS_ARM

    AzureMonitorProfile: Prometheus addon profile for the container service cluster

    azurePortalFQDN
    string

    AzurePortalFQDN: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn’t handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.

    creationData
    CreationData_STATUS_ARM

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

    currentKubernetesVersion
    string

    CurrentKubernetesVersion: The version of Kubernetes the Managed Cluster is running.

    disableLocalAccounts
    bool

    DisableLocalAccounts: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

    diskEncryptionSetID
    string

    DiskEncryptionSetID: This is of the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​diskEncryptionSets/​{encryptionSetName}’

    dnsPrefix
    string

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

    enableNamespaceResources
    bool

    EnableNamespaceResources: The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

    enableRBAC
    bool

    EnableRBAC: Whether to enable Kubernetes Role-Based Access Control.

    fqdn
    string

    Fqdn: The FQDN of the master pool.

    fqdnSubdomain
    string

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

    guardrailsProfile
    GuardrailsProfile_STATUS_ARM

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

    httpProxyConfig
    ManagedClusterHTTPProxyConfig_STATUS_ARM

    HttpProxyConfig: Configurations for provisioning the cluster with HTTP proxy servers.

    identityProfile
    map[string]./api/containerservice/v1api20230202preview.UserAssignedIdentity_STATUS_ARM

    IdentityProfile: Identities associated with the cluster.

    ingressProfile
    ManagedClusterIngressProfile_STATUS_ARM

    IngressProfile: Ingress profile for the managed cluster.

    kubernetesVersion
    string

    KubernetesVersion: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

    linuxProfile
    ContainerServiceLinuxProfile_STATUS_ARM

    LinuxProfile: The profile for Linux VMs in the Managed Cluster.

    maxAgentPools
    int

    MaxAgentPools: The max number of agent pools for the managed cluster.

    networkProfile
    ContainerServiceNetworkProfile_STATUS_ARM

    NetworkProfile: The network configuration profile.

    nodeResourceGroup
    string

    NodeResourceGroup: The name of the resource group containing agent pool nodes.

    nodeResourceGroupProfile
    ManagedClusterNodeResourceGroupProfile_STATUS_ARM

    NodeResourceGroupProfile: The node resource group configuration profile.

    oidcIssuerProfile
    ManagedClusterOIDCIssuerProfile_STATUS_ARM

    OidcIssuerProfile: The OIDC issuer profile of the Managed Cluster.

    podIdentityProfile
    ManagedClusterPodIdentityProfile_STATUS_ARM

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

    powerState
    PowerState_STATUS_ARM

    PowerState: The Power State of the cluster.

    privateFQDN
    string

    PrivateFQDN: The FQDN of private cluster.

    privateLinkResources
    []PrivateLinkResource_STATUS_ARM

    PrivateLinkResources: Private link resources associated with the cluster.

    provisioningState
    string

    ProvisioningState: The current provisioning state.

    publicNetworkAccess
    ManagedClusterProperties_PublicNetworkAccess_STATUS

    PublicNetworkAccess: Allow or deny public network access for AKS

    securityProfile
    ManagedClusterSecurityProfile_STATUS_ARM

    SecurityProfile: Security profile for the managed cluster.

    serviceMeshProfile
    ServiceMeshProfile_STATUS_ARM

    ServiceMeshProfile: Service mesh profile for a managed cluster.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfile_STATUS_ARM

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

    storageProfile
    ManagedClusterStorageProfile_STATUS_ARM

    StorageProfile: Storage profile for the managed cluster.

    upgradeSettings
    ClusterUpgradeSettings_STATUS_ARM

    UpgradeSettings: Settings for upgrading a cluster.

    windowsProfile
    ManagedClusterWindowsProfile_STATUS_ARM

    WindowsProfile: The profile for Windows VMs in the Managed Cluster.

    workloadAutoScalerProfile
    ManagedClusterWorkloadAutoScalerProfile_STATUS_ARM

    WorkloadAutoScalerProfile: Workload Auto-scaler profile for the managed cluster.

    ManagedClusterSKU

    (Appears on:ManagedCluster_Spec)

    The SKU of a Managed Cluster.

    Field Description
    name
    ManagedClusterSKU_Name

    Name: The name of a managed cluster SKU.

    tier
    ManagedClusterSKU_Tier

    Tier: If not specified, the default is ‘Free’. See AKS Pricing Tier for more details.

    ManagedClusterSKU_ARM

    (Appears on:ManagedCluster_Spec_ARM)

    The SKU of a Managed Cluster.

    Field Description
    name
    ManagedClusterSKU_Name

    Name: The name of a managed cluster SKU.

    tier
    ManagedClusterSKU_Tier

    Tier: If not specified, the default is ‘Free’. See AKS Pricing Tier for more details.

    ManagedClusterSKU_Name (string alias)

    (Appears on:ManagedClusterSKU, ManagedClusterSKU_ARM)

    Value Description

    "Base"

    ManagedClusterSKU_Name_STATUS (string alias)

    (Appears on:ManagedClusterSKU_STATUS, ManagedClusterSKU_STATUS_ARM)

    Value Description

    "Base"

    ManagedClusterSKU_STATUS

    (Appears on:ManagedCluster_STATUS)

    The SKU of a Managed Cluster.

    Field Description
    name
    ManagedClusterSKU_Name_STATUS

    Name: The name of a managed cluster SKU.

    tier
    ManagedClusterSKU_Tier_STATUS

    Tier: If not specified, the default is ‘Free’. See AKS Pricing Tier for more details.

    ManagedClusterSKU_STATUS_ARM

    (Appears on:ManagedCluster_STATUS_ARM)

    The SKU of a Managed Cluster.

    Field Description
    name
    ManagedClusterSKU_Name_STATUS

    Name: The name of a managed cluster SKU.

    tier
    ManagedClusterSKU_Tier_STATUS

    Tier: If not specified, the default is ‘Free’. See AKS Pricing Tier for more details.

    ManagedClusterSKU_Tier (string alias)

    (Appears on:ManagedClusterSKU, ManagedClusterSKU_ARM)

    Value Description

    "Free"

    "Standard"

    ManagedClusterSKU_Tier_STATUS (string alias)

    (Appears on:ManagedClusterSKU_STATUS, ManagedClusterSKU_STATUS_ARM)

    Value Description

    "Free"

    "Standard"

    ManagedClusterSecurityProfile

    (Appears on:ManagedCluster_Spec)

    Security profile for the container service cluster.

    Field Description
    azureKeyVaultKms
    AzureKeyVaultKms

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

    customCATrustCertificates
    ManagedClusterSecurityProfileCustomCATrustCertificates

    CustomCATrustCertificates: A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see Custom CA Trust Certificates

    defender
    ManagedClusterSecurityProfileDefender

    Defender: Microsoft Defender settings for the security profile.

    imageCleaner
    ManagedClusterSecurityProfileImageCleaner

    ImageCleaner: Image Cleaner settings for the security profile.

    nodeRestriction
    ManagedClusterSecurityProfileNodeRestriction

    NodeRestriction: Node Restriction settings for the security profile.

    workloadIdentity
    ManagedClusterSecurityProfileWorkloadIdentity

    WorkloadIdentity: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details.

    ManagedClusterSecurityProfileCustomCATrustCertificates ([]string alias)

    (Appears on:ManagedClusterSecurityProfile, ManagedClusterSecurityProfile_ARM)

    ManagedClusterSecurityProfileDefender

    (Appears on:ManagedClusterSecurityProfile)

    Microsoft Defender settings for the security profile.

    Field Description
    logAnalyticsWorkspaceResourceReference
    genruntime.ResourceReference

    LogAnalyticsWorkspaceResourceReference: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty.

    securityMonitoring
    ManagedClusterSecurityProfileDefenderSecurityMonitoring

    SecurityMonitoring: Microsoft Defender threat detection for Cloud settings for the security profile.

    ManagedClusterSecurityProfileDefenderSecurityMonitoring

    (Appears on:ManagedClusterSecurityProfileDefender)

    Microsoft Defender settings for the security profile threat detection.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Defender threat detection

    ManagedClusterSecurityProfileDefenderSecurityMonitoring_ARM

    (Appears on:ManagedClusterSecurityProfileDefender_ARM)

    Microsoft Defender settings for the security profile threat detection.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Defender threat detection

    ManagedClusterSecurityProfileDefenderSecurityMonitoring_STATUS

    (Appears on:ManagedClusterSecurityProfileDefender_STATUS)

    Microsoft Defender settings for the security profile threat detection.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Defender threat detection

    ManagedClusterSecurityProfileDefenderSecurityMonitoring_STATUS_ARM

    (Appears on:ManagedClusterSecurityProfileDefender_STATUS_ARM)

    Microsoft Defender settings for the security profile threat detection.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Defender threat detection

    ManagedClusterSecurityProfileDefender_ARM

    (Appears on:ManagedClusterSecurityProfile_ARM)

    Microsoft Defender settings for the security profile.

    Field Description
    logAnalyticsWorkspaceResourceId
    string
    securityMonitoring
    ManagedClusterSecurityProfileDefenderSecurityMonitoring_ARM

    SecurityMonitoring: Microsoft Defender threat detection for Cloud settings for the security profile.

    ManagedClusterSecurityProfileDefender_STATUS

    (Appears on:ManagedClusterSecurityProfile_STATUS)

    Microsoft Defender settings for the security profile.

    Field Description
    logAnalyticsWorkspaceResourceId
    string

    LogAnalyticsWorkspaceResourceId: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty.

    securityMonitoring
    ManagedClusterSecurityProfileDefenderSecurityMonitoring_STATUS

    SecurityMonitoring: Microsoft Defender threat detection for Cloud settings for the security profile.

    ManagedClusterSecurityProfileDefender_STATUS_ARM

    (Appears on:ManagedClusterSecurityProfile_STATUS_ARM)

    Microsoft Defender settings for the security profile.

    Field Description
    logAnalyticsWorkspaceResourceId
    string

    LogAnalyticsWorkspaceResourceId: Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty.

    securityMonitoring
    ManagedClusterSecurityProfileDefenderSecurityMonitoring_STATUS_ARM

    SecurityMonitoring: Microsoft Defender threat detection for Cloud settings for the security profile.

    ManagedClusterSecurityProfileImageCleaner

    (Appears on:ManagedClusterSecurityProfile)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable Image Cleaner on AKS cluster.

    intervalHours
    int

    IntervalHours: Image Cleaner scanning interval in hours.

    ManagedClusterSecurityProfileImageCleaner_ARM

    (Appears on:ManagedClusterSecurityProfile_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable Image Cleaner on AKS cluster.

    intervalHours
    int

    IntervalHours: Image Cleaner scanning interval in hours.

    ManagedClusterSecurityProfileImageCleaner_STATUS

    (Appears on:ManagedClusterSecurityProfile_STATUS)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable Image Cleaner on AKS cluster.

    intervalHours
    int

    IntervalHours: Image Cleaner scanning interval in hours.

    ManagedClusterSecurityProfileImageCleaner_STATUS_ARM

    (Appears on:ManagedClusterSecurityProfile_STATUS_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable Image Cleaner on AKS cluster.

    intervalHours
    int

    IntervalHours: Image Cleaner scanning interval in hours.

    ManagedClusterSecurityProfileNodeRestriction

    (Appears on:ManagedClusterSecurityProfile)

    Node Restriction settings for the security profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Node Restriction

    ManagedClusterSecurityProfileNodeRestriction_ARM

    (Appears on:ManagedClusterSecurityProfile_ARM)

    Node Restriction settings for the security profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Node Restriction

    ManagedClusterSecurityProfileNodeRestriction_STATUS

    (Appears on:ManagedClusterSecurityProfile_STATUS)

    Node Restriction settings for the security profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Node Restriction

    ManagedClusterSecurityProfileNodeRestriction_STATUS_ARM

    (Appears on:ManagedClusterSecurityProfile_STATUS_ARM)

    Node Restriction settings for the security profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Node Restriction

    ManagedClusterSecurityProfileWorkloadIdentity

    (Appears on:ManagedClusterSecurityProfile)

    Workload identity settings for the security profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable workload identity.

    ManagedClusterSecurityProfileWorkloadIdentity_ARM

    (Appears on:ManagedClusterSecurityProfile_ARM)

    Workload identity settings for the security profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable workload identity.

    ManagedClusterSecurityProfileWorkloadIdentity_STATUS

    (Appears on:ManagedClusterSecurityProfile_STATUS)

    Workload identity settings for the security profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable workload identity.

    ManagedClusterSecurityProfileWorkloadIdentity_STATUS_ARM

    (Appears on:ManagedClusterSecurityProfile_STATUS_ARM)

    Workload identity settings for the security profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable workload identity.

    ManagedClusterSecurityProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Security profile for the container service cluster.

    Field Description
    azureKeyVaultKms
    AzureKeyVaultKms_ARM

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

    customCATrustCertificates
    ManagedClusterSecurityProfileCustomCATrustCertificates

    CustomCATrustCertificates: A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see Custom CA Trust Certificates

    defender
    ManagedClusterSecurityProfileDefender_ARM

    Defender: Microsoft Defender settings for the security profile.

    imageCleaner
    ManagedClusterSecurityProfileImageCleaner_ARM

    ImageCleaner: Image Cleaner settings for the security profile.

    nodeRestriction
    ManagedClusterSecurityProfileNodeRestriction_ARM

    NodeRestriction: Node Restriction settings for the security profile.

    workloadIdentity
    ManagedClusterSecurityProfileWorkloadIdentity_ARM

    WorkloadIdentity: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details.

    ManagedClusterSecurityProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Security profile for the container service cluster.

    Field Description
    azureKeyVaultKms
    AzureKeyVaultKms_STATUS

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

    customCATrustCertificates
    []string

    CustomCATrustCertificates: A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see Custom CA Trust Certificates

    defender
    ManagedClusterSecurityProfileDefender_STATUS

    Defender: Microsoft Defender settings for the security profile.

    imageCleaner
    ManagedClusterSecurityProfileImageCleaner_STATUS

    ImageCleaner: Image Cleaner settings for the security profile.

    nodeRestriction
    ManagedClusterSecurityProfileNodeRestriction_STATUS

    NodeRestriction: Node Restriction settings for the security profile.

    workloadIdentity
    ManagedClusterSecurityProfileWorkloadIdentity_STATUS

    WorkloadIdentity: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details.

    ManagedClusterSecurityProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Security profile for the container service cluster.

    Field Description
    azureKeyVaultKms
    AzureKeyVaultKms_STATUS_ARM

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

    customCATrustCertificates
    []string

    CustomCATrustCertificates: A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see Custom CA Trust Certificates

    defender
    ManagedClusterSecurityProfileDefender_STATUS_ARM

    Defender: Microsoft Defender settings for the security profile.

    imageCleaner
    ManagedClusterSecurityProfileImageCleaner_STATUS_ARM

    ImageCleaner: Image Cleaner settings for the security profile.

    nodeRestriction
    ManagedClusterSecurityProfileNodeRestriction_STATUS_ARM

    NodeRestriction: Node Restriction settings for the security profile.

    workloadIdentity
    ManagedClusterSecurityProfileWorkloadIdentity_STATUS_ARM

    WorkloadIdentity: Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details.

    ManagedClusterServicePrincipalProfile

    (Appears on:ManagedCluster_Spec)

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

    Field Description
    clientId
    string

    ClientId: The ID for the service principal.

    secret
    genruntime.SecretReference

    Secret: The secret password associated with the service principal in plain text.

    ManagedClusterServicePrincipalProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

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

    Field Description
    clientId
    string

    ClientId: The ID for the service principal.

    secret
    string

    Secret: The secret password associated with the service principal in plain text.

    ManagedClusterServicePrincipalProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

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

    Field Description
    clientId
    string

    ClientId: The ID for the service principal.

    ManagedClusterServicePrincipalProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

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

    Field Description
    clientId
    string

    ClientId: The ID for the service principal.

    ManagedClusterStorageProfile

    (Appears on:ManagedCluster_Spec)

    Storage profile for the container service cluster.

    Field Description
    blobCSIDriver
    ManagedClusterStorageProfileBlobCSIDriver

    BlobCSIDriver: AzureBlob CSI Driver settings for the storage profile.

    diskCSIDriver
    ManagedClusterStorageProfileDiskCSIDriver

    DiskCSIDriver: AzureDisk CSI Driver settings for the storage profile.

    fileCSIDriver
    ManagedClusterStorageProfileFileCSIDriver

    FileCSIDriver: AzureFile CSI Driver settings for the storage profile.

    snapshotController
    ManagedClusterStorageProfileSnapshotController

    SnapshotController: Snapshot Controller settings for the storage profile.

    ManagedClusterStorageProfileBlobCSIDriver

    (Appears on:ManagedClusterStorageProfile)

    AzureBlob CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureBlob CSI Driver. The default value is false.

    ManagedClusterStorageProfileBlobCSIDriver_ARM

    (Appears on:ManagedClusterStorageProfile_ARM)

    AzureBlob CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureBlob CSI Driver. The default value is false.

    ManagedClusterStorageProfileBlobCSIDriver_STATUS

    (Appears on:ManagedClusterStorageProfile_STATUS)

    AzureBlob CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureBlob CSI Driver. The default value is false.

    ManagedClusterStorageProfileBlobCSIDriver_STATUS_ARM

    (Appears on:ManagedClusterStorageProfile_STATUS_ARM)

    AzureBlob CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureBlob CSI Driver. The default value is false.

    ManagedClusterStorageProfileDiskCSIDriver

    (Appears on:ManagedClusterStorageProfile)

    AzureDisk CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureDisk CSI Driver. The default value is true.

    version
    string

    Version: The version of AzureDisk CSI Driver. The default value is v1.

    ManagedClusterStorageProfileDiskCSIDriver_ARM

    (Appears on:ManagedClusterStorageProfile_ARM)

    AzureDisk CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureDisk CSI Driver. The default value is true.

    version
    string

    Version: The version of AzureDisk CSI Driver. The default value is v1.

    ManagedClusterStorageProfileDiskCSIDriver_STATUS

    (Appears on:ManagedClusterStorageProfile_STATUS)

    AzureDisk CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureDisk CSI Driver. The default value is true.

    version
    string

    Version: The version of AzureDisk CSI Driver. The default value is v1.

    ManagedClusterStorageProfileDiskCSIDriver_STATUS_ARM

    (Appears on:ManagedClusterStorageProfile_STATUS_ARM)

    AzureDisk CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureDisk CSI Driver. The default value is true.

    version
    string

    Version: The version of AzureDisk CSI Driver. The default value is v1.

    ManagedClusterStorageProfileFileCSIDriver

    (Appears on:ManagedClusterStorageProfile)

    AzureFile CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureFile CSI Driver. The default value is true.

    ManagedClusterStorageProfileFileCSIDriver_ARM

    (Appears on:ManagedClusterStorageProfile_ARM)

    AzureFile CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureFile CSI Driver. The default value is true.

    ManagedClusterStorageProfileFileCSIDriver_STATUS

    (Appears on:ManagedClusterStorageProfile_STATUS)

    AzureFile CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureFile CSI Driver. The default value is true.

    ManagedClusterStorageProfileFileCSIDriver_STATUS_ARM

    (Appears on:ManagedClusterStorageProfile_STATUS_ARM)

    AzureFile CSI Driver settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable AzureFile CSI Driver. The default value is true.

    ManagedClusterStorageProfileSnapshotController

    (Appears on:ManagedClusterStorageProfile)

    Snapshot Controller settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Snapshot Controller. The default value is true.

    ManagedClusterStorageProfileSnapshotController_ARM

    (Appears on:ManagedClusterStorageProfile_ARM)

    Snapshot Controller settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Snapshot Controller. The default value is true.

    ManagedClusterStorageProfileSnapshotController_STATUS

    (Appears on:ManagedClusterStorageProfile_STATUS)

    Snapshot Controller settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Snapshot Controller. The default value is true.

    ManagedClusterStorageProfileSnapshotController_STATUS_ARM

    (Appears on:ManagedClusterStorageProfile_STATUS_ARM)

    Snapshot Controller settings for the storage profile.

    Field Description
    enabled
    bool

    Enabled: Whether to enable Snapshot Controller. The default value is true.

    ManagedClusterStorageProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Storage profile for the container service cluster.

    Field Description
    blobCSIDriver
    ManagedClusterStorageProfileBlobCSIDriver_ARM

    BlobCSIDriver: AzureBlob CSI Driver settings for the storage profile.

    diskCSIDriver
    ManagedClusterStorageProfileDiskCSIDriver_ARM

    DiskCSIDriver: AzureDisk CSI Driver settings for the storage profile.

    fileCSIDriver
    ManagedClusterStorageProfileFileCSIDriver_ARM

    FileCSIDriver: AzureFile CSI Driver settings for the storage profile.

    snapshotController
    ManagedClusterStorageProfileSnapshotController_ARM

    SnapshotController: Snapshot Controller settings for the storage profile.

    ManagedClusterStorageProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Storage profile for the container service cluster.

    Field Description
    blobCSIDriver
    ManagedClusterStorageProfileBlobCSIDriver_STATUS

    BlobCSIDriver: AzureBlob CSI Driver settings for the storage profile.

    diskCSIDriver
    ManagedClusterStorageProfileDiskCSIDriver_STATUS

    DiskCSIDriver: AzureDisk CSI Driver settings for the storage profile.

    fileCSIDriver
    ManagedClusterStorageProfileFileCSIDriver_STATUS

    FileCSIDriver: AzureFile CSI Driver settings for the storage profile.

    snapshotController
    ManagedClusterStorageProfileSnapshotController_STATUS

    SnapshotController: Snapshot Controller settings for the storage profile.

    ManagedClusterStorageProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Storage profile for the container service cluster.

    Field Description
    blobCSIDriver
    ManagedClusterStorageProfileBlobCSIDriver_STATUS_ARM

    BlobCSIDriver: AzureBlob CSI Driver settings for the storage profile.

    diskCSIDriver
    ManagedClusterStorageProfileDiskCSIDriver_STATUS_ARM

    DiskCSIDriver: AzureDisk CSI Driver settings for the storage profile.

    fileCSIDriver
    ManagedClusterStorageProfileFileCSIDriver_STATUS_ARM

    FileCSIDriver: AzureFile CSI Driver settings for the storage profile.

    snapshotController
    ManagedClusterStorageProfileSnapshotController_STATUS_ARM

    SnapshotController: Snapshot Controller settings for the storage profile.

    ManagedClusterWindowsProfile

    (Appears on:ManagedCluster_Spec)

    Profile for Windows VMs in the managed cluster.

    Field Description
    adminPassword
    string

    AdminPassword: Specifies the password of the administrator account. Minimum-length: 8 characters Max-length: 123 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”

    adminUsername
    string

    AdminUsername: Specifies the name of the administrator account. Restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length: 1 character Max-length: 20 characters

    enableCSIProxy
    bool

    EnableCSIProxy: For more details on CSI proxy, see the CSI proxy GitHub repo.

    gmsaProfile
    WindowsGmsaProfile

    GmsaProfile: The Windows gMSA Profile in the Managed Cluster.

    licenseType
    ManagedClusterWindowsProfile_LicenseType

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

    ManagedClusterWindowsProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Profile for Windows VMs in the managed cluster.

    Field Description
    adminPassword
    string

    AdminPassword: Specifies the password of the administrator account. Minimum-length: 8 characters Max-length: 123 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”

    adminUsername
    string

    AdminUsername: Specifies the name of the administrator account. Restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length: 1 character Max-length: 20 characters

    enableCSIProxy
    bool

    EnableCSIProxy: For more details on CSI proxy, see the CSI proxy GitHub repo.

    gmsaProfile
    WindowsGmsaProfile_ARM

    GmsaProfile: The Windows gMSA Profile in the Managed Cluster.

    licenseType
    ManagedClusterWindowsProfile_LicenseType

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

    ManagedClusterWindowsProfile_LicenseType (string alias)

    (Appears on:ManagedClusterWindowsProfile, ManagedClusterWindowsProfile_ARM)

    Value Description

    "None"

    "Windows_Server"

    ManagedClusterWindowsProfile_LicenseType_STATUS (string alias)

    (Appears on:ManagedClusterWindowsProfile_STATUS, ManagedClusterWindowsProfile_STATUS_ARM)

    Value Description

    "None"

    "Windows_Server"

    ManagedClusterWindowsProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Profile for Windows VMs in the managed cluster.

    Field Description
    adminPassword
    string

    AdminPassword: Specifies the password of the administrator account. Minimum-length: 8 characters Max-length: 123 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”

    adminUsername
    string

    AdminUsername: Specifies the name of the administrator account. Restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length: 1 character Max-length: 20 characters

    enableCSIProxy
    bool

    EnableCSIProxy: For more details on CSI proxy, see the CSI proxy GitHub repo.

    gmsaProfile
    WindowsGmsaProfile_STATUS

    GmsaProfile: The Windows gMSA Profile in the Managed Cluster.

    licenseType
    ManagedClusterWindowsProfile_LicenseType_STATUS

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

    ManagedClusterWindowsProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Profile for Windows VMs in the managed cluster.

    Field Description
    adminPassword
    string

    AdminPassword: Specifies the password of the administrator account. Minimum-length: 8 characters Max-length: 123 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!”

    adminUsername
    string

    AdminUsername: Specifies the name of the administrator account. Restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length: 1 character Max-length: 20 characters

    enableCSIProxy
    bool

    EnableCSIProxy: For more details on CSI proxy, see the CSI proxy GitHub repo.

    gmsaProfile
    WindowsGmsaProfile_STATUS_ARM

    GmsaProfile: The Windows gMSA Profile in the Managed Cluster.

    licenseType
    ManagedClusterWindowsProfile_LicenseType_STATUS

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

    ManagedClusterWorkloadAutoScalerProfile

    (Appears on:ManagedCluster_Spec)

    Workload Auto-scaler profile for the managed cluster.

    Field Description
    keda
    ManagedClusterWorkloadAutoScalerProfileKeda

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

    verticalPodAutoscaler
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

    ManagedClusterWorkloadAutoScalerProfileKeda

    (Appears on:ManagedClusterWorkloadAutoScalerProfile)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable KEDA.

    ManagedClusterWorkloadAutoScalerProfileKeda_ARM

    (Appears on:ManagedClusterWorkloadAutoScalerProfile_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable KEDA.

    ManagedClusterWorkloadAutoScalerProfileKeda_STATUS

    (Appears on:ManagedClusterWorkloadAutoScalerProfile_STATUS)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable KEDA.

    ManagedClusterWorkloadAutoScalerProfileKeda_STATUS_ARM

    (Appears on:ManagedClusterWorkloadAutoScalerProfile_STATUS_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Whether to enable KEDA.

    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

    (Appears on:ManagedClusterWorkloadAutoScalerProfile)

    Field Description
    controlledValues
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ControlledValues

    ControlledValues: Controls which resource value autoscaler will change. Default value is RequestsAndLimits.

    enabled
    bool

    Enabled: Whether to enable VPA. Default value is false.

    updateMode
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_UpdateMode

    UpdateMode: Each update mode level is a superset of the lower levels. Off

    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ARM

    (Appears on:ManagedClusterWorkloadAutoScalerProfile_ARM)

    Field Description
    controlledValues
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ControlledValues

    ControlledValues: Controls which resource value autoscaler will change. Default value is RequestsAndLimits.

    enabled
    bool

    Enabled: Whether to enable VPA. Default value is false.

    updateMode
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_UpdateMode

    UpdateMode: Each update mode level is a superset of the lower levels. Off

    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ControlledValues (string alias)

    (Appears on:ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler, ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ARM)

    Value Description

    "RequestsAndLimits"

    "RequestsOnly"

    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ControlledValues_STATUS (string alias)

    (Appears on:ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS, ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS_ARM)

    Value Description

    "RequestsAndLimits"

    "RequestsOnly"

    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS

    (Appears on:ManagedClusterWorkloadAutoScalerProfile_STATUS)

    Field Description
    controlledValues
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ControlledValues_STATUS

    ControlledValues: Controls which resource value autoscaler will change. Default value is RequestsAndLimits.

    enabled
    bool

    Enabled: Whether to enable VPA. Default value is false.

    updateMode
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_UpdateMode_STATUS

    UpdateMode: Each update mode level is a superset of the lower levels. Off

    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS_ARM

    (Appears on:ManagedClusterWorkloadAutoScalerProfile_STATUS_ARM)

    Field Description
    controlledValues
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ControlledValues_STATUS

    ControlledValues: Controls which resource value autoscaler will change. Default value is RequestsAndLimits.

    enabled
    bool

    Enabled: Whether to enable VPA. Default value is false.

    updateMode
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_UpdateMode_STATUS

    UpdateMode: Each update mode level is a superset of the lower levels. Off

    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_UpdateMode (string alias)

    (Appears on:ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler, ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ARM)

    Value Description

    "Auto"

    "Initial"

    "Off"

    "Recreate"

    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_UpdateMode_STATUS (string alias)

    (Appears on:ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS, ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS_ARM)

    Value Description

    "Auto"

    "Initial"

    "Off"

    "Recreate"

    ManagedClusterWorkloadAutoScalerProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Workload Auto-scaler profile for the managed cluster.

    Field Description
    keda
    ManagedClusterWorkloadAutoScalerProfileKeda_ARM

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

    verticalPodAutoscaler
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_ARM

    ManagedClusterWorkloadAutoScalerProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Workload Auto-scaler profile for the managed cluster.

    Field Description
    keda
    ManagedClusterWorkloadAutoScalerProfileKeda_STATUS

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

    verticalPodAutoscaler
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS

    ManagedClusterWorkloadAutoScalerProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Workload Auto-scaler profile for the managed cluster.

    Field Description
    keda
    ManagedClusterWorkloadAutoScalerProfileKeda_STATUS_ARM

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

    verticalPodAutoscaler
    ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler_STATUS_ARM

    ManagedCluster_STATUS

    (Appears on:ManagedCluster)

    Managed cluster.

    Field Description
    aadProfile
    ManagedClusterAADProfile_STATUS

    AadProfile: The Azure Active Directory configuration.

    addonProfiles
    map[string]./api/containerservice/v1api20230202preview.ManagedClusterAddonProfile_STATUS

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfile_STATUS

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfile_STATUS

    ApiServerAccessProfile: The access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterProperties_AutoScalerProfile_STATUS

    AutoScalerProfile: Parameters to be applied to the cluster-autoscaler when enabled

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile_STATUS

    AutoUpgradeProfile: The auto upgrade configuration.

    azureMonitorProfile
    ManagedClusterAzureMonitorProfile_STATUS

    AzureMonitorProfile: Prometheus addon profile for the container service cluster

    azurePortalFQDN
    string

    AzurePortalFQDN: The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn’t handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    creationData
    CreationData_STATUS

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

    currentKubernetesVersion
    string

    CurrentKubernetesVersion: The version of Kubernetes the Managed Cluster is running.

    disableLocalAccounts
    bool

    DisableLocalAccounts: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

    diskEncryptionSetID
    string

    DiskEncryptionSetID: This is of the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​diskEncryptionSets/​{encryptionSetName}’

    dnsPrefix
    string

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

    enableNamespaceResources
    bool

    EnableNamespaceResources: The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

    enableRBAC
    bool

    EnableRBAC: Whether to enable Kubernetes Role-Based Access Control.

    extendedLocation
    ExtendedLocation_STATUS

    ExtendedLocation: The extended location of the Virtual Machine.

    fqdn
    string

    Fqdn: The FQDN of the master pool.

    fqdnSubdomain
    string

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

    guardrailsProfile
    GuardrailsProfile_STATUS

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

    httpProxyConfig
    ManagedClusterHTTPProxyConfig_STATUS

    HttpProxyConfig: Configurations for provisioning the cluster with HTTP proxy servers.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    identity
    ManagedClusterIdentity_STATUS

    Identity: The identity of the managed cluster, if configured.

    identityProfile
    map[string]./api/containerservice/v1api20230202preview.UserAssignedIdentity_STATUS

    IdentityProfile: Identities associated with the cluster.

    ingressProfile
    ManagedClusterIngressProfile_STATUS

    IngressProfile: Ingress profile for the managed cluster.

    kubernetesVersion
    string

    KubernetesVersion: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

    linuxProfile
    ContainerServiceLinuxProfile_STATUS

    LinuxProfile: The profile for Linux VMs in the Managed Cluster.

    location
    string

    Location: The geo-location where the resource lives

    maxAgentPools
    int

    MaxAgentPools: The max number of agent pools for the managed cluster.

    name
    string

    Name: The name of the resource

    networkProfile
    ContainerServiceNetworkProfile_STATUS

    NetworkProfile: The network configuration profile.

    nodeResourceGroup
    string

    NodeResourceGroup: The name of the resource group containing agent pool nodes.

    nodeResourceGroupProfile
    ManagedClusterNodeResourceGroupProfile_STATUS

    NodeResourceGroupProfile: The node resource group configuration profile.

    oidcIssuerProfile
    ManagedClusterOIDCIssuerProfile_STATUS

    OidcIssuerProfile: The OIDC issuer profile of the Managed Cluster.

    podIdentityProfile
    ManagedClusterPodIdentityProfile_STATUS

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

    powerState
    PowerState_STATUS

    PowerState: The Power State of the cluster.

    privateFQDN
    string

    PrivateFQDN: The FQDN of private cluster.

    privateLinkResources
    []PrivateLinkResource_STATUS

    PrivateLinkResources: Private link resources associated with the cluster.

    provisioningState
    string

    ProvisioningState: The current provisioning state.

    publicNetworkAccess
    ManagedClusterProperties_PublicNetworkAccess_STATUS

    PublicNetworkAccess: Allow or deny public network access for AKS

    securityProfile
    ManagedClusterSecurityProfile_STATUS

    SecurityProfile: Security profile for the managed cluster.

    serviceMeshProfile
    ServiceMeshProfile_STATUS

    ServiceMeshProfile: Service mesh profile for a managed cluster.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfile_STATUS

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

    sku
    ManagedClusterSKU_STATUS

    Sku: The managed cluster SKU.

    storageProfile
    ManagedClusterStorageProfile_STATUS

    StorageProfile: Storage profile for the managed cluster.

    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    upgradeSettings
    ClusterUpgradeSettings_STATUS

    UpgradeSettings: Settings for upgrading a cluster.

    windowsProfile
    ManagedClusterWindowsProfile_STATUS

    WindowsProfile: The profile for Windows VMs in the Managed Cluster.

    workloadAutoScalerProfile
    ManagedClusterWorkloadAutoScalerProfile_STATUS

    WorkloadAutoScalerProfile: Workload Auto-scaler profile for the managed cluster.

    ManagedCluster_STATUS_ARM

    Managed cluster.

    Field Description
    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the Virtual Machine.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    identity
    ManagedClusterIdentity_STATUS_ARM

    Identity: The identity of the managed cluster, if configured.

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    ManagedClusterProperties_STATUS_ARM

    Properties: Properties of a managed cluster.

    sku
    ManagedClusterSKU_STATUS_ARM

    Sku: The managed cluster SKU.

    systemData
    SystemData_STATUS_ARM

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    ManagedCluster_Spec

    (Appears on:ManagedCluster)

    Field Description
    aadProfile
    ManagedClusterAADProfile

    AadProfile: The Azure Active Directory configuration.

    addonProfiles
    map[string]./api/containerservice/v1api20230202preview.ManagedClusterAddonProfile

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfile

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfile

    ApiServerAccessProfile: The access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterProperties_AutoScalerProfile

    AutoScalerProfile: Parameters to be applied to the cluster-autoscaler when enabled

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile

    AutoUpgradeProfile: The auto upgrade configuration.

    azureMonitorProfile
    ManagedClusterAzureMonitorProfile

    AzureMonitorProfile: Prometheus addon profile for the container service cluster

    azureName
    string

    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.

    creationData
    CreationData

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

    disableLocalAccounts
    bool

    DisableLocalAccounts: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see disable local accounts.

    diskEncryptionSetReference
    genruntime.ResourceReference

    DiskEncryptionSetReference: This is of the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​diskEncryptionSets/​{encryptionSetName}’

    dnsPrefix
    string

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

    enableNamespaceResources
    bool

    EnableNamespaceResources: The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

    enableRBAC
    bool

    EnableRBAC: Whether to enable Kubernetes Role-Based Access Control.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the Virtual Machine.

    fqdnSubdomain
    string

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

    guardrailsProfile
    GuardrailsProfile

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

    httpProxyConfig
    ManagedClusterHTTPProxyConfig

    HttpProxyConfig: Configurations for provisioning the cluster with HTTP proxy servers.

    identity
    ManagedClusterIdentity

    Identity: The identity of the managed cluster, if configured.

    identityProfile
    map[string]./api/containerservice/v1api20230202preview.UserAssignedIdentity

    IdentityProfile: Identities associated with the cluster.

    ingressProfile
    ManagedClusterIngressProfile

    IngressProfile: Ingress profile for the managed cluster.

    kubernetesVersion
    string

    KubernetesVersion: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See upgrading an AKS cluster for more details.

    linuxProfile
    ContainerServiceLinuxProfile

    LinuxProfile: The profile for Linux VMs in the Managed Cluster.

    location
    string

    Location: The geo-location where the resource lives

    networkProfile
    ContainerServiceNetworkProfile

    NetworkProfile: The network configuration profile.

    nodeResourceGroup
    string

    NodeResourceGroup: The name of the resource group containing agent pool nodes.

    nodeResourceGroupProfile
    ManagedClusterNodeResourceGroupProfile

    NodeResourceGroupProfile: The node resource group configuration profile.

    oidcIssuerProfile
    ManagedClusterOIDCIssuerProfile

    OidcIssuerProfile: The OIDC issuer profile of the Managed Cluster.

    operatorSpec
    ManagedClusterOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    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

    podIdentityProfile
    ManagedClusterPodIdentityProfile

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

    privateLinkResources
    []PrivateLinkResource

    PrivateLinkResources: Private link resources associated with the cluster.

    publicNetworkAccess
    ManagedClusterProperties_PublicNetworkAccess

    PublicNetworkAccess: Allow or deny public network access for AKS

    securityProfile
    ManagedClusterSecurityProfile

    SecurityProfile: Security profile for the managed cluster.

    serviceMeshProfile
    ServiceMeshProfile

    ServiceMeshProfile: Service mesh profile for a managed cluster.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfile

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

    sku
    ManagedClusterSKU

    Sku: The managed cluster SKU.

    storageProfile
    ManagedClusterStorageProfile

    StorageProfile: Storage profile for the managed cluster.

    tags
    map[string]string

    Tags: Resource tags.

    upgradeSettings
    ClusterUpgradeSettings

    UpgradeSettings: Settings for upgrading a cluster.

    windowsProfile
    ManagedClusterWindowsProfile

    WindowsProfile: The profile for Windows VMs in the Managed Cluster.

    workloadAutoScalerProfile
    ManagedClusterWorkloadAutoScalerProfile

    WorkloadAutoScalerProfile: Workload Auto-scaler profile for the managed cluster.

    ManagedCluster_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the Virtual Machine.

    identity
    ManagedClusterIdentity_ARM

    Identity: The identity of the managed cluster, if configured.

    location
    string

    Location: The geo-location where the resource lives

    name
    string
    properties
    ManagedClusterProperties_ARM

    Properties: Properties of a managed cluster.

    sku
    ManagedClusterSKU_ARM

    Sku: The managed cluster SKU.

    tags
    map[string]string

    Tags: Resource tags.

    ManagedClustersAgentPool

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ManagedClusters_AgentPool_Spec


    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    azureName
    string

    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.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    count
    int

    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.

    creationData
    CreationData

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

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile

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

    hostGroupReference
    genruntime.ResourceReference

    HostGroupReference: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

    kubeletConfig
    KubeletConfig

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType

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

    linuxOSConfig
    LinuxOSConfig

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode

    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

    networkProfile
    AgentPoolNetworkProfile

    NetworkProfile: Network-related settings of an agent pool.

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixReference
    genruntime.ResourceReference

    NodePublicIPPrefixReference: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    ContainerServiceOSDisk
    osDiskType
    OSDiskType

    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.

    osSKU
    OSSKU

    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.

    osType
    OSType

    OsType: The operating system type. The default is Linux.

    owner
    genruntime.KnownResourceReference

    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

    podSubnetReference
    genruntime.ResourceReference

    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}

    powerState
    PowerState

    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

    proximityPlacementGroupReference
    genruntime.ResourceReference

    ProximityPlacementGroupReference: The ID for Proximity Placement Group.

    scaleDownMode
    ScaleDownMode

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    AgentPoolType

    Type: The type of Agent Pool.

    upgradeSettings
    AgentPoolUpgradeSettings

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetReference
    genruntime.ResourceReference

    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}

    windowsProfile
    AgentPoolWindowsProfile

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime

    WorkloadRuntime: Determines the type of workload a node can run.

    status
    ManagedClusters_AgentPool_STATUS

    ManagedClusters_AgentPool_STATUS

    (Appears on:ManagedClustersAgentPool)

    Field Description
    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    count
    int

    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.

    creationData
    CreationData_STATUS

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

    currentOrchestratorVersion
    string

    CurrentOrchestratorVersion: If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile_STATUS

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

    hostGroupID
    string

    HostGroupID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

    id
    string

    Id: Resource ID.

    kubeletConfig
    KubeletConfig_STATUS

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType_STATUS

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

    linuxOSConfig
    LinuxOSConfig_STATUS

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode_STATUS

    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

    name
    string

    Name: The name of the resource that is unique within a resource group. This name can be used to access the resource.

    networkProfile
    AgentPoolNetworkProfile_STATUS

    NetworkProfile: Network-related settings of an agent pool.

    nodeImageVersion
    string

    NodeImageVersion: The version of node image

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixID
    string

    NodePublicIPPrefixID: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    int
    osDiskType
    OSDiskType_STATUS

    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.

    osSKU
    OSSKU_STATUS

    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.

    osType
    OSType_STATUS

    OsType: The operating system type. The default is Linux.

    podSubnetID
    string

    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}

    powerState
    PowerState_STATUS

    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

    properties_type
    AgentPoolType_STATUS

    PropertiesType: The type of Agent Pool.

    provisioningState
    string

    ProvisioningState: The current deployment or provisioning state.

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleDownMode
    ScaleDownMode_STATUS

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy_STATUS

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority_STATUS

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    string

    Type: Resource type

    upgradeSettings
    AgentPoolUpgradeSettings_STATUS

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetID
    string

    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}

    windowsProfile
    AgentPoolWindowsProfile_STATUS

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime_STATUS

    WorkloadRuntime: Determines the type of workload a node can run.

    ManagedClusters_AgentPool_STATUS_ARM

    Field Description
    id
    string

    Id: Resource ID.

    name
    string

    Name: The name of the resource that is unique within a resource group. This name can be used to access the resource.

    properties
    ManagedClusterAgentPoolProfileProperties_STATUS_ARM

    Properties: Properties of an agent pool.

    type
    string

    Type: Resource type

    ManagedClusters_AgentPool_Spec

    (Appears on:ManagedClustersAgentPool)

    Field Description
    availabilityZones
    []string

    AvailabilityZones: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is ‘VirtualMachineScaleSets’.

    azureName
    string

    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.

    capacityReservationGroupID
    string

    CapacityReservationGroupID: AKS will associate the specified agent pool with the Capacity Reservation Group.

    count
    int

    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.

    creationData
    CreationData

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

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    enableCustomCATrust
    bool

    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.

    enableEncryptionAtHost
    bool

    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

    enableFIPS
    bool

    EnableFIPS: See Add a FIPS-enabled node pool for more details.

    enableNodePublicIP
    bool

    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.

    enableUltraSSD
    bool

    EnableUltraSSD: Whether to enable UltraSSD

    gpuInstanceProfile
    GPUInstanceProfile

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

    hostGroupReference
    genruntime.ResourceReference

    HostGroupReference: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​hostGroups/​{hostGroupName}. For more information see Azure dedicated hosts.

    kubeletConfig
    KubeletConfig

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType

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

    linuxOSConfig
    LinuxOSConfig

    LinuxOSConfig: The OS configuration of Linux agent nodes.

    maxCount
    int

    MaxCount: The maximum number of nodes for auto-scaling

    maxPods
    int

    MaxPods: The maximum number of pods that can run on a node.

    messageOfTheDay
    string

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

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode

    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

    networkProfile
    AgentPoolNetworkProfile

    NetworkProfile: Network-related settings of an agent pool.

    nodeLabels
    map[string]string

    NodeLabels: The node labels to be persisted across all nodes in agent pool.

    nodePublicIPPrefixReference
    genruntime.ResourceReference

    NodePublicIPPrefixReference: This is of the form: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​publicIPPrefixes/​{publicIPPrefixName}

    nodeTaints
    []string

    NodeTaints: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

    orchestratorVersion
    string

    OrchestratorVersion: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same 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.

    osDiskSizeGB
    ContainerServiceOSDisk
    osDiskType
    OSDiskType

    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.

    osSKU
    OSSKU

    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.

    osType
    OSType

    OsType: The operating system type. The default is Linux.

    owner
    genruntime.KnownResourceReference

    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

    podSubnetReference
    genruntime.ResourceReference

    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}

    powerState
    PowerState

    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

    proximityPlacementGroupReference
    genruntime.ResourceReference

    ProximityPlacementGroupReference: The ID for Proximity Placement Group.

    scaleDownMode
    ScaleDownMode

    ScaleDownMode: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

    scaleSetEvictionPolicy
    ScaleSetEvictionPolicy

    ScaleSetEvictionPolicy: This cannot be specified unless the scaleSetPriority is ‘Spot’. If not specified, the default is ‘Delete’.

    scaleSetPriority
    ScaleSetPriority

    ScaleSetPriority: The Virtual Machine Scale Set priority. If not specified, the default is ‘Regular’.

    spotMaxPrice
    float64

    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

    tags
    map[string]string

    Tags: The tags to be persisted on the agent pool virtual machine scale set.

    type
    AgentPoolType

    Type: The type of Agent Pool.

    upgradeSettings
    AgentPoolUpgradeSettings

    UpgradeSettings: Settings for upgrading the agentpool

    vmSize
    string

    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

    vnetSubnetReference
    genruntime.ResourceReference

    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}

    windowsProfile
    AgentPoolWindowsProfile

    WindowsProfile: The Windows agent pool’s specific profile.

    workloadRuntime
    WorkloadRuntime

    WorkloadRuntime: Determines the type of workload a node can run.

    ManagedClusters_AgentPool_Spec_ARM

    Field Description
    name
    string
    properties
    ManagedClusterAgentPoolProfileProperties_ARM

    Properties: Properties of an agent pool.

    ManagedClusters_TrustedAccessRoleBinding_STATUS

    (Appears on:TrustedAccessRoleBinding)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    name
    string

    Name: The name of the resource

    provisioningState
    TrustedAccessRoleBindingProperties_ProvisioningState_STATUS

    ProvisioningState: The current provisioning state of trusted access role binding.

    roles
    []string

    Roles: A list of roles to bind, each item is a resource type qualified role name. For example: ‘Microsoft.MachineLearningServices/workspaces/reader’.

    sourceResourceId
    string

    SourceResourceId: The ARM resource ID of source resource that trusted access is configured for.

    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    ManagedClusters_TrustedAccessRoleBinding_STATUS_ARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    name
    string

    Name: The name of the resource

    properties
    TrustedAccessRoleBindingProperties_STATUS_ARM

    Properties: Properties for trusted access role binding

    systemData
    SystemData_STATUS_ARM

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    ManagedClusters_TrustedAccessRoleBinding_Spec

    (Appears on:TrustedAccessRoleBinding)

    Field Description
    azureName
    string

    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.

    owner
    genruntime.KnownResourceReference

    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

    roles
    []string

    Roles: A list of roles to bind, each item is a resource type qualified role name. For example: ‘Microsoft.MachineLearningServices/workspaces/reader’.

    sourceResourceReference
    genruntime.ResourceReference

    SourceResourceReference: The ARM resource ID of source resource that trusted access is configured for.

    ManagedClusters_TrustedAccessRoleBinding_Spec_ARM

    Field Description
    name
    string
    properties
    TrustedAccessRoleBindingProperties_ARM

    Properties: Properties for trusted access role binding

    NetworkDataplane (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfile_ARM)

    Network dataplane used in the Kubernetes cluster.

    Value Description

    "azure"

    "cilium"

    NetworkDataplane_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_STATUS, ContainerServiceNetworkProfile_STATUS_ARM)

    Network dataplane used in the Kubernetes cluster.

    Value Description

    "azure"

    "cilium"

    NetworkMode (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfile_ARM)

    This cannot be specified if networkPlugin is anything other than ‘azure’.

    Value Description

    "bridge"

    "transparent"

    NetworkMode_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_STATUS, ContainerServiceNetworkProfile_STATUS_ARM)

    This cannot be specified if networkPlugin is anything other than ‘azure’.

    Value Description

    "bridge"

    "transparent"

    NetworkPlugin (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfile_ARM)

    Network plugin used for building the Kubernetes network.

    Value Description

    "azure"

    "kubenet"

    "none"

    NetworkPluginMode (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfile_ARM)

    The mode the network plugin should use.

    Value Description

    "Overlay"

    NetworkPluginMode_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_STATUS, ContainerServiceNetworkProfile_STATUS_ARM)

    The mode the network plugin should use.

    Value Description

    "Overlay"

    NetworkPlugin_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_STATUS, ContainerServiceNetworkProfile_STATUS_ARM)

    Network plugin used for building the Kubernetes network.

    Value Description

    "azure"

    "kubenet"

    "none"

    NetworkPolicy (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfile_ARM)

    Network policy used for building the Kubernetes network.

    Value Description

    "azure"

    "calico"

    "cilium"

    NetworkPolicy_STATUS (string alias)

    (Appears on:ContainerServiceNetworkProfile_STATUS, ContainerServiceNetworkProfile_STATUS_ARM)

    Network policy used for building the Kubernetes network.

    Value Description

    "azure"

    "calico"

    "cilium"

    OSDiskType (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    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.

    Value Description

    "Ephemeral"

    "Managed"

    OSDiskType_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

    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.

    Value Description

    "Ephemeral"

    "Managed"

    OSSKU (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    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.

    Value Description

    "CBLMariner"

    "Mariner"

    "Ubuntu"

    "Windows2019"

    "Windows2022"

    OSSKU_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

    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.

    Value Description

    "CBLMariner"

    "Mariner"

    "Ubuntu"

    "Windows2019"

    "Windows2022"

    OSType (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    The operating system type. The default is Linux.

    Value Description

    "Linux"

    "Windows"

    OSType_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

    The operating system type. The default is Linux.

    Value Description

    "Linux"

    "Windows"

    PortRange

    (Appears on:AgentPoolNetworkProfile)

    The port range.

    Field Description
    portEnd
    int

    PortEnd: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.

    portStart
    int

    PortStart: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.

    protocol
    PortRange_Protocol

    Protocol: The network protocol of the port.

    PortRange_ARM

    (Appears on:AgentPoolNetworkProfile_ARM)

    The port range.

    Field Description
    portEnd
    int

    PortEnd: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.

    portStart
    int

    PortStart: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.

    protocol
    PortRange_Protocol

    Protocol: The network protocol of the port.

    PortRange_Protocol (string alias)

    (Appears on:PortRange, PortRange_ARM)

    Value Description

    "TCP"

    "UDP"

    PortRange_Protocol_STATUS (string alias)

    (Appears on:PortRange_STATUS, PortRange_STATUS_ARM)

    Value Description

    "TCP"

    "UDP"

    PortRange_STATUS

    (Appears on:AgentPoolNetworkProfile_STATUS)

    The port range.

    Field Description
    portEnd
    int

    PortEnd: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.

    portStart
    int

    PortStart: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.

    protocol
    PortRange_Protocol_STATUS

    Protocol: The network protocol of the port.

    PortRange_STATUS_ARM

    (Appears on:AgentPoolNetworkProfile_STATUS_ARM)

    The port range.

    Field Description
    portEnd
    int

    PortEnd: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.

    portStart
    int

    PortStart: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.

    protocol
    PortRange_Protocol_STATUS

    Protocol: The network protocol of the port.

    PowerState

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusters_AgentPool_Spec)

    Describes the Power State of the cluster

    Field Description
    code
    PowerState_Code

    Code: Tells whether the cluster is Running or Stopped

    PowerState_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM)

    Describes the Power State of the cluster

    Field Description
    code
    PowerState_Code

    Code: Tells whether the cluster is Running or Stopped

    PowerState_Code (string alias)

    (Appears on:PowerState, PowerState_ARM)

    Value Description

    "Running"

    "Stopped"

    PowerState_Code_STATUS (string alias)

    (Appears on:PowerState_STATUS, PowerState_STATUS_ARM)

    Value Description

    "Running"

    "Stopped"

    PowerState_STATUS

    (Appears on:ManagedClusterAgentPoolProfile_STATUS, ManagedCluster_STATUS, ManagedClusters_AgentPool_STATUS)

    Describes the Power State of the cluster

    Field Description
    code
    PowerState_Code_STATUS

    Code: Tells whether the cluster is Running or Stopped

    PowerState_STATUS_ARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusterProperties_STATUS_ARM)

    Describes the Power State of the cluster

    Field Description
    code
    PowerState_Code_STATUS

    Code: Tells whether the cluster is Running or Stopped

    PrivateLinkResource

    (Appears on:ManagedCluster_Spec)

    A private link resource

    Field Description
    groupId
    string

    GroupId: The group ID of the resource.

    name
    string

    Name: The name of the private link resource.

    reference
    genruntime.ResourceReference

    Reference: The ID of the private link resource.

    requiredMembers
    []string

    RequiredMembers: The RequiredMembers of the resource

    type
    string

    Type: The resource type.

    PrivateLinkResource_ARM

    (Appears on:ManagedClusterProperties_ARM)

    A private link resource

    Field Description
    groupId
    string

    GroupId: The group ID of the resource.

    id
    string
    name
    string

    Name: The name of the private link resource.

    requiredMembers
    []string

    RequiredMembers: The RequiredMembers of the resource

    type
    string

    Type: The resource type.

    PrivateLinkResource_STATUS

    (Appears on:ManagedCluster_STATUS)

    A private link resource

    Field Description
    groupId
    string

    GroupId: The group ID of the resource.

    id
    string

    Id: The ID of the private link resource.

    name
    string

    Name: The name of the private link resource.

    privateLinkServiceID
    string

    PrivateLinkServiceID: The private link service ID of the resource, this field is exposed only to NRP internally.

    requiredMembers
    []string

    RequiredMembers: The RequiredMembers of the resource

    type
    string

    Type: The resource type.

    PrivateLinkResource_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    A private link resource

    Field Description
    groupId
    string

    GroupId: The group ID of the resource.

    id
    string

    Id: The ID of the private link resource.

    name
    string

    Name: The name of the private link resource.

    privateLinkServiceID
    string

    PrivateLinkServiceID: The private link service ID of the resource, this field is exposed only to NRP internally.

    requiredMembers
    []string

    RequiredMembers: The RequiredMembers of the resource

    type
    string

    Type: The resource type.

    ResourceReference

    (Appears on:ManagedClusterLoadBalancerProfile, ManagedClusterLoadBalancerProfile_OutboundIPPrefixes, ManagedClusterLoadBalancerProfile_OutboundIPs, ManagedClusterNATGatewayProfile)

    A reference to an Azure resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: The fully qualified Azure resource id.

    ResourceReference_ARM

    (Appears on:ManagedClusterLoadBalancerProfile_ARM, ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_ARM, ManagedClusterLoadBalancerProfile_OutboundIPs_ARM, ManagedClusterNATGatewayProfile_ARM)

    A reference to an Azure resource.

    Field Description
    id
    string

    ResourceReference_STATUS

    (Appears on:ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS, ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS, ManagedClusterLoadBalancerProfile_STATUS, ManagedClusterNATGatewayProfile_STATUS)

    A reference to an Azure resource.

    Field Description
    id
    string

    Id: The fully qualified Azure resource id.

    ResourceReference_STATUS_ARM

    (Appears on:ManagedClusterLoadBalancerProfile_OutboundIPPrefixes_STATUS_ARM, ManagedClusterLoadBalancerProfile_OutboundIPs_STATUS_ARM, ManagedClusterLoadBalancerProfile_STATUS_ARM, ManagedClusterNATGatewayProfile_STATUS_ARM)

    A reference to an Azure resource.

    Field Description
    id
    string

    Id: The fully qualified Azure resource id.

    ScaleDownMode (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

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

    Value Description

    "Deallocate"

    "Delete"

    ScaleDownMode_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

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

    Value Description

    "Deallocate"

    "Delete"

    ScaleSetEvictionPolicy (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see spot VMs

    Value Description

    "Deallocate"

    "Delete"

    ScaleSetEvictionPolicy_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

    The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see spot VMs

    Value Description

    "Deallocate"

    "Delete"

    ScaleSetPriority (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    The Virtual Machine Scale Set priority.

    Value Description

    "Regular"

    "Spot"

    ScaleSetPriority_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

    The Virtual Machine Scale Set priority.

    Value Description

    "Regular"

    "Spot"

    ServiceMeshProfile

    (Appears on:ManagedCluster_Spec)

    Service mesh profile for a managed cluster.

    Field Description
    istio
    IstioServiceMesh

    Istio: Istio service mesh configuration.

    mode
    ServiceMeshProfile_Mode

    Mode: Mode of the service mesh.

    ServiceMeshProfile_ARM

    (Appears on:ManagedClusterProperties_ARM)

    Service mesh profile for a managed cluster.

    Field Description
    istio
    IstioServiceMesh_ARM

    Istio: Istio service mesh configuration.

    mode
    ServiceMeshProfile_Mode

    Mode: Mode of the service mesh.

    ServiceMeshProfile_Mode (string alias)

    (Appears on:ServiceMeshProfile, ServiceMeshProfile_ARM)

    Value Description

    "Disabled"

    "Istio"

    ServiceMeshProfile_Mode_STATUS (string alias)

    (Appears on:ServiceMeshProfile_STATUS, ServiceMeshProfile_STATUS_ARM)

    Value Description

    "Disabled"

    "Istio"

    ServiceMeshProfile_STATUS

    (Appears on:ManagedCluster_STATUS)

    Service mesh profile for a managed cluster.

    Field Description
    istio
    IstioServiceMesh_STATUS

    Istio: Istio service mesh configuration.

    mode
    ServiceMeshProfile_Mode_STATUS

    Mode: Mode of the service mesh.

    ServiceMeshProfile_STATUS_ARM

    (Appears on:ManagedClusterProperties_STATUS_ARM)

    Service mesh profile for a managed cluster.

    Field Description
    istio
    IstioServiceMesh_STATUS_ARM

    Istio: Istio service mesh configuration.

    mode
    ServiceMeshProfile_Mode_STATUS

    Mode: Mode of the service mesh.

    SysctlConfig

    (Appears on:LinuxOSConfig)

    Sysctl settings for Linux agent nodes.

    Field Description
    fsAioMaxNr
    int

    FsAioMaxNr: Sysctl setting fs.aio-max-nr.

    fsFileMax
    int

    FsFileMax: Sysctl setting fs.file-max.

    fsInotifyMaxUserWatches
    int

    FsInotifyMaxUserWatches: Sysctl setting fs.inotify.max_user_watches.

    fsNrOpen
    int

    FsNrOpen: Sysctl setting fs.nr_open.

    kernelThreadsMax
    int

    KernelThreadsMax: Sysctl setting kernel.threads-max.

    netCoreNetdevMaxBacklog
    int

    NetCoreNetdevMaxBacklog: Sysctl setting net.core.netdev_max_backlog.

    netCoreOptmemMax
    int

    NetCoreOptmemMax: Sysctl setting net.core.optmem_max.

    netCoreRmemDefault
    int

    NetCoreRmemDefault: Sysctl setting net.core.rmem_default.

    netCoreRmemMax
    int

    NetCoreRmemMax: Sysctl setting net.core.rmem_max.

    netCoreSomaxconn
    int

    NetCoreSomaxconn: Sysctl setting net.core.somaxconn.

    netCoreWmemDefault
    int

    NetCoreWmemDefault: Sysctl setting net.core.wmem_default.

    netCoreWmemMax
    int

    NetCoreWmemMax: Sysctl setting net.core.wmem_max.

    netIpv4IpLocalPortRange
    string

    NetIpv4IpLocalPortRange: Sysctl setting net.ipv4.ip_local_port_range.

    netIpv4NeighDefaultGcThresh1
    int

    NetIpv4NeighDefaultGcThresh1: Sysctl setting net.ipv4.neigh.default.gc_thresh1.

    netIpv4NeighDefaultGcThresh2
    int

    NetIpv4NeighDefaultGcThresh2: Sysctl setting net.ipv4.neigh.default.gc_thresh2.

    netIpv4NeighDefaultGcThresh3
    int

    NetIpv4NeighDefaultGcThresh3: Sysctl setting net.ipv4.neigh.default.gc_thresh3.

    netIpv4TcpFinTimeout
    int

    NetIpv4TcpFinTimeout: Sysctl setting net.ipv4.tcp_fin_timeout.

    netIpv4TcpKeepaliveProbes
    int

    NetIpv4TcpKeepaliveProbes: Sysctl setting net.ipv4.tcp_keepalive_probes.

    netIpv4TcpKeepaliveTime
    int

    NetIpv4TcpKeepaliveTime: Sysctl setting net.ipv4.tcp_keepalive_time.

    netIpv4TcpMaxSynBacklog
    int

    NetIpv4TcpMaxSynBacklog: Sysctl setting net.ipv4.tcp_max_syn_backlog.

    netIpv4TcpMaxTwBuckets
    int

    NetIpv4TcpMaxTwBuckets: Sysctl setting net.ipv4.tcp_max_tw_buckets.

    netIpv4TcpTwReuse
    bool

    NetIpv4TcpTwReuse: Sysctl setting net.ipv4.tcp_tw_reuse.

    netIpv4TcpkeepaliveIntvl
    int

    NetIpv4TcpkeepaliveIntvl: Sysctl setting net.ipv4.tcp_keepalive_intvl.

    netNetfilterNfConntrackBuckets
    int

    NetNetfilterNfConntrackBuckets: Sysctl setting net.netfilter.nf_conntrack_buckets.

    netNetfilterNfConntrackMax
    int

    NetNetfilterNfConntrackMax: Sysctl setting net.netfilter.nf_conntrack_max.

    vmMaxMapCount
    int

    VmMaxMapCount: Sysctl setting vm.max_map_count.

    vmSwappiness
    int

    VmSwappiness: Sysctl setting vm.swappiness.

    vmVfsCachePressure
    int

    VmVfsCachePressure: Sysctl setting vm.vfs_cache_pressure.

    SysctlConfig_ARM

    (Appears on:LinuxOSConfig_ARM)

    Sysctl settings for Linux agent nodes.

    Field Description
    fsAioMaxNr
    int

    FsAioMaxNr: Sysctl setting fs.aio-max-nr.

    fsFileMax
    int

    FsFileMax: Sysctl setting fs.file-max.

    fsInotifyMaxUserWatches
    int

    FsInotifyMaxUserWatches: Sysctl setting fs.inotify.max_user_watches.

    fsNrOpen
    int

    FsNrOpen: Sysctl setting fs.nr_open.

    kernelThreadsMax
    int

    KernelThreadsMax: Sysctl setting kernel.threads-max.

    netCoreNetdevMaxBacklog
    int

    NetCoreNetdevMaxBacklog: Sysctl setting net.core.netdev_max_backlog.

    netCoreOptmemMax
    int

    NetCoreOptmemMax: Sysctl setting net.core.optmem_max.

    netCoreRmemDefault
    int

    NetCoreRmemDefault: Sysctl setting net.core.rmem_default.

    netCoreRmemMax
    int

    NetCoreRmemMax: Sysctl setting net.core.rmem_max.

    netCoreSomaxconn
    int

    NetCoreSomaxconn: Sysctl setting net.core.somaxconn.

    netCoreWmemDefault
    int

    NetCoreWmemDefault: Sysctl setting net.core.wmem_default.

    netCoreWmemMax
    int

    NetCoreWmemMax: Sysctl setting net.core.wmem_max.

    netIpv4IpLocalPortRange
    string

    NetIpv4IpLocalPortRange: Sysctl setting net.ipv4.ip_local_port_range.

    netIpv4NeighDefaultGcThresh1
    int

    NetIpv4NeighDefaultGcThresh1: Sysctl setting net.ipv4.neigh.default.gc_thresh1.

    netIpv4NeighDefaultGcThresh2
    int

    NetIpv4NeighDefaultGcThresh2: Sysctl setting net.ipv4.neigh.default.gc_thresh2.

    netIpv4NeighDefaultGcThresh3
    int

    NetIpv4NeighDefaultGcThresh3: Sysctl setting net.ipv4.neigh.default.gc_thresh3.

    netIpv4TcpFinTimeout
    int

    NetIpv4TcpFinTimeout: Sysctl setting net.ipv4.tcp_fin_timeout.

    netIpv4TcpKeepaliveProbes
    int

    NetIpv4TcpKeepaliveProbes: Sysctl setting net.ipv4.tcp_keepalive_probes.

    netIpv4TcpKeepaliveTime
    int

    NetIpv4TcpKeepaliveTime: Sysctl setting net.ipv4.tcp_keepalive_time.

    netIpv4TcpMaxSynBacklog
    int

    NetIpv4TcpMaxSynBacklog: Sysctl setting net.ipv4.tcp_max_syn_backlog.

    netIpv4TcpMaxTwBuckets
    int

    NetIpv4TcpMaxTwBuckets: Sysctl setting net.ipv4.tcp_max_tw_buckets.

    netIpv4TcpTwReuse
    bool

    NetIpv4TcpTwReuse: Sysctl setting net.ipv4.tcp_tw_reuse.

    netIpv4TcpkeepaliveIntvl
    int

    NetIpv4TcpkeepaliveIntvl: Sysctl setting net.ipv4.tcp_keepalive_intvl.

    netNetfilterNfConntrackBuckets
    int

    NetNetfilterNfConntrackBuckets: Sysctl setting net.netfilter.nf_conntrack_buckets.

    netNetfilterNfConntrackMax
    int

    NetNetfilterNfConntrackMax: Sysctl setting net.netfilter.nf_conntrack_max.

    vmMaxMapCount
    int

    VmMaxMapCount: Sysctl setting vm.max_map_count.

    vmSwappiness
    int

    VmSwappiness: Sysctl setting vm.swappiness.

    vmVfsCachePressure
    int

    VmVfsCachePressure: Sysctl setting vm.vfs_cache_pressure.

    SysctlConfig_STATUS

    (Appears on:LinuxOSConfig_STATUS)

    Sysctl settings for Linux agent nodes.

    Field Description
    fsAioMaxNr
    int

    FsAioMaxNr: Sysctl setting fs.aio-max-nr.

    fsFileMax
    int

    FsFileMax: Sysctl setting fs.file-max.

    fsInotifyMaxUserWatches
    int

    FsInotifyMaxUserWatches: Sysctl setting fs.inotify.max_user_watches.

    fsNrOpen
    int

    FsNrOpen: Sysctl setting fs.nr_open.

    kernelThreadsMax
    int

    KernelThreadsMax: Sysctl setting kernel.threads-max.

    netCoreNetdevMaxBacklog
    int

    NetCoreNetdevMaxBacklog: Sysctl setting net.core.netdev_max_backlog.

    netCoreOptmemMax
    int

    NetCoreOptmemMax: Sysctl setting net.core.optmem_max.

    netCoreRmemDefault
    int

    NetCoreRmemDefault: Sysctl setting net.core.rmem_default.

    netCoreRmemMax
    int

    NetCoreRmemMax: Sysctl setting net.core.rmem_max.

    netCoreSomaxconn
    int

    NetCoreSomaxconn: Sysctl setting net.core.somaxconn.

    netCoreWmemDefault
    int

    NetCoreWmemDefault: Sysctl setting net.core.wmem_default.

    netCoreWmemMax
    int

    NetCoreWmemMax: Sysctl setting net.core.wmem_max.

    netIpv4IpLocalPortRange
    string

    NetIpv4IpLocalPortRange: Sysctl setting net.ipv4.ip_local_port_range.

    netIpv4NeighDefaultGcThresh1
    int

    NetIpv4NeighDefaultGcThresh1: Sysctl setting net.ipv4.neigh.default.gc_thresh1.

    netIpv4NeighDefaultGcThresh2
    int

    NetIpv4NeighDefaultGcThresh2: Sysctl setting net.ipv4.neigh.default.gc_thresh2.

    netIpv4NeighDefaultGcThresh3
    int

    NetIpv4NeighDefaultGcThresh3: Sysctl setting net.ipv4.neigh.default.gc_thresh3.

    netIpv4TcpFinTimeout
    int

    NetIpv4TcpFinTimeout: Sysctl setting net.ipv4.tcp_fin_timeout.

    netIpv4TcpKeepaliveProbes
    int

    NetIpv4TcpKeepaliveProbes: Sysctl setting net.ipv4.tcp_keepalive_probes.

    netIpv4TcpKeepaliveTime
    int

    NetIpv4TcpKeepaliveTime: Sysctl setting net.ipv4.tcp_keepalive_time.

    netIpv4TcpMaxSynBacklog
    int

    NetIpv4TcpMaxSynBacklog: Sysctl setting net.ipv4.tcp_max_syn_backlog.

    netIpv4TcpMaxTwBuckets
    int

    NetIpv4TcpMaxTwBuckets: Sysctl setting net.ipv4.tcp_max_tw_buckets.

    netIpv4TcpTwReuse
    bool

    NetIpv4TcpTwReuse: Sysctl setting net.ipv4.tcp_tw_reuse.

    netIpv4TcpkeepaliveIntvl
    int

    NetIpv4TcpkeepaliveIntvl: Sysctl setting net.ipv4.tcp_keepalive_intvl.

    netNetfilterNfConntrackBuckets
    int

    NetNetfilterNfConntrackBuckets: Sysctl setting net.netfilter.nf_conntrack_buckets.

    netNetfilterNfConntrackMax
    int

    NetNetfilterNfConntrackMax: Sysctl setting net.netfilter.nf_conntrack_max.

    vmMaxMapCount
    int

    VmMaxMapCount: Sysctl setting vm.max_map_count.

    vmSwappiness
    int

    VmSwappiness: Sysctl setting vm.swappiness.

    vmVfsCachePressure
    int

    VmVfsCachePressure: Sysctl setting vm.vfs_cache_pressure.

    SysctlConfig_STATUS_ARM

    (Appears on:LinuxOSConfig_STATUS_ARM)

    Sysctl settings for Linux agent nodes.

    Field Description
    fsAioMaxNr
    int

    FsAioMaxNr: Sysctl setting fs.aio-max-nr.

    fsFileMax
    int

    FsFileMax: Sysctl setting fs.file-max.

    fsInotifyMaxUserWatches
    int

    FsInotifyMaxUserWatches: Sysctl setting fs.inotify.max_user_watches.

    fsNrOpen
    int

    FsNrOpen: Sysctl setting fs.nr_open.

    kernelThreadsMax
    int

    KernelThreadsMax: Sysctl setting kernel.threads-max.

    netCoreNetdevMaxBacklog
    int

    NetCoreNetdevMaxBacklog: Sysctl setting net.core.netdev_max_backlog.

    netCoreOptmemMax
    int

    NetCoreOptmemMax: Sysctl setting net.core.optmem_max.

    netCoreRmemDefault
    int

    NetCoreRmemDefault: Sysctl setting net.core.rmem_default.

    netCoreRmemMax
    int

    NetCoreRmemMax: Sysctl setting net.core.rmem_max.

    netCoreSomaxconn
    int

    NetCoreSomaxconn: Sysctl setting net.core.somaxconn.

    netCoreWmemDefault
    int

    NetCoreWmemDefault: Sysctl setting net.core.wmem_default.

    netCoreWmemMax
    int

    NetCoreWmemMax: Sysctl setting net.core.wmem_max.

    netIpv4IpLocalPortRange
    string

    NetIpv4IpLocalPortRange: Sysctl setting net.ipv4.ip_local_port_range.

    netIpv4NeighDefaultGcThresh1
    int

    NetIpv4NeighDefaultGcThresh1: Sysctl setting net.ipv4.neigh.default.gc_thresh1.

    netIpv4NeighDefaultGcThresh2
    int

    NetIpv4NeighDefaultGcThresh2: Sysctl setting net.ipv4.neigh.default.gc_thresh2.

    netIpv4NeighDefaultGcThresh3
    int

    NetIpv4NeighDefaultGcThresh3: Sysctl setting net.ipv4.neigh.default.gc_thresh3.

    netIpv4TcpFinTimeout
    int

    NetIpv4TcpFinTimeout: Sysctl setting net.ipv4.tcp_fin_timeout.

    netIpv4TcpKeepaliveProbes
    int

    NetIpv4TcpKeepaliveProbes: Sysctl setting net.ipv4.tcp_keepalive_probes.

    netIpv4TcpKeepaliveTime
    int

    NetIpv4TcpKeepaliveTime: Sysctl setting net.ipv4.tcp_keepalive_time.

    netIpv4TcpMaxSynBacklog
    int

    NetIpv4TcpMaxSynBacklog: Sysctl setting net.ipv4.tcp_max_syn_backlog.

    netIpv4TcpMaxTwBuckets
    int

    NetIpv4TcpMaxTwBuckets: Sysctl setting net.ipv4.tcp_max_tw_buckets.

    netIpv4TcpTwReuse
    bool

    NetIpv4TcpTwReuse: Sysctl setting net.ipv4.tcp_tw_reuse.

    netIpv4TcpkeepaliveIntvl
    int

    NetIpv4TcpkeepaliveIntvl: Sysctl setting net.ipv4.tcp_keepalive_intvl.

    netNetfilterNfConntrackBuckets
    int

    NetNetfilterNfConntrackBuckets: Sysctl setting net.netfilter.nf_conntrack_buckets.

    netNetfilterNfConntrackMax
    int

    NetNetfilterNfConntrackMax: Sysctl setting net.netfilter.nf_conntrack_max.

    vmMaxMapCount
    int

    VmMaxMapCount: Sysctl setting vm.max_map_count.

    vmSwappiness
    int

    VmSwappiness: Sysctl setting vm.swappiness.

    vmVfsCachePressure
    int

    VmVfsCachePressure: Sysctl setting vm.vfs_cache_pressure.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:ManagedCluster_STATUS, ManagedClusters_TrustedAccessRoleBinding_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_STATUS_ARM

    (Appears on:ManagedCluster_STATUS_ARM, ManagedClusters_TrustedAccessRoleBinding_STATUS_ARM)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    TrustedAccessRoleBinding

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ManagedClusters_TrustedAccessRoleBinding_Spec


    azureName
    string

    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.

    owner
    genruntime.KnownResourceReference

    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

    roles
    []string

    Roles: A list of roles to bind, each item is a resource type qualified role name. For example: ‘Microsoft.MachineLearningServices/workspaces/reader’.

    sourceResourceReference
    genruntime.ResourceReference

    SourceResourceReference: The ARM resource ID of source resource that trusted access is configured for.

    status
    ManagedClusters_TrustedAccessRoleBinding_STATUS

    TrustedAccessRoleBindingProperties_ARM

    (Appears on:ManagedClusters_TrustedAccessRoleBinding_Spec_ARM)

    Properties for trusted access role binding

    Field Description
    roles
    []string

    Roles: A list of roles to bind, each item is a resource type qualified role name. For example: ‘Microsoft.MachineLearningServices/workspaces/reader’.

    sourceResourceId
    string

    TrustedAccessRoleBindingProperties_ProvisioningState_STATUS (string alias)

    (Appears on:ManagedClusters_TrustedAccessRoleBinding_STATUS, TrustedAccessRoleBindingProperties_STATUS_ARM)

    Value Description

    "Canceled"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    TrustedAccessRoleBindingProperties_STATUS_ARM

    (Appears on:ManagedClusters_TrustedAccessRoleBinding_STATUS_ARM)

    Properties for trusted access role binding

    Field Description
    provisioningState
    TrustedAccessRoleBindingProperties_ProvisioningState_STATUS

    ProvisioningState: The current provisioning state of trusted access role binding.

    roles
    []string

    Roles: A list of roles to bind, each item is a resource type qualified role name. For example: ‘Microsoft.MachineLearningServices/workspaces/reader’.

    sourceResourceId
    string

    SourceResourceId: The ARM resource ID of source resource that trusted access is configured for.

    UpgradeOverrideSettings

    (Appears on:ClusterUpgradeSettings)

    Settings for overrides when upgrading a cluster.

    Field Description
    controlPlaneOverrides
    []ControlPlaneUpgradeOverride

    ControlPlaneOverrides: List of upgrade overrides when upgrading a cluster’s control plane.

    until
    string

    Until: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won’t change once an upgrade starts even if the until expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect.

    UpgradeOverrideSettings_ARM

    (Appears on:ClusterUpgradeSettings_ARM)

    Settings for overrides when upgrading a cluster.

    Field Description
    controlPlaneOverrides
    []ControlPlaneUpgradeOverride

    ControlPlaneOverrides: List of upgrade overrides when upgrading a cluster’s control plane.

    until
    string

    Until: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won’t change once an upgrade starts even if the until expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect.

    UpgradeOverrideSettings_STATUS

    (Appears on:ClusterUpgradeSettings_STATUS)

    Settings for overrides when upgrading a cluster.

    Field Description
    controlPlaneOverrides
    []ControlPlaneUpgradeOverride_STATUS

    ControlPlaneOverrides: List of upgrade overrides when upgrading a cluster’s control plane.

    until
    string

    Until: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won’t change once an upgrade starts even if the until expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect.

    UpgradeOverrideSettings_STATUS_ARM

    (Appears on:ClusterUpgradeSettings_STATUS_ARM)

    Settings for overrides when upgrading a cluster.

    Field Description
    controlPlaneOverrides
    []ControlPlaneUpgradeOverride_STATUS

    ControlPlaneOverrides: List of upgrade overrides when upgrading a cluster’s control plane.

    until
    string

    Until: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won’t change once an upgrade starts even if the until expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect.

    UserAssignedIdentity

    (Appears on:ManagedClusterPodIdentity, ManagedCluster_Spec)

    Details about a user assigned identity.

    Field Description
    clientId
    string

    ClientId: The client ID of the user assigned identity.

    objectId
    string

    ObjectId: The object ID of the user assigned identity.

    resourceReference
    genruntime.ResourceReference

    ResourceReference: The resource ID of the user assigned identity.

    UserAssignedIdentityDetails

    (Appears on:ManagedClusterIdentity)

    Information about the user assigned identity for the resource

    Field Description
    reference
    genruntime.ResourceReference

    UserAssignedIdentityDetails_ARM

    (Appears on:ManagedClusterIdentity_ARM)

    Information about the user assigned identity for the resource

    UserAssignedIdentity_ARM

    (Appears on:ManagedClusterPodIdentity_ARM, ManagedClusterProperties_ARM)

    Details about a user assigned identity.

    Field Description
    clientId
    string

    ClientId: The client ID of the user assigned identity.

    objectId
    string

    ObjectId: The object ID of the user assigned identity.

    resourceId
    string

    UserAssignedIdentity_STATUS

    (Appears on:ManagedClusterAddonProfile_STATUS, ManagedClusterIngressProfileWebAppRouting_STATUS, ManagedClusterPodIdentity_STATUS, ManagedCluster_STATUS)

    Details about a user assigned identity.

    Field Description
    clientId
    string

    ClientId: The client ID of the user assigned identity.

    objectId
    string

    ObjectId: The object ID of the user assigned identity.

    resourceId
    string

    ResourceId: The resource ID of the user assigned identity.

    UserAssignedIdentity_STATUS_ARM

    (Appears on:ManagedClusterAddonProfile_STATUS_ARM, ManagedClusterIngressProfileWebAppRouting_STATUS_ARM, ManagedClusterPodIdentity_STATUS_ARM, ManagedClusterProperties_STATUS_ARM)

    Details about a user assigned identity.

    Field Description
    clientId
    string

    ClientId: The client ID of the user assigned identity.

    objectId
    string

    ObjectId: The object ID of the user assigned identity.

    resourceId
    string

    ResourceId: The resource ID of the user assigned identity.

    WindowsGmsaProfile

    (Appears on:ManagedClusterWindowsProfile)

    Windows gMSA Profile in the managed cluster.

    Field Description
    dnsServer
    string

    DnsServer: Specifies the DNS server for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

    enabled
    bool

    Enabled: Specifies whether to enable Windows gMSA in the managed cluster.

    rootDomainName
    string

    RootDomainName: Specifies the root domain name for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

    WindowsGmsaProfile_ARM

    (Appears on:ManagedClusterWindowsProfile_ARM)

    Windows gMSA Profile in the managed cluster.

    Field Description
    dnsServer
    string

    DnsServer: Specifies the DNS server for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

    enabled
    bool

    Enabled: Specifies whether to enable Windows gMSA in the managed cluster.

    rootDomainName
    string

    RootDomainName: Specifies the root domain name for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

    WindowsGmsaProfile_STATUS

    (Appears on:ManagedClusterWindowsProfile_STATUS)

    Windows gMSA Profile in the managed cluster.

    Field Description
    dnsServer
    string

    DnsServer: Specifies the DNS server for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

    enabled
    bool

    Enabled: Specifies whether to enable Windows gMSA in the managed cluster.

    rootDomainName
    string

    RootDomainName: Specifies the root domain name for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

    WindowsGmsaProfile_STATUS_ARM

    (Appears on:ManagedClusterWindowsProfile_STATUS_ARM)

    Windows gMSA Profile in the managed cluster.

    Field Description
    dnsServer
    string

    DnsServer: Specifies the DNS server for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

    enabled
    bool

    Enabled: Specifies whether to enable Windows gMSA in the managed cluster.

    rootDomainName
    string

    RootDomainName: Specifies the root domain name for Windows gMSA. Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster.

    WorkloadRuntime (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileProperties_ARM, ManagedClusterAgentPoolProfile_ARM, ManagedClusters_AgentPool_Spec)

    Determines the type of workload a node can run.

    Value Description

    "KataMshvVmIsolation"

    "OCIContainer"

    "WasmWasi"

    WorkloadRuntime_STATUS (string alias)

    (Appears on:ManagedClusterAgentPoolProfileProperties_STATUS_ARM, ManagedClusterAgentPoolProfile_STATUS, ManagedClusterAgentPoolProfile_STATUS_ARM, ManagedClusters_AgentPool_STATUS)

    Determines the type of workload a node can run.

    Value Description

    "KataMshvVmIsolation"

    "OCIContainer"

    "WasmWasi"