ManagedClusterAgentPoolProfile

Profile for the container service agent pool.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
name	string	Unique name of the agent pool profile in the context of the subscription and resource group.
count	integer	Number of agents (VMs) to host docker containers.
vmSize	string	The size of the agent VMs.
osDiskSizeGB	integer	OS disk size in GB for the agent pool VMs.
osDiskType	string	The OS disk type to be used for machines in the agent pool.
osType	string	The operating system type.
osSKU	string	Specifies the OS SKU.
maxPods	integer	The maximum number of pods that can run on a node.
mode	string	The mode of an agent pool.
type	string	The type of agent pool.
availabilityZones	array	The list of availability zones to use for nodes (e.g., ["1", "2", "3"]).
enableAutoScaling	boolean	Whether to enable auto-scaler.
minCount	integer	The minimum number of nodes for auto-scaling.
maxCount	integer	The maximum number of nodes for auto-scaling.
nodeLabels	object	The node labels to be persisted across all nodes in the agent pool.
nodeTaints	array	The taints added to new nodes during node pool create and scale.
upgradeSettings	object	Settings for upgrading the agentpool.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ManagedClusterAgentPoolProfile",
  "title": "ManagedClusterAgentPoolProfile",
  "type": "object",
  "description": "Profile for the container service agent pool.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Unique name of the agent pool profile in the context of the subscription and resource group.",
      "pattern": "^[a-z][a-z0-9]{0,11}$",
      "example": "Example Title"
    },
    "count": {
      "type": "integer",
      "description": "Number of agents (VMs) to host docker containers.",
      "example": 10
    },
    "vmSize": {
      "type": "string",
      "description": "The size of the agent VMs.",
      "example": "example_value"
    },
    "osDiskSizeGB": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2048,
      "description": "OS disk size in GB for the agent pool VMs.",
      "example": 10
    },
    "osDiskType": {
      "type": "string",
      "enum": [
        "Managed",
        "Ephemeral"
      ],
      "description": "The OS disk type to be used for machines in the agent pool.",
      "example": "Managed"
    },
    "osType": {
      "type": "string",
      "enum": [
        "Linux",
        "Windows"
      ],
      "default": "Linux",
      "description": "The operating system type.",
      "example": "Linux"
    },
    "osSKU": {
      "type": "string",
      "enum": [
        "Ubuntu",
        "AzureLinux",
        "CBLMariner",
        "Windows2019",
        "Windows2022"
      ],
      "description": "Specifies the OS SKU.",
      "example": "Ubuntu"
    },
    "maxPods": {
      "type": "integer",
      "description": "The maximum number of pods that can run on a node.",
      "example": 10
    },
    "mode": {
      "type": "string",
      "enum": [
        "System",
        "User"
      ],
      "description": "The mode of an agent pool.",
      "example": "System"
    },
    "type": {
      "type": "string",
      "enum": [
        "VirtualMachineScaleSets",
        "AvailabilitySet"
      ],
      "default": "VirtualMachineScaleSets",
      "description": "The type of agent pool.",
      "example": "VirtualMachineScaleSets"
    },
    "availabilityZones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of availability zones to use for nodes (e.g., [\"1\", \"2\", \"3\"]).",
      "example": []
    },
    "enableAutoScaling": {
      "type": "boolean",
      "description": "Whether to enable auto-scaler.",
      "example": true
    },
    "minCount": {
      "type": "integer",
      "description": "The minimum number of nodes for auto-scaling.",
      "example": 10
    },
    "maxCount": {
      "type": "integer",
      "description": "The maximum number of nodes for auto-scaling.",
      "example": 10
    },
    "nodeLabels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The node labels to be persisted across all nodes in the agent pool.",
      "example": "example_value"
    },
    "nodeTaints": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The taints added to new nodes during node pool create and scale.",
      "example": []
    },
    "upgradeSettings": {
      "type": "object",
      "description": "Settings for upgrading the agentpool.",
      "properties": {
        "maxSurge": {
          "type": "string",
          "description": "The maximum number or percentage of nodes that are surged during upgrade (e.g., \"1\" or \"33%\")."
        }
      },
      "example": "example_value"
    }
  },
  "required": [
    "name"
  ]
}