ArmContainerServiceModelFactory.ContainerServiceAgentPoolData Method
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.
Overloads
ContainerServiceAgentPoolData(ResourceIdentifier, String, ResourceType, SystemData, Nullable<Int32>, String, Nullable<Int32>, Nullable<ContainerServiceOSDiskType>, Nullable<KubeletDiskType>, Nullable<WorkloadRuntime>, ResourceIdentifier, ResourceIdentifier, Nullable<Int32>, Nullable<ContainerServiceOSType>, Nullable<ContainerServiceOSSku>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<ScaleDownMode>, Nullable<AgentPoolType>, Nullable<AgentPoolMode>, String, String, String, AgentPoolUpgradeSettings, String, Nullable<ContainerServiceStateCode>, IEnumerable<String>, Nullable<Boolean>, ResourceIdentifier, Nullable<ScaleSetPriority>, Nullable<ScaleSetEvictionPolicy>, Nullable<Single>, IDictionary<String, String>, IDictionary<String,String>, IEnumerable<String>, ResourceIdentifier, KubeletConfig, LinuxOSConfig, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<GpuInstanceProfile>, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, AgentPoolNetworkProfile)
Initializes a new instance of ContainerServiceAgentPoolData.
public static Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolData ContainerServiceAgentPoolData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, int? count = default, string vmSize = default, int? osDiskSizeInGB = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceOSDiskType? osDiskType = default, Azure.ResourceManager.ContainerService.Models.KubeletDiskType? kubeletDiskType = default, Azure.ResourceManager.ContainerService.Models.WorkloadRuntime? workloadRuntime = default, Azure.Core.ResourceIdentifier vnetSubnetId = default, Azure.Core.ResourceIdentifier podSubnetId = default, int? maxPods = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceOSType? osType = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceOSSku? osSku = default, int? maxCount = default, int? minCount = default, bool? enableAutoScaling = default, Azure.ResourceManager.ContainerService.Models.ScaleDownMode? scaleDownMode = default, Azure.ResourceManager.ContainerService.Models.AgentPoolType? typePropertiesType = default, Azure.ResourceManager.ContainerService.Models.AgentPoolMode? mode = default, string orchestratorVersion = default, string currentOrchestratorVersion = default, string nodeImageVersion = default, Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings upgradeSettings = default, string provisioningState = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceStateCode? powerStateCode = default, System.Collections.Generic.IEnumerable<string> availabilityZones = default, bool? enableNodePublicIP = default, Azure.Core.ResourceIdentifier nodePublicIPPrefixId = default, Azure.ResourceManager.ContainerService.Models.ScaleSetPriority? scaleSetPriority = default, Azure.ResourceManager.ContainerService.Models.ScaleSetEvictionPolicy? scaleSetEvictionPolicy = default, float? spotMaxPrice = default, System.Collections.Generic.IDictionary<string,string> tags = default, System.Collections.Generic.IDictionary<string,string> nodeLabels = default, System.Collections.Generic.IEnumerable<string> nodeTaints = default, Azure.Core.ResourceIdentifier proximityPlacementGroupId = default, Azure.ResourceManager.ContainerService.Models.KubeletConfig kubeletConfig = default, Azure.ResourceManager.ContainerService.Models.LinuxOSConfig linuxOSConfig = default, bool? enableEncryptionAtHost = default, bool? enableUltraSsd = default, bool? enableFips = default, Azure.ResourceManager.ContainerService.Models.GpuInstanceProfile? gpuInstanceProfile = default, Azure.Core.ResourceIdentifier creationDataSourceResourceId = default, Azure.Core.ResourceIdentifier capacityReservationGroupId = default, Azure.Core.ResourceIdentifier hostGroupId = default, Azure.ResourceManager.ContainerService.Models.AgentPoolNetworkProfile networkProfile = default);static member ContainerServiceAgentPoolData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * Nullable<int> * string * Nullable<int> * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceOSDiskType> * Nullable<Azure.ResourceManager.ContainerService.Models.KubeletDiskType> * Nullable<Azure.ResourceManager.ContainerService.Models.WorkloadRuntime> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Nullable<int> * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceOSType> * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceOSSku> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<Azure.ResourceManager.ContainerService.Models.ScaleDownMode> * Nullable<Azure.ResourceManager.ContainerService.Models.AgentPoolType> * Nullable<Azure.ResourceManager.ContainerService.Models.AgentPoolMode> * string * string * string * Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings * string * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceStateCode> * seq<string> * Nullable<bool> * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.ContainerService.Models.ScaleSetPriority> * Nullable<Azure.ResourceManager.ContainerService.Models.ScaleSetEvictionPolicy> * Nullable<single> * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, string> * seq<string> * Azure.Core.ResourceIdentifier * Azure.ResourceManager.ContainerService.Models.KubeletConfig * Azure.ResourceManager.ContainerService.Models.LinuxOSConfig * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.ContainerService.Models.GpuInstanceProfile> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.ResourceManager.ContainerService.Models.AgentPoolNetworkProfile -> Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolDataPublic Shared Function ContainerServiceAgentPoolData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional vmSize As String = Nothing, Optional osDiskSizeInGB As Nullable(Of Integer) = Nothing, Optional osDiskType As Nullable(Of ContainerServiceOSDiskType) = Nothing, Optional kubeletDiskType As Nullable(Of KubeletDiskType) = Nothing, Optional workloadRuntime As Nullable(Of WorkloadRuntime) = Nothing, Optional vnetSubnetId As ResourceIdentifier = Nothing, Optional podSubnetId As ResourceIdentifier = Nothing, Optional maxPods As Nullable(Of Integer) = Nothing, Optional osType As Nullable(Of ContainerServiceOSType) = Nothing, Optional osSku As Nullable(Of ContainerServiceOSSku) = 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 Nullable(Of ScaleDownMode) = Nothing, Optional typePropertiesType As Nullable(Of AgentPoolType) = Nothing, Optional mode As Nullable(Of AgentPoolMode) = 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 powerStateCode As Nullable(Of ContainerServiceStateCode) = Nothing, Optional availabilityZones As IEnumerable(Of String) = Nothing, Optional enableNodePublicIP As Nullable(Of Boolean) = Nothing, Optional nodePublicIPPrefixId As ResourceIdentifier = Nothing, Optional scaleSetPriority As Nullable(Of ScaleSetPriority) = Nothing, Optional scaleSetEvictionPolicy As Nullable(Of ScaleSetEvictionPolicy) = Nothing, Optional spotMaxPrice As Nullable(Of Single) = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional nodeLabels As IDictionary(Of String, String) = Nothing, Optional nodeTaints As IEnumerable(Of String) = Nothing, Optional proximityPlacementGroupId As ResourceIdentifier = 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 Nullable(Of GpuInstanceProfile) = Nothing, Optional creationDataSourceResourceId As ResourceIdentifier = Nothing, Optional capacityReservationGroupId As ResourceIdentifier = Nothing, Optional hostGroupId As ResourceIdentifier = Nothing, Optional networkProfile As AgentPoolNetworkProfile = Nothing) As ContainerServiceAgentPoolDataParameters
The id.
- name
- String
The name.
- resourceType
- ResourceType
The resourceType.
- systemData
- SystemData
The systemData.
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.
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
- Nullable<ContainerServiceOSDiskType>
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.
- kubeletDiskType
- Nullable<KubeletDiskType>
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
- workloadRuntime
- Nullable<WorkloadRuntime>
Determines the type of workload a node can run.
- vnetSubnetId
- ResourceIdentifier
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
- ResourceIdentifier
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}.
- osType
- Nullable<ContainerServiceOSType>
The operating system type. The default is Linux.
- osSku
- Nullable<ContainerServiceOSSku>
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.
- scaleDownMode
- Nullable<ScaleDownMode>
This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
- typePropertiesType
- Nullable<AgentPoolType>
The type of Agent Pool.
- mode
- Nullable<AgentPoolMode>
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.
- 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.
- powerStateCode
- Nullable<ContainerServiceStateCode>
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
- IEnumerable<String>
The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
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
- ResourceIdentifier
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}.
- scaleSetPriority
- Nullable<ScaleSetPriority>
The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
- scaleSetEvictionPolicy
- Nullable<ScaleSetEvictionPolicy>
This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
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
- IEnumerable<String>
The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
- proximityPlacementGroupId
- ResourceIdentifier
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.
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.
- gpuInstanceProfile
- Nullable<GpuInstanceProfile>
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
- creationDataSourceResourceId
- ResourceIdentifier
CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
- capacityReservationGroupId
- ResourceIdentifier
AKS will associate the specified agent pool with the Capacity Reservation Group.
- hostGroupId
- ResourceIdentifier
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.
- networkProfile
- AgentPoolNetworkProfile
Network-related settings of an agent pool.
Returns
A new ContainerServiceAgentPoolData instance for mocking.
Applies to
ContainerServiceAgentPoolData(ResourceIdentifier, String, ResourceType, SystemData, Nullable<Int32>, String, Nullable<Int32>, Nullable<ContainerServiceOSDiskType>, Nullable<KubeletDiskType>, Nullable<WorkloadRuntime>, String, ResourceIdentifier, ResourceIdentifier, Nullable<Int32>, Nullable<ContainerServiceOSType>, Nullable<ContainerServiceOSSku>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<ScaleDownMode>, Nullable<AgentPoolType>, Nullable<AgentPoolMode>, String, String, String, String, String, Nullable<ContainerServiceStateCode>, IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, ResourceIdentifier, Nullable<ScaleSetPriority>, Nullable<ScaleSetEvictionPolicy>, Nullable<Single>, IDictionary<String, String>, IDictionary<String,String>, IEnumerable<String>, ResourceIdentifier, KubeletConfig, LinuxOSConfig, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<GpuInstanceProfile>, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, Nullable<Boolean>, AgentPoolNetworkProfile)
Initializes a new instance of ContainerServiceAgentPoolData.
public static Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolData ContainerServiceAgentPoolData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, int? count = default, string vmSize = default, int? osDiskSizeInGB = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceOSDiskType? osDiskType = default, Azure.ResourceManager.ContainerService.Models.KubeletDiskType? kubeletDiskType = default, Azure.ResourceManager.ContainerService.Models.WorkloadRuntime? workloadRuntime = default, string messageOfTheDay = default, Azure.Core.ResourceIdentifier vnetSubnetId = default, Azure.Core.ResourceIdentifier podSubnetId = default, int? maxPods = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceOSType? osType = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceOSSku? osSku = default, int? maxCount = default, int? minCount = default, bool? enableAutoScaling = default, Azure.ResourceManager.ContainerService.Models.ScaleDownMode? scaleDownMode = default, Azure.ResourceManager.ContainerService.Models.AgentPoolType? typePropertiesType = default, Azure.ResourceManager.ContainerService.Models.AgentPoolMode? mode = default, string orchestratorVersion = default, string currentOrchestratorVersion = default, string nodeImageVersion = default, string upgradeMaxSurge = default, string provisioningState = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceStateCode? powerStateCode = default, System.Collections.Generic.IEnumerable<string> availabilityZones = default, bool? enableNodePublicIP = default, bool? enableCustomCATrust = default, Azure.Core.ResourceIdentifier nodePublicIPPrefixId = default, Azure.ResourceManager.ContainerService.Models.ScaleSetPriority? scaleSetPriority = default, Azure.ResourceManager.ContainerService.Models.ScaleSetEvictionPolicy? scaleSetEvictionPolicy = default, float? spotMaxPrice = default, System.Collections.Generic.IDictionary<string,string> tags = default, System.Collections.Generic.IDictionary<string,string> nodeLabels = default, System.Collections.Generic.IEnumerable<string> nodeTaints = default, Azure.Core.ResourceIdentifier proximityPlacementGroupId = default, Azure.ResourceManager.ContainerService.Models.KubeletConfig kubeletConfig = default, Azure.ResourceManager.ContainerService.Models.LinuxOSConfig linuxOSConfig = default, bool? enableEncryptionAtHost = default, bool? enableUltraSsd = default, bool? enableFips = default, Azure.ResourceManager.ContainerService.Models.GpuInstanceProfile? gpuInstanceProfile = default, Azure.Core.ResourceIdentifier creationDataSourceResourceId = default, Azure.Core.ResourceIdentifier capacityReservationGroupId = default, Azure.Core.ResourceIdentifier hostGroupId = default, bool? disableOutboundNat = default, Azure.ResourceManager.ContainerService.Models.AgentPoolNetworkProfile networkProfile = default);static member ContainerServiceAgentPoolData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * Nullable<int> * string * Nullable<int> * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceOSDiskType> * Nullable<Azure.ResourceManager.ContainerService.Models.KubeletDiskType> * Nullable<Azure.ResourceManager.ContainerService.Models.WorkloadRuntime> * string * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Nullable<int> * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceOSType> * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceOSSku> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<Azure.ResourceManager.ContainerService.Models.ScaleDownMode> * Nullable<Azure.ResourceManager.ContainerService.Models.AgentPoolType> * Nullable<Azure.ResourceManager.ContainerService.Models.AgentPoolMode> * string * string * string * string * string * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceStateCode> * seq<string> * Nullable<bool> * Nullable<bool> * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.ContainerService.Models.ScaleSetPriority> * Nullable<Azure.ResourceManager.ContainerService.Models.ScaleSetEvictionPolicy> * Nullable<single> * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.IDictionary<string, string> * seq<string> * Azure.Core.ResourceIdentifier * Azure.ResourceManager.ContainerService.Models.KubeletConfig * Azure.ResourceManager.ContainerService.Models.LinuxOSConfig * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.ContainerService.Models.GpuInstanceProfile> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Nullable<bool> * Azure.ResourceManager.ContainerService.Models.AgentPoolNetworkProfile -> Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolDataPublic Shared Function ContainerServiceAgentPoolData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional vmSize As String = Nothing, Optional osDiskSizeInGB As Nullable(Of Integer) = Nothing, Optional osDiskType As Nullable(Of ContainerServiceOSDiskType) = Nothing, Optional kubeletDiskType As Nullable(Of KubeletDiskType) = Nothing, Optional workloadRuntime As Nullable(Of WorkloadRuntime) = Nothing, Optional messageOfTheDay As String = Nothing, Optional vnetSubnetId As ResourceIdentifier = Nothing, Optional podSubnetId As ResourceIdentifier = Nothing, Optional maxPods As Nullable(Of Integer) = Nothing, Optional osType As Nullable(Of ContainerServiceOSType) = Nothing, Optional osSku As Nullable(Of ContainerServiceOSSku) = 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 Nullable(Of ScaleDownMode) = Nothing, Optional typePropertiesType As Nullable(Of AgentPoolType) = Nothing, Optional mode As Nullable(Of AgentPoolMode) = Nothing, Optional orchestratorVersion As String = Nothing, Optional currentOrchestratorVersion As String = Nothing, Optional nodeImageVersion As String = Nothing, Optional upgradeMaxSurge As String = Nothing, Optional provisioningState As String = Nothing, Optional powerStateCode As Nullable(Of ContainerServiceStateCode) = Nothing, Optional availabilityZones As IEnumerable(Of String) = Nothing, Optional enableNodePublicIP As Nullable(Of Boolean) = Nothing, Optional enableCustomCATrust As Nullable(Of Boolean) = Nothing, Optional nodePublicIPPrefixId As ResourceIdentifier = Nothing, Optional scaleSetPriority As Nullable(Of ScaleSetPriority) = Nothing, Optional scaleSetEvictionPolicy As Nullable(Of ScaleSetEvictionPolicy) = Nothing, Optional spotMaxPrice As Nullable(Of Single) = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional nodeLabels As IDictionary(Of String, String) = Nothing, Optional nodeTaints As IEnumerable(Of String) = Nothing, Optional proximityPlacementGroupId As ResourceIdentifier = 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 Nullable(Of GpuInstanceProfile) = Nothing, Optional creationDataSourceResourceId As ResourceIdentifier = Nothing, Optional capacityReservationGroupId As ResourceIdentifier = Nothing, Optional hostGroupId As ResourceIdentifier = Nothing, Optional disableOutboundNat As Nullable(Of Boolean) = Nothing, Optional networkProfile As AgentPoolNetworkProfile = Nothing) As ContainerServiceAgentPoolDataParameters
The id.
- name
- String
The name.
- resourceType
- ResourceType
The resourceType.
- systemData
- SystemData
The systemData.
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.
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
- Nullable<ContainerServiceOSDiskType>
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.
- kubeletDiskType
- Nullable<KubeletDiskType>
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
- workloadRuntime
- Nullable<WorkloadRuntime>
Determines the type of workload a node can run.
- messageOfTheDay
- String
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).
- vnetSubnetId
- ResourceIdentifier
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
- ResourceIdentifier
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}.
- osType
- Nullable<ContainerServiceOSType>
The operating system type. The default is Linux.
- osSku
- Nullable<ContainerServiceOSSku>
Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated.
- scaleDownMode
- Nullable<ScaleDownMode>
This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
- typePropertiesType
- Nullable<AgentPoolType>
The type of Agent Pool.
- mode
- Nullable<AgentPoolMode>
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.
- orchestratorVersion
- String
Both patch version <major.minor.patch> and <major.minor> are supported. When <major.minor> is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same <major.minor> once it has been created 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 was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.
- nodeImageVersion
- String
The version of node image.
- upgradeMaxSurge
- String
Settings for upgrading the agentpool.
- provisioningState
- String
The current deployment or provisioning state.
- powerStateCode
- Nullable<ContainerServiceStateCode>
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
- IEnumerable<String>
The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
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.
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.
- nodePublicIPPrefixId
- ResourceIdentifier
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}.
- scaleSetPriority
- Nullable<ScaleSetPriority>
The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
- scaleSetEvictionPolicy
- Nullable<ScaleSetEvictionPolicy>
This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
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
- IEnumerable<String>
The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
- proximityPlacementGroupId
- ResourceIdentifier
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.
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.
- gpuInstanceProfile
- Nullable<GpuInstanceProfile>
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
- creationDataSourceResourceId
- ResourceIdentifier
CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
- capacityReservationGroupId
- ResourceIdentifier
AKS will associate the specified agent pool with the Capacity Reservation Group.
- hostGroupId
- ResourceIdentifier
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.
- networkProfile
- AgentPoolNetworkProfile
Network-related settings of an agent pool.
Returns
A new ContainerServiceAgentPoolData instance for mocking.
Applies to
Azure SDK for .NET