Microsoft.ContainerService (stable:2024-10-01)

2025/03/16 • 4 updated methods

AgentPools_List (updated)
Description :  Gets a list of agent pools in the specified managed cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AgentPools_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "vmSize",
                "Description": {
                  "new": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions",
                  "old": "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"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of agent pools. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: 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 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: 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'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of agent pool results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_Get (updated)
Description :  Gets the specified managed cluster agent pool.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AgentPools_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "vmSize",
            "Description": {
              "new": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions",
              "old": "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"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: 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 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: 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'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_CreateOrUpdate (updated)
Description :  Creates or updates an agent pool in the specified managed cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AgentPools_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "vmSize",
            "Description": {
              "new": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions",
              "old": "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"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "vmSize",
            "Description": {
              "new": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions",
              "old": "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"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "vmSize",
            "Description": {
              "new": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions",
              "old": "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"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
parameters:
{
Description: The agent pool to create or update. ,
Required: True ,
}
{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: 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 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: 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'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
If-Match:
{
Description: The request should only proceed if an entity matches this string. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: The request should only proceed if no entity matches this string. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: 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 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: 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'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: 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 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: 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'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AgentPools_UpgradeNodeImageVersion (updated)
Description :  Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade
Reference :  Link ¶

⚶ Changes

{
  "#id": "AgentPools_UpgradeNodeImageVersion",
  "$responses": {
    "202": {
      "$properties": {
        "properties": [
          {
            "#name": "vmSize",
            "Description": {
              "new": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions",
              "old": "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"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the managed cluster resource. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Agent Pool. ,
}
{
properties:
{
Description: Properties of an agent pool. ,
Required: False ,
}
{
eTag:
{
Description: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention. ,
Required: False ,
}
string ,
count:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSize:
{
Description: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. If this field is not specified, AKS will attempt to find an appropriate VM SKU for your pool, based on quota and capacity. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions ,
Required: False ,
}
string ,
osDiskSizeGB:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
osDiskType:
{
Description: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). ,
Enum:
{
Managed: Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency. ,
Ephemeral: Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades. ,
}
,
Required: False ,
}
enum ,
kubeletDiskType:
{
Description: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. ,
Enum:
{
OS: Kubelet will use the OS disk for its data. ,
Temporary: Kubelet will use the temporary disk for its data. ,
}
,
Required: False ,
}
enum ,
workloadRuntime:
{
Description: Determines the type of workload a node can run. ,
Enum:
{
OCIContainer: Nodes will use Kubelet to run standard OCI container workloads. ,
WasmWasi: Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview). ,
}
,
Required: False ,
}
enum ,
messageOfTheDay:
{
Description: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). ,
Required: False ,
}
string ,
vnetSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
podSubnetID:
{
Description: 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} ,
Format: arm-id ,
Required: False ,
}
string ,
maxPods:
{
Description: The maximum number of pods that can run on a node. ,
Format: int32 ,
Required: False ,
}
integer ,
osType:
{
Description: The operating system type. The default is Linux. ,
Enum:
{
Linux: Use Linux. ,
Windows: Use Windows. ,
}
,
Required: False ,
}
enum ,
osSKU:
{
Description: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. ,
Enum:
{
Ubuntu: Use Ubuntu as the OS for node images. ,
CBLMariner: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead. ,
AzureLinux: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. ,
Windows2019: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa. ,
Windows2022: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa. ,
}
,
Required: False ,
}
enum ,
maxCount:
{
Description: The maximum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
minCount:
{
Description: The minimum number of nodes for auto-scaling ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScaling:
{
Description: Whether to enable auto-scaler ,
Required: False ,
}
boolean ,
scaleDownMode:
{
Description: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. ,
Enum:
{
Delete: Create new instances during scale up and remove instances during scale down. ,
Deallocate: Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type of Agent Pool. ,
Enum:
{
VirtualMachineScaleSets: Create an Agent Pool backed by a Virtual Machine Scale Set. ,
AvailabilitySet: Use of this is strongly discouraged. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools ,
Enum:
{
System: System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory. ,
User: User agent pools are primarily for hosting your application pods. ,
}
,
Required: False ,
}
enum ,
orchestratorVersion:
{
Description: Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). ,
Required: False ,
}
string ,
currentOrchestratorVersion:
{
Description: If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. ,
Required: False ,
}
string ,
nodeImageVersion:
{
Description: The version of node image ,
Required: False ,
}
string ,
upgradeSettings:
{
Description: Settings for upgrading the agentpool ,
Required: False ,
}
{
maxSurge:
{
Description: 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 10%. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ,
Required: False ,
}
string ,
drainTimeoutInMinutes:
{
Description: The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeSoakDurationInMinutes:
{
Description: The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: The current deployment or provisioning state. ,
Required: False ,
}
string ,
powerState:
{
Description: When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded ,
Required: False ,
}
{
code:
{
Description: Tells whether the cluster is Running or Stopped ,
Enum:
{
Running: The cluster is running. ,
Stopped: The cluster is stopped. ,
}
,
Required: False ,
}
enum ,
}
,
availabilityZones:
{
Description: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. ,
Required: False ,
}
[
string ,
]
,
enableNodePublicIP:
{
Description: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. ,
Required: False ,
}
boolean ,
nodePublicIPPrefixID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} ,
Format: arm-id ,
Required: False ,
}
string ,
scaleSetPriority:
{
Description: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. ,
Enum:
{
Spot: Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information. ,
Regular: Regular VMs will be used. ,
}
,
Required: False ,
}
enum ,
scaleSetEvictionPolicy:
{
Description: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. ,
Enum:
{
Delete: Nodes in the underlying Scale Set of the node pool are deleted when they're evicted. ,
Deallocate: Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading. ,
}
,
Required: False ,
}
enum ,
spotMaxPrice:
{
Description: 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) ,
Required: False ,
}
number ,
tags:
{
Description: The tags to be persisted on the agent pool virtual machine scale set. ,
Required: False ,
}
object ,
nodeLabels:
{
Description: The node labels to be persisted across all nodes in agent pool. ,
Required: False ,
}
object ,
nodeTaints:
{
Description: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. ,
Required: False ,
}
[
string ,
]
,
proximityPlacementGroupID:
{
Description: The ID for Proximity Placement Group. ,
Format: arm-id ,
Required: False ,
}
string ,
kubeletConfig:
{
Description: The Kubelet configuration on the agent pool nodes. ,
Required: False ,
}
{
cpuManagerPolicy:
{
Description: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. ,
Required: False ,
}
string ,
cpuCfsQuota:
{
Description: The default is true. ,
Required: False ,
}
boolean ,
cpuCfsQuotaPeriod:
{
Description: 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'. ,
Required: False ,
}
string ,
imageGcHighThreshold:
{
Description: To disable image garbage collection, set to 100. The default is 85% ,
Format: int32 ,
Required: False ,
}
integer ,
imageGcLowThreshold:
{
Description: This cannot be set higher than imageGcHighThreshold. The default is 80% ,
Format: int32 ,
Required: False ,
}
integer ,
topologyManagerPolicy:
{
Description: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. ,
Required: False ,
}
string ,
allowedUnsafeSysctls:
{
Description: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). ,
Required: False ,
}
[
string ,
]
,
failSwapOn:
{
Description: If set to true it will make the Kubelet fail to start if swap is enabled on the node. ,
Required: False ,
}
boolean ,
containerLogMaxSizeMB:
{
Description: The maximum size (e.g. 10Mi) of container log file before it is rotated. ,
Format: int32 ,
Required: False ,
}
integer ,
containerLogMaxFiles:
{
Description: The maximum number of container log files that can be present for a container. The number must be ≥ 2. ,
Format: int32 ,
Required: False ,
}
integer ,
podMaxPids:
{
Description: The maximum number of processes per pod. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
linuxOSConfig:
{
Description: The OS configuration of Linux agent nodes. ,
Required: False ,
}
{
sysctls:
{
Description: Sysctl settings for Linux agent nodes. ,
Required: False ,
}
{
netCoreSomaxconn:
{
Description: Sysctl setting net.core.somaxconn. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreNetdevMaxBacklog:
{
Description: Sysctl setting net.core.netdev_max_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemDefault:
{
Description: Sysctl setting net.core.rmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreRmemMax:
{
Description: Sysctl setting net.core.rmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemDefault:
{
Description: Sysctl setting net.core.wmem_default. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreWmemMax:
{
Description: Sysctl setting net.core.wmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netCoreOptmemMax:
{
Description: Sysctl setting net.core.optmem_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxSynBacklog:
{
Description: Sysctl setting net.ipv4.tcp_max_syn_backlog. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpMaxTwBuckets:
{
Description: Sysctl setting net.ipv4.tcp_max_tw_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpFinTimeout:
{
Description: Sysctl setting net.ipv4.tcp_fin_timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveTime:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_time. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpKeepaliveProbes:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_probes. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpkeepaliveIntvl:
{
Description: Sysctl setting net.ipv4.tcp_keepalive_intvl. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4TcpTwReuse:
{
Description: Sysctl setting net.ipv4.tcp_tw_reuse. ,
Required: False ,
}
boolean ,
netIpv4IpLocalPortRange:
{
Description: Sysctl setting net.ipv4.ip_local_port_range. ,
Required: False ,
}
string ,
netIpv4NeighDefaultGcThresh1:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh1. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh2:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh2. ,
Format: int32 ,
Required: False ,
}
integer ,
netIpv4NeighDefaultGcThresh3:
{
Description: Sysctl setting net.ipv4.neigh.default.gc_thresh3. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackMax:
{
Description: Sysctl setting net.netfilter.nf_conntrack_max. ,
Format: int32 ,
Required: False ,
}
integer ,
netNetfilterNfConntrackBuckets:
{
Description: Sysctl setting net.netfilter.nf_conntrack_buckets. ,
Format: int32 ,
Required: False ,
}
integer ,
fsInotifyMaxUserWatches:
{
Description: Sysctl setting fs.inotify.max_user_watches. ,
Format: int32 ,
Required: False ,
}
integer ,
fsFileMax:
{
Description: Sysctl setting fs.file-max. ,
Format: int32 ,
Required: False ,
}
integer ,
fsAioMaxNr:
{
Description: Sysctl setting fs.aio-max-nr. ,
Format: int32 ,
Required: False ,
}
integer ,
fsNrOpen:
{
Description: Sysctl setting fs.nr_open. ,
Format: int32 ,
Required: False ,
}
integer ,
kernelThreadsMax:
{
Description: Sysctl setting kernel.threads-max. ,
Format: int32 ,
Required: False ,
}
integer ,
vmMaxMapCount:
{
Description: Sysctl setting vm.max_map_count. ,
Format: int32 ,
Required: False ,
}
integer ,
vmSwappiness:
{
Description: Sysctl setting vm.swappiness. ,
Format: int32 ,
Required: False ,
}
integer ,
vmVfsCachePressure:
{
Description: Sysctl setting vm.vfs_cache_pressure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
transparentHugePageEnabled:
{
Description: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
transparentHugePageDefrag:
{
Description: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). ,
Required: False ,
}
string ,
swapFileSizeMB:
{
Description: The size in MB of a swap file that will be created on each node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
enableEncryptionAtHost:
{
Description: 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 ,
Required: False ,
}
boolean ,
enableUltraSSD:
{
Description: Whether to enable UltraSSD ,
Required: False ,
}
boolean ,
enableFIPS:
{
Description: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. ,
Required: False ,
}
boolean ,
gpuInstanceProfile:
{
Description: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. ,
Enum:
{
MIG1g: No description available. ,
MIG2g: No description available. ,
MIG3g: No description available. ,
MIG4g: No description available. ,
MIG7g: No description available. ,
}
,
Required: False ,
}
enum ,
creationData:
{
Description: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. ,
Required: False ,
}
{
sourceResourceId:
{
Description: This is the ARM ID of the source object to be used to create the target object. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
capacityReservationGroupID:
{
Description: AKS will associate the specified agent pool with the Capacity Reservation Group. ,
Format: arm-id ,
Required: False ,
}
string ,
hostGroupID:
{
Description: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). ,
Format: arm-id ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network-related settings of an agent pool. ,
Required: False ,
}
{
nodePublicIPTags:
{
Description: IPTags of instance-level public IPs. ,
Required: False ,
}
[
{
ipTagType:
{
Description: The IP tag type. Example: RoutingPreference. ,
Required: False ,
}
string ,
tag:
{
Description: The value of the IP tag associated with the public IP. Example: Internet. ,
Required: False ,
}
string ,
}
,
]
,
allowedHostPorts:
{
Description: The port ranges that are allowed to access. The specified ranges are allowed to overlap. ,
Required: False ,
}
[
{
portStart:
{
Description: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. ,
Format: int32 ,
Required: False ,
}
integer ,
portEnd:
{
Description: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The network protocol of the port. ,
Enum:
{
TCP: TCP protocol. ,
UDP: UDP protocol. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
applicationSecurityGroups:
{
Description: The IDs of the application security groups which agent pool will associate when created. ,
Required: False ,
}
[
string ,
]
,
}
,
windowsProfile:
{
Description: The Windows agent pool's specific profile. ,
Required: False ,
}
{
disableOutboundNat:
{
Description: The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: The security settings of an agent pool. ,
Required: False ,
}
{
enableVTPM:
{
Description: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
enableSecureBoot:
{
Description: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details about the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}