Get
Agent Pool.
Constructors
Properties
The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
The Azure API version of the resource.
AKS will associate the specified agent pool with the Capacity Reservation Group.
CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
If orchestratorVersion is a fully specified version
Whether to enable auto-scaler
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
See Add a FIPS-enabled node pool for more details.
Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.
Whether to enable UltraSSD
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.
The Kubelet configuration on the agent pool nodes.
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
The OS configuration of Linux agent nodes.
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).
Network-related settings of an agent pool.
The version of node image
The node labels to be persisted across all nodes in agent pool.
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
Both patch version
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.
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.
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}
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
The current deployment or provisioning state.
The ID for Proximity Placement Group.
This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
The security settings of an agent pool.
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
Settings for upgrading the agentpool
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
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}
The Windows agent pool's specific profile.
Determines the type of workload a node can run.