Azure Kubernetes Service · Schema
ManagedClusterAgentPoolProfile
Profile for the container service agent pool.
AzureCloudContainersDevOpsKubernetesOrchestration
Properties
| Name | Type | Description |
|---|---|---|
| name | string | The 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. 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. |
| vmSize | string | The size of the agent VMs. Example: Standard_DS2_v2 |
| osDiskSizeGB | integer | OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. |
| osDiskType | string | The OS disk type to be used for machines in the agent pool. |
| kubeletDiskType | string | Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. |
| maxPods | integer | The maximum number of pods that can run on a node. |
| osType | string | The operating system type. |
| osSKU | string | Specifies the OS SKU used by the agent pool. |
| type | string | The type of Agent Pool. |
| mode | string | The mode of an agent pool. A cluster must have at least one System agent pool at all times. |
| orchestratorVersion | string | The version of Kubernetes running on the Agent Pool. |
| currentOrchestratorVersion | string | The version of Kubernetes the Agent Pool is running. |
| nodeImageVersion | string | The version of node image. |
| 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. |
| scaleSetPriority | string | The Virtual Machine Scale Set priority. |
| scaleSetEvictionPolicy | string | The Virtual Machine Scale Set eviction policy. |
| spotMaxPrice | number | The maximum price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates that default price is up-to on-demand. |
| scaleDownMode | string | Describes how VMs are added to or removed from Agent Pools. |
| vnetSubnetID | string | The ID of the subnet which agent pool nodes and optionally pods will join on startup. |
| podSubnetID | string | The ID of the subnet which pods will join when launched. |
| enableNodePublicIP | boolean | Whether each node is allocated its own public IP. |
| nodePublicIPPrefixID | string | The public IP prefix ID for the nodes in the agent pool. |
| enableEncryptionAtHost | boolean | Whether to enable host-based OS and data drive encryption. |
| enableFIPS | boolean | Whether to use a FIPS-enabled OS. |
| enableUltraSSD | boolean | Whether to enable UltraSSD. |
| nodeLabels | object | The node labels to be persisted across all nodes in agent pool. |
| nodeTaints | array | The taints added to new nodes during node pool create and scale. |
| tags | object | The tags to be persisted on the agent pool virtual machine scale set. |
| proximityPlacementGroupID | string | The ID for Proximity Placement Group. |
| availabilityZones | array | The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is VirtualMachineScaleSets. |
| workloadRuntime | string | Determines the type of workload a node can run. |
| messageOfTheDay | string | A base64-encoded string which will be written to /etc/motd after decoding. Applicable only for Linux nodes. |