ManagedClusterAgentPoolProfileProperties Class

Initializes a new instance of ManagedClusterAgentPoolProfileProperties.

The type of Agent Pool. Serialized Name: ManagedClusterAgentPoolProfileProperties.type

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. Serialized Name: ManagedClusterAgentPoolProfileProperties.availabilityZones

AKS will associate the specified agent pool with the Capacity Reservation Group. Serialized Name: ManagedClusterAgentPoolProfileProperties.capacityReservationGroupID

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. Serialized Name: ManagedClusterAgentPoolProfileProperties.count

This is the ARM ID of the source object to be used to create the target object. Serialized Name: CreationData.sourceResourceId

The version of Kubernetes the Agent Pool is running. If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used. Serialized Name: ManagedClusterAgentPoolProfileProperties.currentOrchestratorVersion

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.

Whether to enable auto-scaler Serialized Name: ManagedClusterAgentPoolProfileProperties.enableAutoScaling

When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false.

Whether to enable host based OS and data drive encryption. 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 Serialized Name: ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost

Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details. Serialized Name: ManagedClusterAgentPoolProfileProperties.enableFIPS

Whether each node is allocated its own public IP. 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. Serialized Name: ManagedClusterAgentPoolProfileProperties.enableNodePublicIP

Whether to enable UltraSSD Serialized Name: ManagedClusterAgentPoolProfileProperties.enableUltraSSD

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. Serialized Name: ManagedClusterAgentPoolProfileProperties.eTag

The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31. Serialized Name: AgentPoolGatewayProfile.publicIPPrefixSize

Whether to install GPU drivers. When it's not specified, default is Install. Serialized Name: GPUProfile.driver

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. Serialized Name: ManagedClusterAgentPoolProfileProperties.gpuInstanceProfile

The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. Serialized Name: ManagedClusterAgentPoolProfileProperties.hostGroupID

Whether to disable OutboundNAT in windows nodes. 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. Serialized Name: AgentPoolWindowsProfile.disableOutboundNat

The Kubelet configuration on the agent pool nodes. Serialized Name: ManagedClusterAgentPoolProfileProperties.kubeletConfig

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Serialized Name: ManagedClusterAgentPoolProfileProperties.kubeletDiskType

The OS configuration of Linux agent nodes. Serialized Name: ManagedClusterAgentPoolProfileProperties.linuxOSConfig

Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns. Serialized Name: ManagedClusterAgentPoolProfileProperties.localDNSProfile

The maximum number of nodes for auto-scaling Serialized Name: ManagedClusterAgentPoolProfileProperties.maxCount

The maximum number of pods that can run on a node. Serialized Name: ManagedClusterAgentPoolProfileProperties.maxPods

Message of the day for Linux nodes, base64-encoded. 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). Serialized Name: ManagedClusterAgentPoolProfileProperties.messageOfTheDay

The minimum number of nodes for auto-scaling Serialized Name: ManagedClusterAgentPoolProfileProperties.minCount

The mode of an agent pool. 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 Serialized Name: ManagedClusterAgentPoolProfileProperties.mode

Network-related settings of an agent pool. Serialized Name: ManagedClusterAgentPoolProfileProperties.networkProfile

The version of node image Serialized Name: ManagedClusterAgentPoolProfileProperties.nodeImageVersion

The node labels to be persisted across all nodes in agent pool. Serialized Name: ManagedClusterAgentPoolProfileProperties.nodeLabels

The public IP prefix ID which VM nodes should use IPs from. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} Serialized Name: ManagedClusterAgentPoolProfileProperties.nodePublicIPPrefixID

The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. Serialized Name: ManagedClusterAgentPoolProfileProperties.nodeTaints

The version of Kubernetes specified by the user. Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> 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. Serialized Name: ManagedClusterAgentPoolProfileProperties.orchestratorVersion

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. Serialized Name: ManagedClusterAgentPoolProfileProperties.osDiskSizeGB

The OS disk type to be used for machines in the agent pool. 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. Serialized Name: ManagedClusterAgentPoolProfileProperties.osDiskType

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. Serialized Name: ManagedClusterAgentPoolProfileProperties.osSKU

The operating system type. The default is Linux. Serialized Name: ManagedClusterAgentPoolProfileProperties.osType

Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'. Serialized Name: ManagedClusterAgentPoolProfileProperties.podIPAllocationMode

The ID of the subnet which pods will join when launched. 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} Serialized Name: ManagedClusterAgentPoolProfileProperties.podSubnetID

Tells whether the cluster is Running or Stopped Serialized Name: PowerState.code

The current deployment or provisioning state. Serialized Name: ManagedClusterAgentPoolProfileProperties.provisioningState

The ID for Proximity Placement Group. Serialized Name: ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID

The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. Serialized Name: ManagedClusterAgentPoolProfileProperties.scaleDownMode

Specifications on how to scale the VirtualMachines agent pool to a fixed size. Serialized Name: ScaleProfile.manual

The Virtual Machine Scale Set eviction policy to use. This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. Serialized Name: ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. Serialized Name: ManagedClusterAgentPoolProfileProperties.scaleSetPriority

The security settings of an agent pool. Serialized Name: ManagedClusterAgentPoolProfileProperties.securityProfile

The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. 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 Serialized Name: ManagedClusterAgentPoolProfileProperties.spotMaxPrice

The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted. Serialized Name: AgentPoolStatus.provisioningError

The tags to be persisted on the agent pool virtual machine scale set. Serialized Name: ManagedClusterAgentPoolProfileProperties.tags

Settings for upgrading the agentpool Serialized Name: ManagedClusterAgentPoolProfileProperties.upgradeSettings

The status of nodes in a VirtualMachines agent pool. Serialized Name: ManagedClusterAgentPoolProfileProperties.virtualMachineNodesStatus

The size of the agent pool VMs. 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 Serialized Name: ManagedClusterAgentPoolProfileProperties.vmSize

The ID of the subnet which agent pool nodes and optionally pods will join on startup. 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} Serialized Name: ManagedClusterAgentPoolProfileProperties.vnetSubnetID

Determines the type of workload a node can run. Serialized Name: ManagedClusterAgentPoolProfileProperties.workloadRuntime

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Writes the model to the provided Utf8JsonWriter.

Converts the provided BinaryData into a model.

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Writes the model into a BinaryData.