containerservice.azure.com/v1beta20210501

containerservice.azure.com/v1beta20210501

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

Resource Types:

    AgentPoolMode_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "System"

    "User"

    AgentPoolType_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "AvailabilitySet"

    "VirtualMachineScaleSets"

    AgentPoolUpgradeSettings

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPools_Spec)

    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

    AgentPoolUpgradeSettingsARM

    (Appears on:ManagedClusterAgentPoolProfileARM, ManagedClusterAgentPoolProfilePropertiesARM)

    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:AgentPool_Status, ManagedClusterAgentPoolProfile_Status)

    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_StatusARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_StatusARM)

    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

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

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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.

    id
    string

    Id: Resource ID.

    kubeletConfig
    KubeletConfig_Status

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType_Status
    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode_Status
    name
    string

    Name: The name of the resource that is unique within a resource group. This name can be used to access the resource.

    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: 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
    osSKU
    OSSKU_Status
    osType
    OSType_Status
    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: Describes whether the Agent Pool is Running or Stopped

    properties_type
    AgentPoolType_Status
    provisioningState
    string

    ProvisioningState: The current deployment or provisioning state.

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    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}

    AgentPool_StatusARM

    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_StatusARM

    Properties: Properties of an agent pool.

    type
    string

    Type: Resource type

    Componentsqit0Etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties

    (Appears on:ManagedClusters_Spec)

    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.

    Componentsqit0EtschemasmanagedclusterpropertiespropertiesidentityprofileadditionalpropertiesARM

    (Appears on:ManagedClusterPropertiesARM)

    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

    ContainerServiceLinuxProfile

    (Appears on:ManagedClusters_Spec)

    Field Description
    adminUsername
    string

    AdminUsername: The administrator username to use for Linux VMs.

    ssh
    ContainerServiceSshConfiguration

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

    ContainerServiceLinuxProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    Field Description
    adminUsername
    string

    AdminUsername: The administrator username to use for Linux VMs.

    ssh
    ContainerServiceSshConfigurationARM

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

    ContainerServiceLinuxProfile_Status

    (Appears on:ManagedCluster_Status)

    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_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    Field Description
    adminUsername
    string

    AdminUsername: The administrator username to use for Linux VMs.

    ssh
    ContainerServiceSshConfiguration_StatusARM

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

    ContainerServiceNetworkProfile

    (Appears on:ManagedClusters_Spec)

    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.

    loadBalancerProfile
    ManagedClusterLoadBalancerProfile

    LoadBalancerProfile: Profile of the managed cluster load balancer.

    loadBalancerSku
    ContainerServiceNetworkProfileLoadBalancerSku

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

    networkMode
    ContainerServiceNetworkProfileNetworkMode

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

    networkPlugin
    ContainerServiceNetworkProfileNetworkPlugin

    NetworkPlugin: Network plugin used for building the Kubernetes network.

    networkPolicy
    ContainerServiceNetworkProfileNetworkPolicy

    NetworkPolicy: Network policy used for building the Kubernetes network.

    outboundType
    ContainerServiceNetworkProfileOutboundType

    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.

    serviceCidr
    string

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

    ContainerServiceNetworkProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    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.

    loadBalancerProfile
    ManagedClusterLoadBalancerProfileARM

    LoadBalancerProfile: Profile of the managed cluster load balancer.

    loadBalancerSku
    ContainerServiceNetworkProfileLoadBalancerSku

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

    networkMode
    ContainerServiceNetworkProfileNetworkMode

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

    networkPlugin
    ContainerServiceNetworkProfileNetworkPlugin

    NetworkPlugin: Network plugin used for building the Kubernetes network.

    networkPolicy
    ContainerServiceNetworkProfileNetworkPolicy

    NetworkPolicy: Network policy used for building the Kubernetes network.

    outboundType
    ContainerServiceNetworkProfileOutboundType

    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.

    serviceCidr
    string

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

    ContainerServiceNetworkProfileLoadBalancerSku (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfileARM)

    Value Description

    "basic"

    "standard"

    ContainerServiceNetworkProfileNetworkMode (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfileARM)

    Value Description

    "bridge"

    "transparent"

    ContainerServiceNetworkProfileNetworkPlugin (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfileARM)

    Value Description

    "azure"

    "kubenet"

    ContainerServiceNetworkProfileNetworkPolicy (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfileARM)

    Value Description

    "azure"

    "calico"

    ContainerServiceNetworkProfileOutboundType (string alias)

    (Appears on:ContainerServiceNetworkProfile, ContainerServiceNetworkProfileARM)

    Value Description

    "loadBalancer"

    "userDefinedRouting"

    ContainerServiceNetworkProfileStatusLoadBalancerSku (string alias)

    (Appears on:ContainerServiceNetworkProfile_Status, ContainerServiceNetworkProfile_StatusARM)

    Value Description

    "basic"

    "standard"

    ContainerServiceNetworkProfileStatusNetworkMode (string alias)

    (Appears on:ContainerServiceNetworkProfile_Status, ContainerServiceNetworkProfile_StatusARM)

    Value Description

    "bridge"

    "transparent"

    ContainerServiceNetworkProfileStatusNetworkPlugin (string alias)

    (Appears on:ContainerServiceNetworkProfile_Status, ContainerServiceNetworkProfile_StatusARM)

    Value Description

    "azure"

    "kubenet"

    ContainerServiceNetworkProfileStatusNetworkPolicy (string alias)

    (Appears on:ContainerServiceNetworkProfile_Status, ContainerServiceNetworkProfile_StatusARM)

    Value Description

    "azure"

    "calico"

    ContainerServiceNetworkProfileStatusOutboundType (string alias)

    (Appears on:ContainerServiceNetworkProfile_Status, ContainerServiceNetworkProfile_StatusARM)

    Value Description

    "loadBalancer"

    "userDefinedRouting"

    ContainerServiceNetworkProfile_Status

    (Appears on:ManagedCluster_Status)

    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.

    loadBalancerProfile
    ManagedClusterLoadBalancerProfile_Status

    LoadBalancerProfile: Profile of the cluster load balancer.

    loadBalancerSku
    ContainerServiceNetworkProfileStatusLoadBalancerSku

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

    networkMode
    ContainerServiceNetworkProfileStatusNetworkMode

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

    networkPlugin
    ContainerServiceNetworkProfileStatusNetworkPlugin

    NetworkPlugin: Network plugin used for building the Kubernetes network.

    networkPolicy
    ContainerServiceNetworkProfileStatusNetworkPolicy

    NetworkPolicy: Network policy used for building the Kubernetes network.

    outboundType
    ContainerServiceNetworkProfileStatusOutboundType

    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.

    serviceCidr
    string

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

    ContainerServiceNetworkProfile_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    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.

    loadBalancerProfile
    ManagedClusterLoadBalancerProfile_StatusARM

    LoadBalancerProfile: Profile of the cluster load balancer.

    loadBalancerSku
    ContainerServiceNetworkProfileStatusLoadBalancerSku

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

    networkMode
    ContainerServiceNetworkProfileStatusNetworkMode

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

    networkPlugin
    ContainerServiceNetworkProfileStatusNetworkPlugin

    NetworkPlugin: Network plugin used for building the Kubernetes network.

    networkPolicy
    ContainerServiceNetworkProfileStatusNetworkPolicy

    NetworkPolicy: Network policy used for building the Kubernetes network.

    outboundType
    ContainerServiceNetworkProfileStatusOutboundType

    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.

    serviceCidr
    string

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

    ContainerServiceSshConfiguration

    (Appears on:ContainerServiceLinuxProfile)

    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.

    ContainerServiceSshConfigurationARM

    (Appears on:ContainerServiceLinuxProfileARM)

    Field Description
    publicKeys
    []ContainerServiceSshPublicKeyARM

    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)

    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_StatusARM

    (Appears on:ContainerServiceLinuxProfile_StatusARM)

    Field Description
    publicKeys
    []ContainerServiceSshPublicKey_StatusARM

    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)

    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.

    ContainerServiceSshPublicKeyARM

    (Appears on:ContainerServiceSshConfigurationARM)

    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)

    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_StatusARM

    (Appears on:ContainerServiceSshConfiguration_StatusARM)

    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.

    ExtendedLocation

    (Appears on:ManagedClusters_Spec)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocationARM

    (Appears on:ManagedClusters_SpecARM)

    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, ExtendedLocationARM)

    Value Description

    "EdgeZone"

    ExtendedLocationType_Status (string alias)

    (Appears on:ExtendedLocation_Status, ExtendedLocation_StatusARM)

    Value Description

    "EdgeZone"

    ExtendedLocation_Status

    (Appears on:ManagedCluster_Status)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_Status

    Type: The type of the extended location.

    ExtendedLocation_StatusARM

    (Appears on:ManagedCluster_StatusARM)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_Status

    Type: The type of the extended location.

    GPUInstanceProfile_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "MIG1g"

    "MIG2g"

    "MIG3g"

    "MIG4g"

    "MIG7g"

    KubeletConfig

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPools_Spec)

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

    KubeletConfigARM

    (Appears on:ManagedClusterAgentPoolProfileARM, ManagedClusterAgentPoolProfilePropertiesARM)

    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:AgentPool_Status, ManagedClusterAgentPoolProfile_Status)

    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_StatusARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_StatusARM)

    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_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "OS"

    "Temporary"

    LinuxOSConfig

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClustersAgentPools_Spec)

    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.

    LinuxOSConfigARM

    (Appears on:ManagedClusterAgentPoolProfileARM, ManagedClusterAgentPoolProfilePropertiesARM)

    Field Description
    swapFileSizeMB
    int

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

    sysctls
    SysctlConfigARM

    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:AgentPool_Status, ManagedClusterAgentPoolProfile_Status)

    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_StatusARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_StatusARM)

    Field Description
    swapFileSizeMB
    int

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

    sysctls
    SysctlConfig_StatusARM

    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.

    ManagedCluster

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


    aadProfile
    ManagedClusterAADProfile

    AadProfile: For more details see managed AAD on AKS.

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

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfile

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfile

    ApiServerAccessProfile: Access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterPropertiesAutoScalerProfile

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

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile

    AutoUpgradeProfile: Auto upgrade profile for a managed 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.

    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.

    diskEncryptionSetIDReference
    genruntime.ResourceReference

    DiskEncryptionSetIDReference: 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.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.

    enableRBAC
    bool

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

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    fqdnSubdomain
    string

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

    httpProxyConfig
    ManagedClusterHTTPProxyConfig

    HttpProxyConfig: Cluster HTTP proxy configuration.

    identity
    ManagedClusterIdentity

    Identity: Identity for the managed cluster.

    identityProfile
    map[string]./api/containerservice/v1beta20210501.Componentsqit0Etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties

    IdentityProfile: Identities associated with the 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: Profile for Linux VMs in the container service cluster.

    location
    string

    Location: Location to deploy resource to

    networkProfile
    ContainerServiceNetworkProfile

    NetworkProfile: Profile of network configuration.

    nodeResourceGroup
    string

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

    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 pod identity integration.

    privateLinkResources
    []PrivateLinkResource

    PrivateLinkResources: Private link resources associated with the cluster.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfile

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

    sku
    ManagedClusterSKU

    Sku: The SKU of a Managed Cluster.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    windowsProfile
    ManagedClusterWindowsProfile

    WindowsProfile: Profile for Windows VMs in the managed cluster.

    status
    ManagedCluster_Status

    ManagedClusterAADProfile

    (Appears on:ManagedClusters_Spec)

    Field Description
    adminGroupObjectIDs
    []string

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

    clientAppID
    string

    ClientAppID: The client AAD application ID.

    enableAzureRBAC
    bool

    EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

    managed
    bool

    Managed: Whether to enable managed AAD.

    serverAppID
    string

    ServerAppID: The server AAD application ID.

    serverAppSecret
    string

    ServerAppSecret: The server AAD application secret.

    tenantID
    string

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

    ManagedClusterAADProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    Field Description
    adminGroupObjectIDs
    []string

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

    clientAppID
    string

    ClientAppID: The client AAD application ID.

    enableAzureRBAC
    bool

    EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

    managed
    bool

    Managed: Whether to enable managed AAD.

    serverAppID
    string

    ServerAppID: The server AAD application ID.

    serverAppSecret
    string

    ServerAppSecret: The server AAD application secret.

    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)

    Field Description
    adminGroupObjectIDs
    []string

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

    clientAppID
    string

    ClientAppID: The client AAD application ID.

    enableAzureRBAC
    bool

    EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

    managed
    bool

    Managed: Whether to enable managed AAD.

    serverAppID
    string

    ServerAppID: The server AAD application ID.

    serverAppSecret
    string

    ServerAppSecret: The server AAD application secret.

    tenantID
    string

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

    ManagedClusterAADProfile_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    Field Description
    adminGroupObjectIDs
    []string

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

    clientAppID
    string

    ClientAppID: The client AAD application ID.

    enableAzureRBAC
    bool

    EnableAzureRBAC: Whether to enable Azure RBAC for Kubernetes authorization.

    managed
    bool

    Managed: Whether to enable managed AAD.

    serverAppID
    string

    ServerAppID: The server AAD application ID.

    serverAppSecret
    string

    ServerAppSecret: The server AAD application secret.

    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:ManagedClusters_Spec)

    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.

    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.

    privateDNSZone
    string

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

    ManagedClusterAPIServerAccessProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    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.

    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.

    privateDNSZone
    string

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

    ManagedClusterAPIServerAccessProfile_Status

    (Appears on:ManagedCluster_Status)

    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.

    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.

    privateDNSZone
    string

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

    ManagedClusterAPIServerAccessProfile_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    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.

    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.

    privateDNSZone
    string

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

    ManagedClusterAddonProfile

    (Appears on:ManagedClusters_Spec)

    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.

    ManagedClusterAddonProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    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.

    ManagedClusterAgentPoolProfile

    (Appears on:ManagedClusters_Spec)

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

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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
    ManagedClusterAgentPoolProfileGpuInstanceProfile

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

    kubeletConfig
    KubeletConfig

    KubeletConfig: See AKS custom node configuration for more details.

    kubeletDiskType
    ManagedClusterAgentPoolProfileKubeletDiskType
    linuxOSConfig
    LinuxOSConfig

    LinuxOSConfig: See AKS custom node configuration for more details.

    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    ManagedClusterAgentPoolProfileMode
    name
    string

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

    nodeLabels
    map[string]string

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

    nodePublicIPPrefixIDReference
    genruntime.ResourceReference

    NodePublicIPPrefixIDReference: 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: 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

    OsDiskSizeGB: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

    osDiskType
    ManagedClusterAgentPoolProfileOsDiskType
    osSKU
    ManagedClusterAgentPoolProfileOsSKU
    osType
    ManagedClusterAgentPoolProfileOsType
    podSubnetIDReference
    genruntime.ResourceReference

    PodSubnetIDReference: 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}

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleSetEvictionPolicy
    ManagedClusterAgentPoolProfileScaleSetEvictionPolicy

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

    scaleSetPriority
    ManagedClusterAgentPoolProfileScaleSetPriority

    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
    ManagedClusterAgentPoolProfileType
    upgradeSettings
    AgentPoolUpgradeSettings

    UpgradeSettings: Settings for upgrading an 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

    vnetSubnetIDReference
    genruntime.ResourceReference

    VnetSubnetIDReference: 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}

    ManagedClusterAgentPoolProfileARM

    (Appears on:ManagedClusterPropertiesARM)

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

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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
    ManagedClusterAgentPoolProfileGpuInstanceProfile

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

    kubeletConfig
    KubeletConfigARM

    KubeletConfig: See AKS custom node configuration for more details.

    kubeletDiskType
    ManagedClusterAgentPoolProfileKubeletDiskType
    linuxOSConfig
    LinuxOSConfigARM

    LinuxOSConfig: See AKS custom node configuration for more details.

    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    ManagedClusterAgentPoolProfileMode
    name
    string

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

    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: 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

    OsDiskSizeGB: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

    osDiskType
    ManagedClusterAgentPoolProfileOsDiskType
    osSKU
    ManagedClusterAgentPoolProfileOsSKU
    osType
    ManagedClusterAgentPoolProfileOsType
    podSubnetID
    string
    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleSetEvictionPolicy
    ManagedClusterAgentPoolProfileScaleSetEvictionPolicy

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

    scaleSetPriority
    ManagedClusterAgentPoolProfileScaleSetPriority

    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
    ManagedClusterAgentPoolProfileType
    upgradeSettings
    AgentPoolUpgradeSettingsARM

    UpgradeSettings: Settings for upgrading an 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

    ManagedClusterAgentPoolProfileGpuInstanceProfile (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "MIG1g"

    "MIG2g"

    "MIG3g"

    "MIG4g"

    "MIG7g"

    ManagedClusterAgentPoolProfileKubeletDiskType (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "OS"

    "Temporary"

    ManagedClusterAgentPoolProfileMode (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "System"

    "User"

    ManagedClusterAgentPoolProfileOsDiskType (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "Ephemeral"

    "Managed"

    ManagedClusterAgentPoolProfileOsSKU (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "CBLMariner"

    "Ubuntu"

    ManagedClusterAgentPoolProfileOsType (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "Linux"

    "Windows"

    ManagedClusterAgentPoolProfilePropertiesARM

    (Appears on:ManagedClustersAgentPools_SpecARM)

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

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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
    ManagedClusterAgentPoolProfilePropertiesGpuInstanceProfile

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

    kubeletConfig
    KubeletConfigARM

    KubeletConfig: See AKS custom node configuration for more details.

    kubeletDiskType
    ManagedClusterAgentPoolProfilePropertiesKubeletDiskType
    linuxOSConfig
    LinuxOSConfigARM

    LinuxOSConfig: See AKS custom node configuration for more details.

    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    ManagedClusterAgentPoolProfilePropertiesMode
    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: 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

    OsDiskSizeGB: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

    osDiskType
    ManagedClusterAgentPoolProfilePropertiesOsDiskType
    osSKU
    ManagedClusterAgentPoolProfilePropertiesOsSKU
    osType
    ManagedClusterAgentPoolProfilePropertiesOsType
    podSubnetID
    string
    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleSetEvictionPolicy
    ManagedClusterAgentPoolProfilePropertiesScaleSetEvictionPolicy

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

    scaleSetPriority
    ManagedClusterAgentPoolProfilePropertiesScaleSetPriority

    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
    ManagedClusterAgentPoolProfilePropertiesType
    upgradeSettings
    AgentPoolUpgradeSettingsARM

    UpgradeSettings: Settings for upgrading an 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

    ManagedClusterAgentPoolProfilePropertiesGpuInstanceProfile (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "MIG1g"

    "MIG2g"

    "MIG3g"

    "MIG4g"

    "MIG7g"

    ManagedClusterAgentPoolProfilePropertiesKubeletDiskType (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "OS"

    "Temporary"

    ManagedClusterAgentPoolProfilePropertiesMode (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "System"

    "User"

    ManagedClusterAgentPoolProfilePropertiesOsDiskType (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "Ephemeral"

    "Managed"

    ManagedClusterAgentPoolProfilePropertiesOsSKU (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "CBLMariner"

    "Ubuntu"

    ManagedClusterAgentPoolProfilePropertiesOsType (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "Linux"

    "Windows"

    ManagedClusterAgentPoolProfilePropertiesScaleSetEvictionPolicy (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "Deallocate"

    "Delete"

    ManagedClusterAgentPoolProfilePropertiesScaleSetPriority (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "Regular"

    "Spot"

    ManagedClusterAgentPoolProfilePropertiesType (string alias)

    (Appears on:ManagedClusterAgentPoolProfilePropertiesARM, ManagedClustersAgentPools_Spec)

    Value Description

    "AvailabilitySet"

    "VirtualMachineScaleSets"

    ManagedClusterAgentPoolProfileProperties_StatusARM

    (Appears on:AgentPool_StatusARM)

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

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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.

    kubeletConfig
    KubeletConfig_StatusARM

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType_Status
    linuxOSConfig
    LinuxOSConfig_StatusARM

    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode_Status
    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: 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
    osSKU
    OSSKU_Status
    osType
    OSType_Status
    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_StatusARM

    PowerState: Describes whether the Agent Pool is Running or Stopped

    provisioningState
    string

    ProvisioningState: The current deployment or provisioning state.

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    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
    upgradeSettings
    AgentPoolUpgradeSettings_StatusARM

    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}

    ManagedClusterAgentPoolProfileScaleSetEvictionPolicy (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "Deallocate"

    "Delete"

    ManagedClusterAgentPoolProfileScaleSetPriority (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "Regular"

    "Spot"

    ManagedClusterAgentPoolProfileType (string alias)

    (Appears on:ManagedClusterAgentPoolProfile, ManagedClusterAgentPoolProfileARM)

    Value Description

    "AvailabilitySet"

    "VirtualMachineScaleSets"

    ManagedClusterAgentPoolProfile_Status

    (Appears on:ManagedCluster_Status)

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

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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.

    kubeletConfig
    KubeletConfig_Status

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType_Status
    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode_Status
    name
    string

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

    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: 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
    osSKU
    OSSKU_Status
    osType
    OSType_Status
    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: Describes whether the Agent Pool is Running or Stopped

    provisioningState
    string

    ProvisioningState: The current deployment or provisioning state.

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    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
    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}

    ManagedClusterAgentPoolProfile_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

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

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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.

    kubeletConfig
    KubeletConfig_StatusARM

    KubeletConfig: The Kubelet configuration on the agent pool nodes.

    kubeletDiskType
    KubeletDiskType_Status
    linuxOSConfig
    LinuxOSConfig_StatusARM

    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    AgentPoolMode_Status
    name
    string

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

    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: 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
    osSKU
    OSSKU_Status
    osType
    OSType_Status
    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_StatusARM

    PowerState: Describes whether the Agent Pool is Running or Stopped

    provisioningState
    string

    ProvisioningState: The current deployment or provisioning state.

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    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
    upgradeSettings
    AgentPoolUpgradeSettings_StatusARM

    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}

    ManagedClusterAutoUpgradeProfile

    (Appears on:ManagedClusters_Spec)

    Field Description
    upgradeChannel
    ManagedClusterAutoUpgradeProfileUpgradeChannel

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

    ManagedClusterAutoUpgradeProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    Field Description
    upgradeChannel
    ManagedClusterAutoUpgradeProfileUpgradeChannel

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

    ManagedClusterAutoUpgradeProfileStatusUpgradeChannel (string alias)

    (Appears on:ManagedClusterAutoUpgradeProfile_Status, ManagedClusterAutoUpgradeProfile_StatusARM)

    Value Description

    "node-image"

    "none"

    "patch"

    "rapid"

    "stable"

    ManagedClusterAutoUpgradeProfileUpgradeChannel (string alias)

    (Appears on:ManagedClusterAutoUpgradeProfile, ManagedClusterAutoUpgradeProfileARM)

    Value Description

    "node-image"

    "none"

    "patch"

    "rapid"

    "stable"

    ManagedClusterAutoUpgradeProfile_Status

    (Appears on:ManagedCluster_Status)

    Field Description
    upgradeChannel
    ManagedClusterAutoUpgradeProfileStatusUpgradeChannel

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

    ManagedClusterAutoUpgradeProfile_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    Field Description
    upgradeChannel
    ManagedClusterAutoUpgradeProfileStatusUpgradeChannel

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

    ManagedClusterHTTPProxyConfig

    (Appears on:ManagedClusters_Spec)

    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.

    ManagedClusterHTTPProxyConfigARM

    (Appears on:ManagedClusterPropertiesARM)

    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)

    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_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    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.

    ManagedClusterIdentity

    (Appears on:ManagedClusters_Spec)

    Field Description
    type
    ManagedClusterIdentityType

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

    userAssignedIdentities
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

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

    ManagedClusterIdentityARM

    (Appears on:ManagedClusters_SpecARM)

    Field Description
    type
    ManagedClusterIdentityType

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

    userAssignedIdentities
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

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

    ManagedClusterIdentityStatusType (string alias)

    (Appears on:ManagedClusterIdentity_Status, ManagedClusterIdentity_StatusARM)

    Value Description

    "None"

    "SystemAssigned"

    "UserAssigned"

    ManagedClusterIdentityType (string alias)

    (Appears on:ManagedClusterIdentity, ManagedClusterIdentityARM)

    Value Description

    "None"

    "SystemAssigned"

    "UserAssigned"

    ManagedClusterIdentity_Status

    (Appears on:ManagedCluster_Status)

    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
    ManagedClusterIdentityStatusType

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

    userAssignedIdentities
    map[string]./api/containerservice/v1beta20210501.ManagedClusterIdentity_Status_UserAssignedIdentities

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

    ManagedClusterIdentity_StatusARM

    (Appears on:ManagedCluster_StatusARM)

    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
    ManagedClusterIdentityStatusType

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

    userAssignedIdentities
    map[string]./api/containerservice/v1beta20210501.ManagedClusterIdentity_Status_UserAssignedIdentitiesARM

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

    ManagedClusterIdentity_Status_UserAssignedIdentities

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

    (Appears on:ManagedClusterIdentity_StatusARM)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    ManagedClusterLoadBalancerProfile

    (Appears on:ContainerServiceNetworkProfile)

    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.

    effectiveOutboundIPs
    []ResourceReference

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

    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
    ManagedClusterLoadBalancerProfileManagedOutboundIPs

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

    outboundIPPrefixes
    ManagedClusterLoadBalancerProfileOutboundIPPrefixes

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

    outboundIPs
    ManagedClusterLoadBalancerProfileOutboundIPs

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

    ManagedClusterLoadBalancerProfileARM

    (Appears on:ContainerServiceNetworkProfileARM)

    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.

    effectiveOutboundIPs
    []ResourceReferenceARM

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

    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
    ManagedClusterLoadBalancerProfileManagedOutboundIPsARM

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

    outboundIPPrefixes
    ManagedClusterLoadBalancerProfileOutboundIPPrefixesARM

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

    outboundIPs
    ManagedClusterLoadBalancerProfileOutboundIPsARM

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

    ManagedClusterLoadBalancerProfileManagedOutboundIPs

    (Appears on:ManagedClusterLoadBalancerProfile)

    Field Description
    count
    int

    Count: The desired number of 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.

    ManagedClusterLoadBalancerProfileManagedOutboundIPsARM

    (Appears on:ManagedClusterLoadBalancerProfileARM)

    Field Description
    count
    int

    Count: The desired number of 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.

    ManagedClusterLoadBalancerProfileOutboundIPPrefixes

    (Appears on:ManagedClusterLoadBalancerProfile)

    Field Description
    publicIPPrefixes
    []ResourceReference

    PublicIPPrefixes: A list of public IP prefix resources.

    ManagedClusterLoadBalancerProfileOutboundIPPrefixesARM

    (Appears on:ManagedClusterLoadBalancerProfileARM)

    Field Description
    publicIPPrefixes
    []ResourceReferenceARM

    PublicIPPrefixes: A list of public IP prefix resources.

    ManagedClusterLoadBalancerProfileOutboundIPs

    (Appears on:ManagedClusterLoadBalancerProfile)

    Field Description
    publicIPs
    []ResourceReference

    PublicIPs: A list of public IP resources.

    ManagedClusterLoadBalancerProfileOutboundIPsARM

    (Appears on:ManagedClusterLoadBalancerProfileARM)

    Field Description
    publicIPs
    []ResourceReferenceARM

    PublicIPs: A list of public IP resources.

    ManagedClusterLoadBalancerProfile_Status

    (Appears on:ContainerServiceNetworkProfile_Status)

    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.

    effectiveOutboundIPs
    []ResourceReference_Status

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

    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_Status_ManagedOutboundIPs

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

    outboundIPPrefixes
    ManagedClusterLoadBalancerProfile_Status_OutboundIPPrefixes

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

    outboundIPs
    ManagedClusterLoadBalancerProfile_Status_OutboundIPs

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

    ManagedClusterLoadBalancerProfile_StatusARM

    (Appears on:ContainerServiceNetworkProfile_StatusARM)

    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.

    effectiveOutboundIPs
    []ResourceReference_StatusARM

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

    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_Status_ManagedOutboundIPsARM

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

    outboundIPPrefixes
    ManagedClusterLoadBalancerProfile_Status_OutboundIPPrefixesARM

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

    outboundIPs
    ManagedClusterLoadBalancerProfile_Status_OutboundIPsARM

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

    ManagedClusterLoadBalancerProfile_Status_ManagedOutboundIPs

    (Appears on:ManagedClusterLoadBalancerProfile_Status)

    Field Description
    count
    int

    Count: The desired number of 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.

    ManagedClusterLoadBalancerProfile_Status_ManagedOutboundIPsARM

    (Appears on:ManagedClusterLoadBalancerProfile_StatusARM)

    Field Description
    count
    int

    Count: The desired number of 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.

    ManagedClusterLoadBalancerProfile_Status_OutboundIPPrefixes

    (Appears on:ManagedClusterLoadBalancerProfile_Status)

    Field Description
    publicIPPrefixes
    []ResourceReference_Status

    PublicIPPrefixes: A list of public IP prefix resources.

    ManagedClusterLoadBalancerProfile_Status_OutboundIPPrefixesARM

    (Appears on:ManagedClusterLoadBalancerProfile_StatusARM)

    Field Description
    publicIPPrefixes
    []ResourceReference_StatusARM

    PublicIPPrefixes: A list of public IP prefix resources.

    ManagedClusterLoadBalancerProfile_Status_OutboundIPs

    (Appears on:ManagedClusterLoadBalancerProfile_Status)

    Field Description
    publicIPs
    []ResourceReference_Status

    PublicIPs: A list of public IP resources.

    ManagedClusterLoadBalancerProfile_Status_OutboundIPsARM

    (Appears on:ManagedClusterLoadBalancerProfile_StatusARM)

    Field Description
    publicIPs
    []ResourceReference_StatusARM

    PublicIPs: A list of public IP resources.

    ManagedClusterPodIdentity

    (Appears on:ManagedClusterPodIdentityProfile)

    Field Description
    bindingSelector
    string

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

    identity
    UserAssignedIdentity

    Identity: Details about a user assigned identity.

    name
    string

    Name: The name of the pod identity.

    namespace
    string

    Namespace: The namespace of the pod identity.

    ManagedClusterPodIdentityARM

    (Appears on:ManagedClusterPodIdentityProfileARM)

    Field Description
    bindingSelector
    string

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

    identity
    UserAssignedIdentityARM

    Identity: Details about a user assigned identity.

    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.

    ManagedClusterPodIdentityExceptionARM

    (Appears on:ManagedClusterPodIdentityProfileARM)

    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_StatusARM

    (Appears on:ManagedClusterPodIdentityProfile_StatusARM)

    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:ManagedClusters_Spec)

    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.

    ManagedClusterPodIdentityProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    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
    []ManagedClusterPodIdentityARM

    UserAssignedIdentities: The pod identities to use in the cluster.

    userAssignedIdentityExceptions
    []ManagedClusterPodIdentityExceptionARM

    UserAssignedIdentityExceptions: The pod identity exceptions to allow.

    ManagedClusterPodIdentityProfile_Status

    (Appears on:ManagedCluster_Status)

    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_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    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_StatusARM

    UserAssignedIdentities: The pod identities to use in the cluster.

    userAssignedIdentityExceptions
    []ManagedClusterPodIdentityException_StatusARM

    UserAssignedIdentityExceptions: The pod identity exceptions to allow.

    ManagedClusterPodIdentityProvisioningErrorBody_Status

    (Appears on:ManagedClusterPodIdentityProvisioningError_Status)

    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_StatusARM

    (Appears on:ManagedClusterPodIdentityProvisioningError_StatusARM)

    Field Description
    code
    string

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

    details
    []ManagedClusterPodIdentityProvisioningErrorBody_Status_UnrolledARM

    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_UnrolledARM

    (Appears on:ManagedClusterPodIdentityProvisioningErrorBody_StatusARM)

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

    Field Description
    error
    ManagedClusterPodIdentityProvisioningErrorBody_Status

    Error: Details about the error.

    ManagedClusterPodIdentityProvisioningError_StatusARM

    (Appears on:ManagedClusterPodIdentity_Status_ProvisioningInfoARM)

    Field Description
    error
    ManagedClusterPodIdentityProvisioningErrorBody_StatusARM

    Error: Details about the error.

    ManagedClusterPodIdentityStatusProvisioningState (string alias)

    (Appears on:ManagedClusterPodIdentity_Status, ManagedClusterPodIdentity_StatusARM)

    Value Description

    "Assigned"

    "Deleting"

    "Failed"

    "Updating"

    ManagedClusterPodIdentity_Status

    (Appears on:ManagedClusterPodIdentityProfile_Status)

    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_Status_ProvisioningInfo
    provisioningState
    ManagedClusterPodIdentityStatusProvisioningState

    ProvisioningState: The current provisioning state of the pod identity.

    ManagedClusterPodIdentity_StatusARM

    (Appears on:ManagedClusterPodIdentityProfile_StatusARM)

    Field Description
    bindingSelector
    string

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

    identity
    UserAssignedIdentity_StatusARM

    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_Status_ProvisioningInfoARM
    provisioningState
    ManagedClusterPodIdentityStatusProvisioningState

    ProvisioningState: The current provisioning state of the pod identity.

    ManagedClusterPodIdentity_Status_ProvisioningInfo

    (Appears on:ManagedClusterPodIdentity_Status)

    Field Description
    error
    ManagedClusterPodIdentityProvisioningError_Status

    Error: Pod identity assignment error (if any).

    ManagedClusterPodIdentity_Status_ProvisioningInfoARM

    (Appears on:ManagedClusterPodIdentity_StatusARM)

    Field Description
    error
    ManagedClusterPodIdentityProvisioningError_StatusARM

    Error: Pod identity assignment error (if any).

    ManagedClusterPropertiesARM

    (Appears on:ManagedClusters_SpecARM)

    Field Description
    aadProfile
    ManagedClusterAADProfileARM

    AadProfile: For more details see managed AAD on AKS.

    addonProfiles
    map[string]./api/containerservice/v1beta20210501.ManagedClusterAddonProfileARM

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfileARM

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfileARM

    ApiServerAccessProfile: Access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterPropertiesAutoScalerProfileARM

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

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfileARM

    AutoUpgradeProfile: Auto upgrade profile for a managed cluster.

    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.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.

    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.

    httpProxyConfig
    ManagedClusterHTTPProxyConfigARM

    HttpProxyConfig: Cluster HTTP proxy configuration.

    identityProfile
    map[string]./api/containerservice/v1beta20210501.Componentsqit0EtschemasmanagedclusterpropertiespropertiesidentityprofileadditionalpropertiesARM

    IdentityProfile: Identities associated with the 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
    ContainerServiceLinuxProfileARM

    LinuxProfile: Profile for Linux VMs in the container service cluster.

    networkProfile
    ContainerServiceNetworkProfileARM

    NetworkProfile: Profile of network configuration.

    nodeResourceGroup
    string

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

    podIdentityProfile
    ManagedClusterPodIdentityProfileARM

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

    privateLinkResources
    []PrivateLinkResourceARM

    PrivateLinkResources: Private link resources associated with the cluster.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfileARM

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

    windowsProfile
    ManagedClusterWindowsProfileARM

    WindowsProfile: Profile for Windows VMs in the managed cluster.

    ManagedClusterPropertiesAutoScalerProfile

    (Appears on:ManagedClusters_Spec)

    Field Description
    balance-similar-node-groups
    string

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

    expander
    ManagedClusterPropertiesAutoScalerProfileExpander

    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.

    ManagedClusterPropertiesAutoScalerProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    Field Description
    balance-similar-node-groups
    string

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

    expander
    ManagedClusterPropertiesAutoScalerProfileExpander

    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.

    ManagedClusterPropertiesAutoScalerProfileExpander (string alias)

    (Appears on:ManagedClusterPropertiesAutoScalerProfile, ManagedClusterPropertiesAutoScalerProfileARM)

    Value Description

    "least-waste"

    "most-pods"

    "priority"

    "random"

    ManagedClusterPropertiesStatusAutoScalerProfileExpander (string alias)

    (Appears on:ManagedClusterProperties_Status_AutoScalerProfile, ManagedClusterProperties_Status_AutoScalerProfileARM)

    Value Description

    "least-waste"

    "most-pods"

    "priority"

    "random"

    ManagedClusterProperties_StatusARM

    (Appears on:ManagedCluster_StatusARM)

    Field Description
    aadProfile
    ManagedClusterAADProfile_StatusARM

    AadProfile: The Azure Active Directory configuration.

    addonProfiles
    Kubernetes v1.JSON

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfile_StatusARM

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfile_StatusARM

    ApiServerAccessProfile: The access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterProperties_Status_AutoScalerProfileARM

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

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile_StatusARM

    AutoUpgradeProfile: The auto upgrade configuration.

    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.

    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.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.

    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.

    httpProxyConfig
    ManagedClusterHTTPProxyConfig_StatusARM

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

    identityProfile
    Kubernetes v1.JSON

    IdentityProfile: Identities associated with the 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_StatusARM

    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_StatusARM

    NetworkProfile: The network configuration profile.

    nodeResourceGroup
    string

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

    podIdentityProfile
    ManagedClusterPodIdentityProfile_StatusARM

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

    powerState
    PowerState_StatusARM

    PowerState: The Power State of the cluster.

    privateFQDN
    string

    PrivateFQDN: The FQDN of private cluster.

    privateLinkResources
    []PrivateLinkResource_StatusARM

    PrivateLinkResources: Private link resources associated with the cluster.

    provisioningState
    string

    ProvisioningState: The current provisioning state.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfile_StatusARM

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

    windowsProfile
    ManagedClusterWindowsProfile_StatusARM

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

    ManagedClusterProperties_Status_AutoScalerProfile

    (Appears on:ManagedCluster_Status)

    Field Description
    balance-similar-node-groups
    string

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

    expander
    ManagedClusterPropertiesStatusAutoScalerProfileExpander

    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_Status_AutoScalerProfileARM

    (Appears on:ManagedClusterProperties_StatusARM)

    Field Description
    balance-similar-node-groups
    string

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

    expander
    ManagedClusterPropertiesStatusAutoScalerProfileExpander

    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.

    ManagedClusterSKU

    (Appears on:ManagedClusters_Spec)

    Field Description
    name
    ManagedClusterSKUName

    Name: The name of a managed cluster SKU.

    tier
    ManagedClusterSKUTier

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

    ManagedClusterSKUARM

    (Appears on:ManagedClusters_SpecARM)

    Field Description
    name
    ManagedClusterSKUName

    Name: The name of a managed cluster SKU.

    tier
    ManagedClusterSKUTier

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

    ManagedClusterSKUName (string alias)

    (Appears on:ManagedClusterSKU, ManagedClusterSKUARM)

    Value Description

    "Basic"

    ManagedClusterSKUStatusName (string alias)

    (Appears on:ManagedClusterSKU_Status, ManagedClusterSKU_StatusARM)

    Value Description

    "Basic"

    ManagedClusterSKUStatusTier (string alias)

    (Appears on:ManagedClusterSKU_Status, ManagedClusterSKU_StatusARM)

    Value Description

    "Free"

    "Paid"

    ManagedClusterSKUTier (string alias)

    (Appears on:ManagedClusterSKU, ManagedClusterSKUARM)

    Value Description

    "Free"

    "Paid"

    ManagedClusterSKU_Status

    (Appears on:ManagedCluster_Status)

    Field Description
    name
    ManagedClusterSKUStatusName

    Name: The name of a managed cluster SKU.

    tier
    ManagedClusterSKUStatusTier

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

    ManagedClusterSKU_StatusARM

    (Appears on:ManagedCluster_StatusARM)

    Field Description
    name
    ManagedClusterSKUStatusName

    Name: The name of a managed cluster SKU.

    tier
    ManagedClusterSKUStatusTier

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

    ManagedClusterServicePrincipalProfile

    (Appears on:ManagedClusters_Spec)

    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.

    ManagedClusterServicePrincipalProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    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)

    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_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    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.

    ManagedClusterWindowsProfile

    (Appears on:ManagedClusters_Spec)

    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.

    licenseType
    ManagedClusterWindowsProfileLicenseType

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

    ManagedClusterWindowsProfileARM

    (Appears on:ManagedClusterPropertiesARM)

    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.

    licenseType
    ManagedClusterWindowsProfileLicenseType

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

    ManagedClusterWindowsProfileLicenseType (string alias)

    (Appears on:ManagedClusterWindowsProfile, ManagedClusterWindowsProfileARM)

    Value Description

    "None"

    "Windows_Server"

    ManagedClusterWindowsProfileStatusLicenseType (string alias)

    (Appears on:ManagedClusterWindowsProfile_Status, ManagedClusterWindowsProfile_StatusARM)

    Value Description

    "None"

    "Windows_Server"

    ManagedClusterWindowsProfile_Status

    (Appears on:ManagedCluster_Status)

    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.

    licenseType
    ManagedClusterWindowsProfileStatusLicenseType

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

    ManagedClusterWindowsProfile_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    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.

    licenseType
    ManagedClusterWindowsProfileStatusLicenseType

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

    ManagedCluster_Status

    (Appears on:ManagedCluster)

    Field Description
    aadProfile
    ManagedClusterAADProfile_Status

    AadProfile: The Azure Active Directory configuration.

    addonProfiles
    Kubernetes v1.JSON

    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_Status_AutoScalerProfile

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

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile_Status

    AutoUpgradeProfile: The auto upgrade configuration.

    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

    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.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.

    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.

    httpProxyConfig
    ManagedClusterHTTPProxyConfig_Status

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

    id
    string

    Id: Resource Id

    identity
    ManagedClusterIdentity_Status

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

    identityProfile
    Kubernetes v1.JSON

    IdentityProfile: Identities associated with the 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: Resource location

    maxAgentPools
    int

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

    name
    string

    Name: Resource name

    networkProfile
    ContainerServiceNetworkProfile_Status

    NetworkProfile: The network configuration profile.

    nodeResourceGroup
    string

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

    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.

    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.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    windowsProfile
    ManagedClusterWindowsProfile_Status

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

    ManagedCluster_StatusARM

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the Virtual Machine.

    id
    string

    Id: Resource Id

    identity
    ManagedClusterIdentity_StatusARM

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

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    properties
    ManagedClusterProperties_StatusARM

    Properties: Properties of a managed cluster.

    sku
    ManagedClusterSKU_StatusARM

    Sku: The managed cluster SKU.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    ManagedClustersAgentPool

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ManagedClustersAgentPools_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.

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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
    ManagedClusterAgentPoolProfilePropertiesGpuInstanceProfile

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

    kubeletConfig
    KubeletConfig

    KubeletConfig: See AKS custom node configuration for more details.

    kubeletDiskType
    ManagedClusterAgentPoolProfilePropertiesKubeletDiskType
    linuxOSConfig
    LinuxOSConfig

    LinuxOSConfig: See AKS custom node configuration for more details.

    location
    string

    Location: Location to deploy resource to

    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    ManagedClusterAgentPoolProfilePropertiesMode
    nodeLabels
    map[string]string

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

    nodePublicIPPrefixIDReference
    genruntime.ResourceReference

    NodePublicIPPrefixIDReference: 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: 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

    OsDiskSizeGB: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

    osDiskType
    ManagedClusterAgentPoolProfilePropertiesOsDiskType
    osSKU
    ManagedClusterAgentPoolProfilePropertiesOsSKU
    osType
    ManagedClusterAgentPoolProfilePropertiesOsType
    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

    podSubnetIDReference
    genruntime.ResourceReference

    PodSubnetIDReference: 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}

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleSetEvictionPolicy
    ManagedClusterAgentPoolProfilePropertiesScaleSetEvictionPolicy

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

    scaleSetPriority
    ManagedClusterAgentPoolProfilePropertiesScaleSetPriority

    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
    ManagedClusterAgentPoolProfilePropertiesType
    upgradeSettings
    AgentPoolUpgradeSettings

    UpgradeSettings: Settings for upgrading an 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

    vnetSubnetIDReference
    genruntime.ResourceReference

    VnetSubnetIDReference: 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}

    status
    AgentPool_Status

    ManagedClustersAgentPoolsSpecAPIVersion (string alias)

    Value Description

    "2021-05-01"

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

    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.

    enableAutoScaling
    bool

    EnableAutoScaling: Whether to enable auto-scaler

    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
    ManagedClusterAgentPoolProfilePropertiesGpuInstanceProfile

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

    kubeletConfig
    KubeletConfig

    KubeletConfig: See AKS custom node configuration for more details.

    kubeletDiskType
    ManagedClusterAgentPoolProfilePropertiesKubeletDiskType
    linuxOSConfig
    LinuxOSConfig

    LinuxOSConfig: See AKS custom node configuration for more details.

    location
    string

    Location: Location to deploy resource to

    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.

    minCount
    int

    MinCount: The minimum number of nodes for auto-scaling

    mode
    ManagedClusterAgentPoolProfilePropertiesMode
    nodeLabels
    map[string]string

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

    nodePublicIPPrefixIDReference
    genruntime.ResourceReference

    NodePublicIPPrefixIDReference: 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: 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

    OsDiskSizeGB: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

    osDiskType
    ManagedClusterAgentPoolProfilePropertiesOsDiskType
    osSKU
    ManagedClusterAgentPoolProfilePropertiesOsSKU
    osType
    ManagedClusterAgentPoolProfilePropertiesOsType
    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

    podSubnetIDReference
    genruntime.ResourceReference

    PodSubnetIDReference: 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}

    proximityPlacementGroupID
    string

    ProximityPlacementGroupID: The ID for Proximity Placement Group.

    scaleSetEvictionPolicy
    ManagedClusterAgentPoolProfilePropertiesScaleSetEvictionPolicy

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

    scaleSetPriority
    ManagedClusterAgentPoolProfilePropertiesScaleSetPriority

    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
    ManagedClusterAgentPoolProfilePropertiesType
    upgradeSettings
    AgentPoolUpgradeSettings

    UpgradeSettings: Settings for upgrading an 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

    vnetSubnetIDReference
    genruntime.ResourceReference

    VnetSubnetIDReference: 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}

    ManagedClustersAgentPools_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The name of the agent pool.

    properties
    ManagedClusterAgentPoolProfilePropertiesARM

    Properties: Properties for the container service agent pool profile.

    ManagedClustersSpecAPIVersion (string alias)

    Value Description

    "2021-05-01"

    ManagedClusters_Spec

    (Appears on:ManagedCluster)

    Field Description
    aadProfile
    ManagedClusterAADProfile

    AadProfile: For more details see managed AAD on AKS.

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

    AddonProfiles: The profile of managed cluster add-on.

    agentPoolProfiles
    []ManagedClusterAgentPoolProfile

    AgentPoolProfiles: The agent pool properties.

    apiServerAccessProfile
    ManagedClusterAPIServerAccessProfile

    ApiServerAccessProfile: Access profile for managed cluster API server.

    autoScalerProfile
    ManagedClusterPropertiesAutoScalerProfile

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

    autoUpgradeProfile
    ManagedClusterAutoUpgradeProfile

    AutoUpgradeProfile: Auto upgrade profile for a managed 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.

    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.

    diskEncryptionSetIDReference
    genruntime.ResourceReference

    DiskEncryptionSetIDReference: 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.

    enablePodSecurityPolicy
    bool

    EnablePodSecurityPolicy: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.

    enableRBAC
    bool

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

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    fqdnSubdomain
    string

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

    httpProxyConfig
    ManagedClusterHTTPProxyConfig

    HttpProxyConfig: Cluster HTTP proxy configuration.

    identity
    ManagedClusterIdentity

    Identity: Identity for the managed cluster.

    identityProfile
    map[string]./api/containerservice/v1beta20210501.Componentsqit0Etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties

    IdentityProfile: Identities associated with the 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: Profile for Linux VMs in the container service cluster.

    location
    string

    Location: Location to deploy resource to

    networkProfile
    ContainerServiceNetworkProfile

    NetworkProfile: Profile of network configuration.

    nodeResourceGroup
    string

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

    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 pod identity integration.

    privateLinkResources
    []PrivateLinkResource

    PrivateLinkResources: Private link resources associated with the cluster.

    servicePrincipalProfile
    ManagedClusterServicePrincipalProfile

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

    sku
    ManagedClusterSKU

    Sku: The SKU of a Managed Cluster.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    windowsProfile
    ManagedClusterWindowsProfile

    WindowsProfile: Profile for Windows VMs in the managed cluster.

    ManagedClusters_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The complex type of the extended location.

    identity
    ManagedClusterIdentityARM

    Identity: Identity for the managed cluster.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The name of the managed cluster resource.

    properties
    ManagedClusterPropertiesARM

    Properties: Properties of the managed cluster.

    sku
    ManagedClusterSKUARM

    Sku: The SKU of a Managed Cluster.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    OSDiskType_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "Ephemeral"

    "Managed"

    OSSKU_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "CBLMariner"

    "Ubuntu"

    OSType_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "Linux"

    "Windows"

    PowerStateStatusCode (string alias)

    (Appears on:PowerState_Status, PowerState_StatusARM)

    Value Description

    "Running"

    "Stopped"

    PowerState_Status

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfile_Status, ManagedCluster_Status)

    Field Description
    code
    PowerStateStatusCode

    Code: Tells whether the cluster is Running or Stopped

    PowerState_StatusARM

    (Appears on:ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_StatusARM, ManagedClusterProperties_StatusARM)

    Field Description
    code
    PowerStateStatusCode

    Code: Tells whether the cluster is Running or Stopped

    PrivateLinkResource

    (Appears on:ManagedClusters_Spec)

    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.

    PrivateLinkResourceARM

    (Appears on:ManagedClusterPropertiesARM)

    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)

    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_StatusARM

    (Appears on:ManagedClusterProperties_StatusARM)

    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, ManagedClusterLoadBalancerProfileOutboundIPPrefixes, ManagedClusterLoadBalancerProfileOutboundIPs)

    Field Description
    reference
    genruntime.ResourceReference

    Reference: The fully qualified Azure resource id.

    ResourceReferenceARM

    (Appears on:ManagedClusterLoadBalancerProfileARM, ManagedClusterLoadBalancerProfileOutboundIPPrefixesARM, ManagedClusterLoadBalancerProfileOutboundIPsARM)

    Field Description
    id
    string

    ResourceReference_Status

    (Appears on:ManagedClusterLoadBalancerProfile_Status, ManagedClusterLoadBalancerProfile_Status_OutboundIPPrefixes, ManagedClusterLoadBalancerProfile_Status_OutboundIPs)

    Field Description
    id
    string

    Id: The fully qualified Azure resource id.

    ResourceReference_StatusARM

    (Appears on:ManagedClusterLoadBalancerProfile_StatusARM, ManagedClusterLoadBalancerProfile_Status_OutboundIPPrefixesARM, ManagedClusterLoadBalancerProfile_Status_OutboundIPsARM)

    Field Description
    id
    string

    Id: The fully qualified Azure resource id.

    ScaleSetEvictionPolicy_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "Deallocate"

    "Delete"

    ScaleSetPriority_Status (string alias)

    (Appears on:AgentPool_Status, ManagedClusterAgentPoolProfileProperties_StatusARM, ManagedClusterAgentPoolProfile_Status, ManagedClusterAgentPoolProfile_StatusARM)

    Value Description

    "Regular"

    "Spot"

    SysctlConfig

    (Appears on:LinuxOSConfig)

    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.

    SysctlConfigARM

    (Appears on:LinuxOSConfigARM)

    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)

    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_StatusARM

    (Appears on:LinuxOSConfig_StatusARM)

    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.

    UserAssignedIdentity

    (Appears on:ManagedClusterPodIdentity)

    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.

    UserAssignedIdentityARM

    (Appears on:ManagedClusterPodIdentityARM)

    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:ManagedClusterPodIdentity_Status)

    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_StatusARM

    (Appears on:ManagedClusterPodIdentity_StatusARM)

    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.