Partager via

ManagedClusterAgentPoolProfile Constructors

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.ContainerService.Models
Assembly:
Microsoft.Azure.PowerShell.Aks.Management.Sdk.dll

Overloads

ManagedClusterAgentPoolProfile()

Initializes a new instance of the ManagedClusterAgentPoolProfile class.
ManagedClusterAgentPoolProfile(String, Nullable<Int32>, String, Nullable<Int32>, String, String, String, String, String, Nullable<Int32>, String, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, String, String, String, AgentPoolUpgradeSettings, String, PowerState, IList<String>, Nullable<Boolean>, String, String, String, Nullable<Double>, IDictionary<String,String>, IDictionary<String,String>, IList<String>, String, KubeletConfig, LinuxOSConfig, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, CreationData, String)

Initializes a new instance of the ManagedClusterAgentPoolProfile class.

ManagedClusterAgentPoolProfile()

Initializes a new instance of the ManagedClusterAgentPoolProfile class.

public ManagedClusterAgentPoolProfile ();
Public Sub New ()

Applies to

ManagedClusterAgentPoolProfile(String, Nullable<Int32>, String, Nullable<Int32>, String, String, String, String, String, Nullable<Int32>, String, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, String, String, String, AgentPoolUpgradeSettings, String, PowerState, IList<String>, Nullable<Boolean>, String, String, String, Nullable<Double>, IDictionary<String,String>, IDictionary<String,String>, IList<String>, String, KubeletConfig, LinuxOSConfig, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, CreationData, String)

Initializes a new instance of the ManagedClusterAgentPoolProfile class.

public ManagedClusterAgentPoolProfile (string name, int? count = default, string vmSize = default, int? osDiskSizeGb = default, string osDiskType = default, string kubeletDiskType = default, string workloadRuntime = default, string vnetSubnetId = default, string podSubnetId = default, int? maxPods = default, string osType = default, string osSku = default, int? maxCount = default, int? minCount = default, bool? enableAutoScaling = default, string scaleDownMode = default, string type = default, string mode = default, string orchestratorVersion = default, string currentOrchestratorVersion = default, string nodeImageVersion = default, Microsoft.Azure.Management.ContainerService.Models.AgentPoolUpgradeSettings upgradeSettings = default, string provisioningState = default, Microsoft.Azure.Management.ContainerService.Models.PowerState powerState = default, System.Collections.Generic.IList<string> availabilityZones = default, bool? enableNodePublicIP = default, string nodePublicIPPrefixId = default, string scaleSetPriority = default, string scaleSetEvictionPolicy = default, double? spotMaxPrice = default, System.Collections.Generic.IDictionary<string,string> tags = default, System.Collections.Generic.IDictionary<string,string> nodeLabels = default, System.Collections.Generic.IList<string> nodeTaints = default, string proximityPlacementGroupId = default, Microsoft.Azure.Management.ContainerService.Models.KubeletConfig kubeletConfig = default, Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig linuxOSConfig = default, bool? enableEncryptionAtHost = default, bool? enableUltraSsd = default, bool? enableFips = default, string gpuInstanceProfile = default, Microsoft.Azure.Management.ContainerService.Models.CreationData creationData = default, string hostGroupId = default);
new Microsoft.Azure.Management.ContainerService.Models.ManagedClusterAgentPoolProfile : string * Nullable<int> * string * Nullable<int> * string * string * string * string * string * Nullable<int> * string * string * Nullable<int> * Nullable<int> * Nullable<bool> * string * string * string * string * string * string * Microsoft.Azure.Management.ContainerService.Models.AgentPoolUpgradeSettings * string * Microsoft.Azure.Management.ContainerService.Models.PowerState * System.Collections.Generic.IList<string> * Nullable<bool> * string * string * string * Nullable<double> * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IList<string> * string * Microsoft.Azure.Management.ContainerService.Models.KubeletConfig * Microsoft.Azure.Management.ContainerService.Models.LinuxOSConfig * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * Microsoft.Azure.Management.ContainerService.Models.CreationData * string -> Microsoft.Azure.Management.ContainerService.Models.ManagedClusterAgentPoolProfile
Public Sub New (name As String, Optional count As Nullable(Of Integer) = Nothing, Optional vmSize As String = Nothing, Optional osDiskSizeGb As Nullable(Of Integer) = Nothing, Optional osDiskType As String = Nothing, Optional kubeletDiskType As String = Nothing, Optional workloadRuntime As String = Nothing, Optional vnetSubnetId As String = Nothing, Optional podSubnetId As String = Nothing, Optional maxPods As Nullable(Of Integer) = Nothing, Optional osType As String = Nothing, Optional osSku As String = Nothing, Optional maxCount As Nullable(Of Integer) = Nothing, Optional minCount As Nullable(Of Integer) = Nothing, Optional enableAutoScaling As Nullable(Of Boolean) = Nothing, Optional scaleDownMode As String = Nothing, Optional type As String = Nothing, Optional mode As String = Nothing, Optional orchestratorVersion As String = Nothing, Optional currentOrchestratorVersion As String = Nothing, Optional nodeImageVersion As String = Nothing, Optional upgradeSettings As AgentPoolUpgradeSettings = Nothing, Optional provisioningState As String = Nothing, Optional powerState As PowerState = Nothing, Optional availabilityZones As IList(Of String) = Nothing, Optional enableNodePublicIP As Nullable(Of Boolean) = Nothing, Optional nodePublicIPPrefixId As String = Nothing, Optional scaleSetPriority As String = Nothing, Optional scaleSetEvictionPolicy As String = Nothing, Optional spotMaxPrice As Nullable(Of Double) = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional nodeLabels As IDictionary(Of String, String) = Nothing, Optional nodeTaints As IList(Of String) = Nothing, Optional proximityPlacementGroupId As String = Nothing, Optional kubeletConfig As KubeletConfig = Nothing, Optional linuxOSConfig As LinuxOSConfig = Nothing, Optional enableEncryptionAtHost As Nullable(Of Boolean) = Nothing, Optional enableUltraSsd As Nullable(Of Boolean) = Nothing, Optional enableFips As Nullable(Of Boolean) = Nothing, Optional gpuInstanceProfile As String = Nothing, Optional creationData As CreationData = Nothing, Optional hostGroupId As String = Nothing)

Parameters

name
String

Windows agent pool names must be 6 characters or less.

count
Nullable<Int32>

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.

vmSize
String

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

osDiskSizeGb
Nullable<Int32>

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.

osDiskType
String

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. Possible values include: 'Managed', 'Ephemeral'

kubeletDiskType
String

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Possible values include: 'OS', 'Temporary'

workloadRuntime
String

Determines the type of workload a node can run. Possible values include: 'OCIContainer', 'WasmWasi'

vnetSubnetId
String

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}

podSubnetId
String

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}

maxPods
Nullable<Int32>

The maximum number of pods that can run on a node.

osType
String

The operating system type. The default is Linux. Possible values include: 'Linux', 'Windows'

osSku
String

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. Possible values include: 'Ubuntu', 'AzureLinux', 'CBLMariner', 'Windows2019', 'Windows2022'

maxCount
Nullable<Int32>

The maximum number of nodes for auto-scaling

minCount
Nullable<Int32>

The minimum number of nodes for auto-scaling

enableAutoScaling
Nullable<Boolean>

Whether to enable auto-scaler

scaleDownMode
String

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. Possible values include: 'Delete', 'Deallocate'

type
String

The type of Agent Pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet'

mode
String

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 Possible values include: 'System', 'User'

orchestratorVersion
String

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.

currentOrchestratorVersion
String

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.

nodeImageVersion
String

The version of node image

upgradeSettings
AgentPoolUpgradeSettings

Settings for upgrading the agentpool

provisioningState
String

The current deployment or provisioning state.

powerState
PowerState

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

availabilityZones
IList<String>

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

enableNodePublicIP
Nullable<Boolean>

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.

nodePublicIPPrefixId
String

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

scaleSetPriority
String

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. Possible values include: 'Spot', 'Regular'

scaleSetEvictionPolicy
String

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. Possible values include: 'Delete', 'Deallocate'

spotMaxPrice
Nullable<Double>

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

tags
IDictionary<String,String>

The tags to be persisted on the agent pool virtual machine scale set.

nodeLabels
IDictionary<String,String>

The node labels to be persisted across all nodes in agent pool.

nodeTaints
IList<String>

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

proximityPlacementGroupId
String

The ID for Proximity Placement Group.

kubeletConfig
KubeletConfig

The Kubelet configuration on the agent pool nodes.

linuxOSConfig
LinuxOSConfig

The OS configuration of Linux agent nodes.

enableEncryptionAtHost
Nullable<Boolean>

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

enableUltraSsd
Nullable<Boolean>

Whether to enable UltraSSD

enableFips
Nullable<Boolean>

See Add a FIPS-enabled node pool for more details.

gpuInstanceProfile
String

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. Possible values include: 'MIG1g', 'MIG2g', 'MIG3g', 'MIG4g', 'MIG7g'

creationData
CreationData

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

hostGroupId
String

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

Applies to