ArmContainerServiceModelFactory.ManagedClusterAgentPoolProfileProperties 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.
public static Azure.ResourceManager.ContainerService.Models.ManagedClusterAgentPoolProfileProperties ManagedClusterAgentPoolProfileProperties(Azure.ETag? etag = 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, Azure.ResourceManager.ContainerService.Models.PodIPAllocationMode? podIPAllocationMode = 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? isAutoScalingEnabled = default, Azure.ResourceManager.ContainerService.Models.ScaleDownMode? scaleDownMode = default, Azure.ResourceManager.ContainerService.Models.AgentPoolType? agentPoolType = default, Azure.ResourceManager.ContainerService.Models.AgentPoolMode? mode = default, string orchestratorVersion = default, string currentOrchestratorVersion = default, string nodeImageVersion = default, Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeStrategy? upgradeStrategy = default, bool? isOSDiskFullCachingEnabled = default, Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings upgradeSettings = default, Azure.ResourceManager.ContainerService.Models.AgentPoolBlueGreenUpgradeSettings upgradeSettingsBlueGreen = default, string provisioningState = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceStateCode? powerStateCode = default, System.Collections.Generic.IEnumerable<string> availabilityZones = default, bool? isNodePublicIpEnabled = 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, System.Collections.Generic.IEnumerable<string> nodeInitializationTaints = default, Azure.Core.ResourceIdentifier proximityPlacementGroupId = default, Azure.ResourceManager.ContainerService.Models.KubeletConfig kubeletConfig = default, Azure.ResourceManager.ContainerService.Models.LinuxOSConfig linuxOSConfig = default, bool? isEncryptionAtHostEnabled = default, bool? isUltraSsdEnabled = default, bool? isFipsEnabled = 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, bool? isOutboundNatDisabled = default, Azure.ResourceManager.ContainerService.Models.AgentPoolSecurityProfile securityProfile = default, Azure.ResourceManager.ContainerService.Models.AgentPoolGpuProfile gpuProfile = default, int? gatewayPublicIPPrefixSize = default, bool? isArtifactStreamingEnabled = default, Azure.ResourceManager.ContainerService.Models.AgentPoolScaleProfile virtualMachinesScale = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ContainerService.Models.AgentPoolVirtualMachineNodes> virtualMachineNodesStatus = default, Azure.ResponseError statusProvisioningError = default, Azure.ResourceManager.ContainerService.Models.LocalDnsProfile localDnsProfile = default, Azure.Core.ResourceIdentifier nodeCustomizationId = default);static member ManagedClusterAgentPoolProfileProperties : Nullable<Azure.ETag> * 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<Azure.ResourceManager.ContainerService.Models.PodIPAllocationMode> * 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 * Nullable<Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeStrategy> * Nullable<bool> * Azure.ResourceManager.ContainerService.Models.AgentPoolUpgradeSettings * Azure.ResourceManager.ContainerService.Models.AgentPoolBlueGreenUpgradeSettings * 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> * 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 * Nullable<bool> * Azure.ResourceManager.ContainerService.Models.AgentPoolSecurityProfile * Azure.ResourceManager.ContainerService.Models.AgentPoolGpuProfile * Nullable<int> * Nullable<bool> * Azure.ResourceManager.ContainerService.Models.AgentPoolScaleProfile * seq<Azure.ResourceManager.ContainerService.Models.AgentPoolVirtualMachineNodes> * Azure.ResponseError * Azure.ResourceManager.ContainerService.Models.LocalDnsProfile * Azure.Core.ResourceIdentifier -> Azure.ResourceManager.ContainerService.Models.ManagedClusterAgentPoolProfilePropertiesPublic Shared Function ManagedClusterAgentPoolProfileProperties (Optional etag As Nullable(Of ETag) = 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 podIPAllocationMode As Nullable(Of PodIPAllocationMode) = 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 isAutoScalingEnabled As Nullable(Of Boolean) = Nothing, Optional scaleDownMode As Nullable(Of ScaleDownMode) = Nothing, Optional agentPoolType 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 upgradeStrategy As Nullable(Of AgentPoolUpgradeStrategy) = Nothing, Optional isOSDiskFullCachingEnabled As Nullable(Of Boolean) = Nothing, Optional upgradeSettings As AgentPoolUpgradeSettings = Nothing, Optional upgradeSettingsBlueGreen As AgentPoolBlueGreenUpgradeSettings = Nothing, Optional provisioningState As String = Nothing, Optional powerStateCode As Nullable(Of ContainerServiceStateCode) = Nothing, Optional availabilityZones As IEnumerable(Of String) = Nothing, Optional isNodePublicIpEnabled 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 nodeInitializationTaints As IEnumerable(Of String) = Nothing, Optional proximityPlacementGroupId As ResourceIdentifier = Nothing, Optional kubeletConfig As KubeletConfig = Nothing, Optional linuxOSConfig As LinuxOSConfig = Nothing, Optional isEncryptionAtHostEnabled As Nullable(Of Boolean) = Nothing, Optional isUltraSsdEnabled As Nullable(Of Boolean) = Nothing, Optional isFipsEnabled 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, Optional isOutboundNatDisabled As Nullable(Of Boolean) = Nothing, Optional securityProfile As AgentPoolSecurityProfile = Nothing, Optional gpuProfile As AgentPoolGpuProfile = Nothing, Optional gatewayPublicIPPrefixSize As Nullable(Of Integer) = Nothing, Optional isArtifactStreamingEnabled As Nullable(Of Boolean) = Nothing, Optional virtualMachinesScale As AgentPoolScaleProfile = Nothing, Optional virtualMachineNodesStatus As IEnumerable(Of AgentPoolVirtualMachineNodes) = Nothing, Optional statusProvisioningError As ResponseError = Nothing, Optional localDnsProfile As LocalDnsProfile = Nothing, Optional nodeCustomizationId As ResourceIdentifier = Nothing) As ManagedClusterAgentPoolProfilePropertiesParameters
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.
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
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.
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 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.
- 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
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).
- vnetSubnetId
- ResourceIdentifier
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}.
- podSubnetId
- ResourceIdentifier
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}.
- podIPAllocationMode
- Nullable<PodIPAllocationMode>
Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
- 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>
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.
- agentPoolType
- Nullable<AgentPoolType>
The type of Agent Pool.
- mode
- Nullable<AgentPoolMode>
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.
- orchestratorVersion
- String
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.
- currentOrchestratorVersion
- String
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.
- nodeImageVersion
- String
The version of node image.
- upgradeStrategy
- Nullable<AgentPoolUpgradeStrategy>
Defines the upgrade strategy for the agent pool. The default is Rolling.
Whether to enable the full-cache ephemeral OS disk feature. When this feature is enabled, the entire operating system will be locally cached on the ephemeral OS disk, preventing E17 events caused by network failures.
- upgradeSettings
- AgentPoolUpgradeSettings
Settings for upgrading the agentpool.
- upgradeSettingsBlueGreen
- AgentPoolBlueGreenUpgradeSettings
Settings for Blue-Green upgrade on the agentpool. Applies when upgrade strategy is set to BlueGreen.
- provisioningState
- String
The current deployment or provisioning state.
- powerStateCode
- Nullable<ContainerServiceStateCode>
Tells whether the cluster is Running or Stopped.
- availabilityZones
- IEnumerable<String>
The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
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.
- nodePublicIPPrefixId
- ResourceIdentifier
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}.
- scaleSetPriority
- Nullable<ScaleSetPriority>
The Virtual Machine Scale Set priority.
- scaleSetEvictionPolicy
- Nullable<ScaleSetEvictionPolicy>
The Virtual Machine Scale Set eviction policy. The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see spot VMs.
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.
- 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.
- nodeInitializationTaints
- IEnumerable<String>
Taints added on the nodes during creation that will not be reconciled by AKS. These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with kubectl taint nodes node1 key1=value1: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.
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.
Whether to use a FIPS-enabled OS. 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
This is the ARM ID of the source object to be used to create the target object.
- capacityReservationGroupId
- ResourceIdentifier
The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines. This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}' Customers use it to create an agentpool with a specified CRG. For more information see Capacity Reservation.
- hostGroupId
- ResourceIdentifier
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.
- networkProfile
- AgentPoolNetworkProfile
Network-related settings of an agent pool.
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.
- securityProfile
- AgentPoolSecurityProfile
The security settings of an agent pool.
- gpuProfile
- AgentPoolGpuProfile
GPU settings for the Agent Pool.
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.
Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false.
- virtualMachinesScale
- AgentPoolScaleProfile
Specifications on how to scale a VirtualMachines agent pool.
- virtualMachineNodesStatus
- IEnumerable<AgentPoolVirtualMachineNodes>
The status of nodes in a VirtualMachines agent pool.
- statusProvisioningError
- ResponseError
The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted.
- localDnsProfile
- LocalDnsProfile
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.
- nodeCustomizationId
- ResourceIdentifier
The resource ID of the node customization resource to use. This can be a version. Omitting the version will use the latest version of the node customization.
Returns
A new ManagedClusterAgentPoolProfileProperties instance for mocking.
