IManagedClusterAgentPoolProfile Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.ManagedClusterAgentPoolProfileTypeConverter))]
public interface IManagedClusterAgentPoolProfile : Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.IManagedClusterAgentPoolProfileProperties[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.Api20230201.ManagedClusterAgentPoolProfileTypeConverter))>]
type IManagedClusterAgentPoolProfile = interface
interface IJsonSerializable
interface IManagedClusterAgentPoolProfilePropertiesPublic Interface IManagedClusterAgentPoolProfile
Implements IManagedClusterAgentPoolProfileProperties- Derived
- Attributes
- Implements
Properties
| AvailabilityZone |
The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| Count |
Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| CreationDataSourceResourceId |
This is the ARM ID of the source object to be used to create the target object. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| CurrentOrchestratorVersion | (Inherited from IManagedClusterAgentPoolProfileProperties) |
| EnableAutoScaling |
Whether to enable auto-scaler (Inherited from IManagedClusterAgentPoolProfileProperties) |
| EnableEncryptionAtHost |
This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption (Inherited from IManagedClusterAgentPoolProfileProperties) |
| EnableFips |
See Add a FIPS-enabled node pool for more details. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| EnableNodePublicIP |
Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| EnableUltraSsd |
Whether to enable UltraSSD (Inherited from IManagedClusterAgentPoolProfileProperties) |
| GpuInstanceProfile |
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| HostGroupId |
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigAllowedUnsafeSysctl |
Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in |
| KubeletConfigContainerLogMaxFile |
The maximum number of container log files that can be present for a container. The number must be ≥ 2. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigContainerLogMaxSizeMb |
The maximum size (e.g. 10Mi) of container log file before it is rotated. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigCpuCfsQuota |
The default is true. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigCpuCfsQuotaPeriod |
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'. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigCpuManagerPolicy |
The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigFailSwapOn |
If set to true it will make the Kubelet fail to start if swap is enabled on the node. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigImageGcHighThreshold |
To disable image garbage collection, set to 100. The default is 85% (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigImageGcLowThreshold |
This cannot be set higher than imageGcHighThreshold. The default is 80% (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigPodMaxPid |
The maximum number of processes per pod. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletConfigTopologyManagerPolicy |
For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| KubeletDiskType |
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| LinuxOSConfigSwapFileSizeMb |
The size in MB of a swap file that will be created on each node. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| LinuxOSConfigSysctl |
Sysctl settings for Linux agent nodes. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| LinuxOSConfigTransparentHugePageDefrag |
Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| LinuxOSConfigTransparentHugePageEnabled |
Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| MaxCount |
The maximum number of nodes for auto-scaling (Inherited from IManagedClusterAgentPoolProfileProperties) |
| MaxPod |
The maximum number of pods that can run on a node. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| MinCount |
The minimum number of nodes for auto-scaling (Inherited from IManagedClusterAgentPoolProfileProperties) |
| Mode |
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 (Inherited from IManagedClusterAgentPoolProfileProperties) |
| Name |
Windows agent pool names must be 6 characters or less. |
| NodeImageVersion |
The version of node image (Inherited from IManagedClusterAgentPoolProfileProperties) |
| NodeLabel |
The node labels to be persisted across all nodes in agent pool. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| NodePublicIPPrefixId |
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} (Inherited from IManagedClusterAgentPoolProfileProperties) |
| NodeTaint |
The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| OrchestratorVersion | (Inherited from IManagedClusterAgentPoolProfileProperties) |
| OSDiskSizeGb |
OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| OSDiskType |
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. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| OSSku | (Inherited from IManagedClusterAgentPoolProfileProperties) |
| OSType |
The operating system type. The default is Linux. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| PodSubnetId |
If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} (Inherited from IManagedClusterAgentPoolProfileProperties) |
| PowerStateCode |
Tells whether the cluster is Running or Stopped (Inherited from IManagedClusterAgentPoolProfileProperties) |
| ProvisioningState |
The current deployment or provisioning state. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| ProximityPlacementGroupId |
The ID for Proximity Placement Group. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| ScaleDownMode |
This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| ScaleSetEvictionPolicy |
This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| ScaleSetPriority |
The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| SpotMaxPrice |
Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing (Inherited from IManagedClusterAgentPoolProfileProperties) |
| Tag |
The tags to be persisted on the agent pool virtual machine scale set. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| Type |
The type of Agent Pool. (Inherited from IManagedClusterAgentPoolProfileProperties) |
| UpgradeSettingMaxSurge |
This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade (Inherited from IManagedClusterAgentPoolProfileProperties) |
| VMSize |
VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions (Inherited from IManagedClusterAgentPoolProfileProperties) |
| VnetSubnetId |
If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} (Inherited from IManagedClusterAgentPoolProfileProperties) |
| WorkloadRuntime |
Determines the type of workload a node can run. (Inherited from IManagedClusterAgentPoolProfileProperties) |
Methods
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |