azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

1092 строки
110 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties"
name: "ManagedClusterAgentPoolProfileProperties"
nameWithType: "ManagedClusterAgentPoolProfileProperties"
summary: "Properties for the container service agent pool profile."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **ManagedClusterAgentPoolProfileProperties**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.ManagedClusterAgentPoolProfileProperties()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.ManagedClusterAgentPoolProfileProperties()"
name: "ManagedClusterAgentPoolProfileProperties()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.ManagedClusterAgentPoolProfileProperties()"
summary: "Creates an instance of Managed<wbr>Cluster<wbr>Agent<wbr>Pool<wbr>Profile<wbr>Properties class."
syntax: "public ManagedClusterAgentPoolProfileProperties()"
desc: "Creates an instance of ManagedClusterAgentPoolProfileProperties class."
methods:
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.availabilityZones()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.availabilityZones()"
name: "availabilityZones()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.availabilityZones()"
summary: "Get the availability<wbr>Zones property: The list of Availability zones to use for nodes."
syntax: "public List<String> availabilityZones()"
desc: "Get the availabilityZones property: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
returns:
description: "the availabilityZones value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.capacityReservationGroupId()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.capacityReservationGroupId()"
name: "capacityReservationGroupId()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.capacityReservationGroupId()"
summary: "Get the capacity<wbr>Reservation<wbr>Group<wbr>Id property: AKS will associate the specified agent pool with the Capacity Reservation Group."
syntax: "public String capacityReservationGroupId()"
desc: "Get the capacityReservationGroupId property: AKS will associate the specified agent pool with the Capacity Reservation Group."
returns:
description: "the capacityReservationGroupId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.count()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.count()"
name: "count()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.count()"
summary: "Get the count property: Number of agents (VMs) to host docker containers."
syntax: "public Integer count()"
desc: "Get the count property: 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."
returns:
description: "the count value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.creationData()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.creationData()"
name: "creationData()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.creationData()"
summary: "Get the creation<wbr>Data property: Creation<wbr>Data to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
syntax: "public CreationData creationData()"
desc: "Get the creationData property: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
returns:
description: "the creationData value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.CreationData?alt=com.azure.resourcemanager.containerservice.models.CreationData&text=CreationData\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.currentOrchestratorVersion()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.currentOrchestratorVersion()"
name: "currentOrchestratorVersion()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.currentOrchestratorVersion()"
summary: "Get the current<wbr>Orchestrator<wbr>Version property: If orchestrator<wbr>Version is a fully specified version <major.<wbr>minor.<wbr>patch>, this field will be exactly equal to it."
syntax: "public String currentOrchestratorVersion()"
desc: "Get the currentOrchestratorVersion property: 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."
returns:
description: "the currentOrchestratorVersion value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableAutoScaling()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableAutoScaling()"
name: "enableAutoScaling()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.enableAutoScaling()"
summary: "Get the enable<wbr>Auto<wbr>Scaling property: Whether to enable auto-scaler."
syntax: "public Boolean enableAutoScaling()"
desc: "Get the enableAutoScaling property: Whether to enable auto-scaler."
returns:
description: "the enableAutoScaling value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost()"
name: "enableEncryptionAtHost()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost()"
summary: "Get the enable<wbr>Encryption<wbr>AtHost property: This is only supported on certain VM sizes and in certain Azure regions."
syntax: "public Boolean enableEncryptionAtHost()"
desc: "Get the enableEncryptionAtHost property: 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."
returns:
description: "the enableEncryptionAtHost value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableFips()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableFips()"
name: "enableFips()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.enableFips()"
summary: "Get the enable<wbr>Fips property: See \\[Add a FIPS-enabled node pool\\](https://docs.<wbr>microsoft.<wbr>com/azure/aks/use-multiple-node-pools\\#add-a-fips-enabled-node-pool-preview) for more details."
syntax: "public Boolean enableFips()"
desc: "Get the enableFips property: See \\[Add a FIPS-enabled node pool\\](https://docs.microsoft.com/azure/aks/use-multiple-node-pools\\#add-a-fips-enabled-node-pool-preview) for more details."
returns:
description: "the enableFips value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableNodePublicIp()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableNodePublicIp()"
name: "enableNodePublicIp()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.enableNodePublicIp()"
summary: "Get the enable<wbr>Node<wbr>Public<wbr>Ip property: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses."
syntax: "public Boolean enableNodePublicIp()"
desc: "Get the enableNodePublicIp property: 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\\](https://docs.microsoft.com/azure/aks/use-multiple-node-pools\\#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
returns:
description: "the enableNodePublicIp value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableUltraSsd()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.enableUltraSsd()"
name: "enableUltraSsd()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.enableUltraSsd()"
summary: "Get the enable<wbr>Ultra<wbr>Ssd property: Whether to enable UltraSSD."
syntax: "public Boolean enableUltraSsd()"
desc: "Get the enableUltraSsd property: Whether to enable UltraSSD."
returns:
description: "the enableUltraSsd value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Managed<wbr>Cluster<wbr>Agent<wbr>Pool<wbr>Profile<wbr>Properties from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static ManagedClusterAgentPoolProfileProperties fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the ManagedClusterAgentPoolProfileProperties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of ManagedClusterAgentPoolProfileProperties from the JsonReader."
returns:
description: "An instance of ManagedClusterAgentPoolProfileProperties if the JsonReader was pointing to an instance of\n it, or null if it was pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.gpuInstanceProfile()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.gpuInstanceProfile()"
name: "gpuInstanceProfile()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.gpuInstanceProfile()"
summary: "Get the gpu<wbr>Instance<wbr>Profile property: GPUInstance<wbr>Profile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
syntax: "public GpuInstanceProfile gpuInstanceProfile()"
desc: "Get the gpuInstanceProfile property: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
returns:
description: "the gpuInstanceProfile value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.GpuInstanceProfile?alt=com.azure.resourcemanager.containerservice.models.GpuInstanceProfile&text=GpuInstanceProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.hostGroupId()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.hostGroupId()"
name: "hostGroupId()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.hostGroupId()"
summary: "Get the host<wbr>Group<wbr>Id property: This is of the form: /subscriptions/\\{subscription<wbr>Id\\}/resource<wbr>Groups/\\{resource<wbr>Group<wbr>Name\\}/providers/Microsoft.<wbr>Compute/host<wbr>Groups/\\{host<wbr>Group<wbr>Name\\}."
syntax: "public String hostGroupId()"
desc: "Get the hostGroupId property: This is of the form: /subscriptions/\\{subscriptionId\\}/resourceGroups/\\{resourceGroupName\\}/providers/Microsoft.Compute/hostGroups/\\{hostGroupName\\}. For more information see \\[Azure dedicated hosts\\](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
returns:
description: "the hostGroupId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.kubeletConfig()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.kubeletConfig()"
name: "kubeletConfig()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.kubeletConfig()"
summary: "Get the kubelet<wbr>Config property: The Kubelet configuration on the agent pool nodes."
syntax: "public KubeletConfig kubeletConfig()"
desc: "Get the kubeletConfig property: The Kubelet configuration on the agent pool nodes."
returns:
description: "the kubeletConfig value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.KubeletConfig?alt=com.azure.resourcemanager.containerservice.models.KubeletConfig&text=KubeletConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.kubeletDiskType()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.kubeletDiskType()"
name: "kubeletDiskType()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.kubeletDiskType()"
summary: "Get the kubelet<wbr>Disk<wbr>Type property: Determines the placement of empty<wbr>Dir volumes, container runtime data root, and Kubelet ephemeral storage."
syntax: "public KubeletDiskType kubeletDiskType()"
desc: "Get the kubeletDiskType property: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
returns:
description: "the kubeletDiskType value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.KubeletDiskType?alt=com.azure.resourcemanager.containerservice.models.KubeletDiskType&text=KubeletDiskType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.linuxOSConfig()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.linuxOSConfig()"
name: "linuxOSConfig()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.linuxOSConfig()"
summary: "Get the linux<wbr>OSConfig property: The OS configuration of Linux agent nodes."
syntax: "public LinuxOSConfig linuxOSConfig()"
desc: "Get the linuxOSConfig property: The OS configuration of Linux agent nodes."
returns:
description: "the linuxOSConfig value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.LinuxOSConfig?alt=com.azure.resourcemanager.containerservice.models.LinuxOSConfig&text=LinuxOSConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.maxCount()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.maxCount()"
name: "maxCount()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.maxCount()"
summary: "Get the max<wbr>Count property: The maximum number of nodes for auto-scaling."
syntax: "public Integer maxCount()"
desc: "Get the maxCount property: The maximum number of nodes for auto-scaling."
returns:
description: "the maxCount value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.maxPods()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.maxPods()"
name: "maxPods()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.maxPods()"
summary: "Get the max<wbr>Pods property: The maximum number of pods that can run on a node."
syntax: "public Integer maxPods()"
desc: "Get the maxPods property: The maximum number of pods that can run on a node."
returns:
description: "the maxPods value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.minCount()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.minCount()"
name: "minCount()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.minCount()"
summary: "Get the min<wbr>Count property: The minimum number of nodes for auto-scaling."
syntax: "public Integer minCount()"
desc: "Get the minCount property: The minimum number of nodes for auto-scaling."
returns:
description: "the minCount value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.mode()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.mode()"
name: "mode()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.mode()"
summary: "Get the mode property: A cluster must have at least one 'System' Agent Pool at all times."
syntax: "public AgentPoolMode mode()"
desc: "Get the mode property: 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."
returns:
description: "the mode value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolMode?alt=com.azure.resourcemanager.containerservice.models.AgentPoolMode&text=AgentPoolMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.networkProfile()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.networkProfile()"
name: "networkProfile()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.networkProfile()"
summary: "Get the network<wbr>Profile property: Network-related settings of an agent pool."
syntax: "public AgentPoolNetworkProfile networkProfile()"
desc: "Get the networkProfile property: Network-related settings of an agent pool."
returns:
description: "the networkProfile value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolNetworkProfile?alt=com.azure.resourcemanager.containerservice.models.AgentPoolNetworkProfile&text=AgentPoolNetworkProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.nodeImageVersion()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.nodeImageVersion()"
name: "nodeImageVersion()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.nodeImageVersion()"
summary: "Get the node<wbr>Image<wbr>Version property: The version of node image."
syntax: "public String nodeImageVersion()"
desc: "Get the nodeImageVersion property: The version of node image."
returns:
description: "the nodeImageVersion value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.nodeLabels()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.nodeLabels()"
name: "nodeLabels()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.nodeLabels()"
summary: "Get the node<wbr>Labels property: The node labels to be persisted across all nodes in agent pool."
syntax: "public Map<String,String> nodeLabels()"
desc: "Get the nodeLabels property: The node labels to be persisted across all nodes in agent pool."
returns:
description: "the nodeLabels value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.nodePublicIpPrefixId()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.nodePublicIpPrefixId()"
name: "nodePublicIpPrefixId()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.nodePublicIpPrefixId()"
summary: "Get the node<wbr>Public<wbr>IpPrefix<wbr>Id property: This is of the form: /subscriptions/\\{subscription<wbr>Id\\}/resource<wbr>Groups/\\{resource<wbr>Group<wbr>Name\\}/providers/Microsoft.<wbr>Network/public<wbr>IPPrefixes/\\{public<wbr>IPPrefix<wbr>Name\\}."
syntax: "public String nodePublicIpPrefixId()"
desc: "Get the nodePublicIpPrefixId property: This is of the form: /subscriptions/\\{subscriptionId\\}/resourceGroups/\\{resourceGroupName\\}/providers/Microsoft.Network/publicIPPrefixes/\\{publicIPPrefixName\\}."
returns:
description: "the nodePublicIpPrefixId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.nodeTaints()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.nodeTaints()"
name: "nodeTaints()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.nodeTaints()"
summary: "Get the node<wbr>Taints property: The taints added to new nodes during node pool create and scale."
syntax: "public List<String> nodeTaints()"
desc: "Get the nodeTaints property: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
returns:
description: "the nodeTaints value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.orchestratorVersion()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.orchestratorVersion()"
name: "orchestratorVersion()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.orchestratorVersion()"
summary: "Get the orchestrator<wbr>Version property: Both patch version <major.<wbr>minor.<wbr>patch> (e.<wbr>g."
syntax: "public String orchestratorVersion()"
desc: "Get the orchestratorVersion property: 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\\](https://docs.microsoft.com/azure/aks/use-multiple-node-pools\\#upgrade-a-node-pool)."
returns:
description: "the orchestratorVersion value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.osDiskSizeGB()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.osDiskSizeGB()"
name: "osDiskSizeGB()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.osDiskSizeGB()"
summary: "Get the os<wbr>Disk<wbr>SizeGB property: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool."
syntax: "public Integer osDiskSizeGB()"
desc: "Get the osDiskSizeGB property: 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."
returns:
description: "the osDiskSizeGB value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.osDiskType()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.osDiskType()"
name: "osDiskType()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.osDiskType()"
summary: "Get the os<wbr>Disk<wbr>Type property: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDisk<wbr>SizeGB."
syntax: "public OSDiskType osDiskType()"
desc: "Get the osDiskType property: 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\\](https://docs.microsoft.com/azure/aks/cluster-configuration\\#ephemeral-os)."
returns:
description: "the osDiskType value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.OSDiskType?alt=com.azure.resourcemanager.containerservice.models.OSDiskType&text=OSDiskType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.osSku()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.osSku()"
name: "osSku()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.osSku()"
summary: "Get the os<wbr>Sku property: Specifies the OS SKU used by the agent pool."
syntax: "public OSSku osSku()"
desc: "Get the osSku property: 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."
returns:
description: "the osSku value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.OSSku?alt=com.azure.resourcemanager.containerservice.models.OSSku&text=OSSku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.osType()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.osType()"
name: "osType()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.osType()"
summary: "Get the os<wbr>Type property: Os<wbr>Type to be used to specify os type."
syntax: "public OSType osType()"
desc: "Get the osType property: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux."
returns:
description: "the osType value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.OSType?alt=com.azure.resourcemanager.containerservice.models.OSType&text=OSType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.podSubnetId()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.podSubnetId()"
name: "podSubnetId()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.podSubnetId()"
summary: "Get the pod<wbr>Subnet<wbr>Id property: If omitted, pod IPs are statically assigned on the node subnet (see vnet<wbr>SubnetID for more details)."
syntax: "public String podSubnetId()"
desc: "Get the podSubnetId property: 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\\}."
returns:
description: "the podSubnetId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.powerState()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.powerState()"
name: "powerState()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.powerState()"
summary: "Get the power<wbr>State property: When an Agent Pool is first created it is initially Running."
syntax: "public PowerState powerState()"
desc: "Get the powerState property: 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."
returns:
description: "the powerState value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.PowerState?alt=com.azure.resourcemanager.containerservice.models.PowerState&text=PowerState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.provisioningState()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.provisioningState()"
name: "provisioningState()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.provisioningState()"
summary: "Get the provisioning<wbr>State property: The current deployment or provisioning state."
syntax: "public String provisioningState()"
desc: "Get the provisioningState property: The current deployment or provisioning state."
returns:
description: "the provisioningState value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupId()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupId()"
name: "proximityPlacementGroupId()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupId()"
summary: "Get the proximity<wbr>Placement<wbr>Group<wbr>Id property: The ID for Proximity Placement Group."
syntax: "public String proximityPlacementGroupId()"
desc: "Get the proximityPlacementGroupId property: The ID for Proximity Placement Group."
returns:
description: "the proximityPlacementGroupId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.scaleDownMode()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.scaleDownMode()"
name: "scaleDownMode()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.scaleDownMode()"
summary: "Get the scale<wbr>Down<wbr>Mode property: This also effects the cluster autoscaler behavior."
syntax: "public ScaleDownMode scaleDownMode()"
desc: "Get the scaleDownMode property: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
returns:
description: "the scaleDownMode value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.ScaleDownMode?alt=com.azure.resourcemanager.containerservice.models.ScaleDownMode&text=ScaleDownMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy()"
name: "scaleSetEvictionPolicy()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy()"
summary: "Get the scale<wbr>Set<wbr>Eviction<wbr>Policy property: This cannot be specified unless the scale<wbr>Set<wbr>Priority is 'Spot'."
syntax: "public ScaleSetEvictionPolicy scaleSetEvictionPolicy()"
desc: "Get the scaleSetEvictionPolicy property: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
returns:
description: "the scaleSetEvictionPolicy value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.ScaleSetEvictionPolicy?alt=com.azure.resourcemanager.containerservice.models.ScaleSetEvictionPolicy&text=ScaleSetEvictionPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.scaleSetPriority()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.scaleSetPriority()"
name: "scaleSetPriority()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.scaleSetPriority()"
summary: "Get the scale<wbr>Set<wbr>Priority property: The Virtual Machine Scale Set priority."
syntax: "public ScaleSetPriority scaleSetPriority()"
desc: "Get the scaleSetPriority property: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
returns:
description: "the scaleSetPriority value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.ScaleSetPriority?alt=com.azure.resourcemanager.containerservice.models.ScaleSetPriority&text=ScaleSetPriority\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.spotMaxPrice()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.spotMaxPrice()"
name: "spotMaxPrice()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.spotMaxPrice()"
summary: "Get the spot<wbr>Max<wbr>Price property: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price."
syntax: "public Float spotMaxPrice()"
desc: "Get the spotMaxPrice property: 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\\](https://docs.microsoft.com/azure/virtual-machines/spot-vms\\#pricing)."
returns:
description: "the spotMaxPrice value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.tags()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.tags()"
name: "tags()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.tags()"
summary: "Get the tags property: The tags to be persisted on the agent pool virtual machine scale set."
syntax: "public Map<String,String> tags()"
desc: "Get the tags property: The tags to be persisted on the agent pool virtual machine scale set."
returns:
description: "the tags value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.type()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.type()"
name: "type()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.type()"
summary: "Get the type property: The type of Agent Pool."
syntax: "public AgentPoolType type()"
desc: "Get the type property: The type of Agent Pool."
returns:
description: "the type value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolType?alt=com.azure.resourcemanager.containerservice.models.AgentPoolType&text=AgentPoolType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.upgradeSettings()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.upgradeSettings()"
name: "upgradeSettings()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.upgradeSettings()"
summary: "Get the upgrade<wbr>Settings property: Settings for upgrading the agentpool."
syntax: "public AgentPoolUpgradeSettings upgradeSettings()"
desc: "Get the upgradeSettings property: Settings for upgrading the agentpool."
returns:
description: "the upgradeSettings value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolUpgradeSettings?alt=com.azure.resourcemanager.containerservice.models.AgentPoolUpgradeSettings&text=AgentPoolUpgradeSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.validate()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.validate()"
name: "validate()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.vmSize()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.vmSize()"
name: "vmSize()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.vmSize()"
summary: "Get the vm<wbr>Size property: VM size availability varies by region."
syntax: "public String vmSize()"
desc: "Get the vmSize property: 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."
returns:
description: "the vmSize value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.vnetSubnetId()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.vnetSubnetId()"
name: "vnetSubnetId()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.vnetSubnetId()"
summary: "Get the vnet<wbr>Subnet<wbr>Id property: If this is not specified, a VNET and subnet will be generated and used."
syntax: "public String vnetSubnetId()"
desc: "Get the vnetSubnetId property: 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\\}."
returns:
description: "the vnetSubnetId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.windowsProfile()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.windowsProfile()"
name: "windowsProfile()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.windowsProfile()"
summary: "Get the windows<wbr>Profile property: The Windows agent pool's specific profile."
syntax: "public AgentPoolWindowsProfile windowsProfile()"
desc: "Get the windowsProfile property: The Windows agent pool's specific profile."
returns:
description: "the windowsProfile value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolWindowsProfile?alt=com.azure.resourcemanager.containerservice.models.AgentPoolWindowsProfile&text=AgentPoolWindowsProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withAvailabilityZones(java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withAvailabilityZones(List<String> availabilityZones)"
name: "withAvailabilityZones(List<String> availabilityZones)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withAvailabilityZones(List<String> availabilityZones)"
summary: "Set the availability<wbr>Zones property: The list of Availability zones to use for nodes."
parameters:
- description: "the availabilityZones value to set."
name: "availabilityZones"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public ManagedClusterAgentPoolProfileProperties withAvailabilityZones(List<String> availabilityZones)"
desc: "Set the availabilityZones property: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withCapacityReservationGroupId(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withCapacityReservationGroupId(String capacityReservationGroupId)"
name: "withCapacityReservationGroupId(String capacityReservationGroupId)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withCapacityReservationGroupId(String capacityReservationGroupId)"
summary: "Set the capacity<wbr>Reservation<wbr>Group<wbr>Id property: AKS will associate the specified agent pool with the Capacity Reservation Group."
parameters:
- description: "the capacityReservationGroupId value to set."
name: "capacityReservationGroupId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withCapacityReservationGroupId(String capacityReservationGroupId)"
desc: "Set the capacityReservationGroupId property: AKS will associate the specified agent pool with the Capacity Reservation Group."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withCount(java.lang.Integer)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withCount(Integer count)"
name: "withCount(Integer count)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withCount(Integer count)"
summary: "Set the count property: Number of agents (VMs) to host docker containers."
parameters:
- description: "the count value to set."
name: "count"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withCount(Integer count)"
desc: "Set the count property: 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."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withCreationData(com.azure.resourcemanager.containerservice.models.CreationData)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withCreationData(CreationData creationData)"
name: "withCreationData(CreationData creationData)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withCreationData(CreationData creationData)"
summary: "Set the creation<wbr>Data property: Creation<wbr>Data to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
parameters:
- description: "the creationData value to set."
name: "creationData"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.CreationData?alt=com.azure.resourcemanager.containerservice.models.CreationData&text=CreationData\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withCreationData(CreationData creationData)"
desc: "Set the creationData property: CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableAutoScaling(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableAutoScaling(Boolean enableAutoScaling)"
name: "withEnableAutoScaling(Boolean enableAutoScaling)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withEnableAutoScaling(Boolean enableAutoScaling)"
summary: "Set the enable<wbr>Auto<wbr>Scaling property: Whether to enable auto-scaler."
parameters:
- description: "the enableAutoScaling value to set."
name: "enableAutoScaling"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withEnableAutoScaling(Boolean enableAutoScaling)"
desc: "Set the enableAutoScaling property: Whether to enable auto-scaler."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableEncryptionAtHost(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableEncryptionAtHost(Boolean enableEncryptionAtHost)"
name: "withEnableEncryptionAtHost(Boolean enableEncryptionAtHost)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withEnableEncryptionAtHost(Boolean enableEncryptionAtHost)"
summary: "Set the enable<wbr>Encryption<wbr>AtHost property: This is only supported on certain VM sizes and in certain Azure regions."
parameters:
- description: "the enableEncryptionAtHost value to set."
name: "enableEncryptionAtHost"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withEnableEncryptionAtHost(Boolean enableEncryptionAtHost)"
desc: "Set the enableEncryptionAtHost property: 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."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableFips(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableFips(Boolean enableFips)"
name: "withEnableFips(Boolean enableFips)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withEnableFips(Boolean enableFips)"
summary: "Set the enable<wbr>Fips property: See \\[Add a FIPS-enabled node pool\\](https://docs.<wbr>microsoft.<wbr>com/azure/aks/use-multiple-node-pools\\#add-a-fips-enabled-node-pool-preview) for more details."
parameters:
- description: "the enableFips value to set."
name: "enableFips"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withEnableFips(Boolean enableFips)"
desc: "Set the enableFips property: See \\[Add a FIPS-enabled node pool\\](https://docs.microsoft.com/azure/aks/use-multiple-node-pools\\#add-a-fips-enabled-node-pool-preview) for more details."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableNodePublicIp(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableNodePublicIp(Boolean enableNodePublicIp)"
name: "withEnableNodePublicIp(Boolean enableNodePublicIp)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withEnableNodePublicIp(Boolean enableNodePublicIp)"
summary: "Set the enable<wbr>Node<wbr>Public<wbr>Ip property: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses."
parameters:
- description: "the enableNodePublicIp value to set."
name: "enableNodePublicIp"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withEnableNodePublicIp(Boolean enableNodePublicIp)"
desc: "Set the enableNodePublicIp property: 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\\](https://docs.microsoft.com/azure/aks/use-multiple-node-pools\\#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableUltraSsd(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withEnableUltraSsd(Boolean enableUltraSsd)"
name: "withEnableUltraSsd(Boolean enableUltraSsd)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withEnableUltraSsd(Boolean enableUltraSsd)"
summary: "Set the enable<wbr>Ultra<wbr>Ssd property: Whether to enable UltraSSD."
parameters:
- description: "the enableUltraSsd value to set."
name: "enableUltraSsd"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withEnableUltraSsd(Boolean enableUltraSsd)"
desc: "Set the enableUltraSsd property: Whether to enable UltraSSD."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withGpuInstanceProfile(com.azure.resourcemanager.containerservice.models.GpuInstanceProfile)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withGpuInstanceProfile(GpuInstanceProfile gpuInstanceProfile)"
name: "withGpuInstanceProfile(GpuInstanceProfile gpuInstanceProfile)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withGpuInstanceProfile(GpuInstanceProfile gpuInstanceProfile)"
summary: "Set the gpu<wbr>Instance<wbr>Profile property: GPUInstance<wbr>Profile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
parameters:
- description: "the gpuInstanceProfile value to set."
name: "gpuInstanceProfile"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.GpuInstanceProfile?alt=com.azure.resourcemanager.containerservice.models.GpuInstanceProfile&text=GpuInstanceProfile\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withGpuInstanceProfile(GpuInstanceProfile gpuInstanceProfile)"
desc: "Set the gpuInstanceProfile property: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withHostGroupId(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withHostGroupId(String hostGroupId)"
name: "withHostGroupId(String hostGroupId)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withHostGroupId(String hostGroupId)"
summary: "Set the host<wbr>Group<wbr>Id property: This is of the form: /subscriptions/\\{subscription<wbr>Id\\}/resource<wbr>Groups/\\{resource<wbr>Group<wbr>Name\\}/providers/Microsoft.<wbr>Compute/host<wbr>Groups/\\{host<wbr>Group<wbr>Name\\}."
parameters:
- description: "the hostGroupId value to set."
name: "hostGroupId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withHostGroupId(String hostGroupId)"
desc: "Set the hostGroupId property: This is of the form: /subscriptions/\\{subscriptionId\\}/resourceGroups/\\{resourceGroupName\\}/providers/Microsoft.Compute/hostGroups/\\{hostGroupName\\}. For more information see \\[Azure dedicated hosts\\](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withKubeletConfig(com.azure.resourcemanager.containerservice.models.KubeletConfig)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withKubeletConfig(KubeletConfig kubeletConfig)"
name: "withKubeletConfig(KubeletConfig kubeletConfig)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withKubeletConfig(KubeletConfig kubeletConfig)"
summary: "Set the kubelet<wbr>Config property: The Kubelet configuration on the agent pool nodes."
parameters:
- description: "the kubeletConfig value to set."
name: "kubeletConfig"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.KubeletConfig?alt=com.azure.resourcemanager.containerservice.models.KubeletConfig&text=KubeletConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withKubeletConfig(KubeletConfig kubeletConfig)"
desc: "Set the kubeletConfig property: The Kubelet configuration on the agent pool nodes."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withKubeletDiskType(com.azure.resourcemanager.containerservice.models.KubeletDiskType)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withKubeletDiskType(KubeletDiskType kubeletDiskType)"
name: "withKubeletDiskType(KubeletDiskType kubeletDiskType)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withKubeletDiskType(KubeletDiskType kubeletDiskType)"
summary: "Set the kubelet<wbr>Disk<wbr>Type property: Determines the placement of empty<wbr>Dir volumes, container runtime data root, and Kubelet ephemeral storage."
parameters:
- description: "the kubeletDiskType value to set."
name: "kubeletDiskType"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.KubeletDiskType?alt=com.azure.resourcemanager.containerservice.models.KubeletDiskType&text=KubeletDiskType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withKubeletDiskType(KubeletDiskType kubeletDiskType)"
desc: "Set the kubeletDiskType property: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withLinuxOSConfig(com.azure.resourcemanager.containerservice.models.LinuxOSConfig)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withLinuxOSConfig(LinuxOSConfig linuxOSConfig)"
name: "withLinuxOSConfig(LinuxOSConfig linuxOSConfig)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withLinuxOSConfig(LinuxOSConfig linuxOSConfig)"
summary: "Set the linux<wbr>OSConfig property: The OS configuration of Linux agent nodes."
parameters:
- description: "the linuxOSConfig value to set."
name: "linuxOSConfig"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.LinuxOSConfig?alt=com.azure.resourcemanager.containerservice.models.LinuxOSConfig&text=LinuxOSConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withLinuxOSConfig(LinuxOSConfig linuxOSConfig)"
desc: "Set the linuxOSConfig property: The OS configuration of Linux agent nodes."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withMaxCount(java.lang.Integer)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withMaxCount(Integer maxCount)"
name: "withMaxCount(Integer maxCount)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withMaxCount(Integer maxCount)"
summary: "Set the max<wbr>Count property: The maximum number of nodes for auto-scaling."
parameters:
- description: "the maxCount value to set."
name: "maxCount"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withMaxCount(Integer maxCount)"
desc: "Set the maxCount property: The maximum number of nodes for auto-scaling."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withMaxPods(java.lang.Integer)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withMaxPods(Integer maxPods)"
name: "withMaxPods(Integer maxPods)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withMaxPods(Integer maxPods)"
summary: "Set the max<wbr>Pods property: The maximum number of pods that can run on a node."
parameters:
- description: "the maxPods value to set."
name: "maxPods"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withMaxPods(Integer maxPods)"
desc: "Set the maxPods property: The maximum number of pods that can run on a node."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withMinCount(java.lang.Integer)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withMinCount(Integer minCount)"
name: "withMinCount(Integer minCount)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withMinCount(Integer minCount)"
summary: "Set the min<wbr>Count property: The minimum number of nodes for auto-scaling."
parameters:
- description: "the minCount value to set."
name: "minCount"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withMinCount(Integer minCount)"
desc: "Set the minCount property: The minimum number of nodes for auto-scaling."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withMode(com.azure.resourcemanager.containerservice.models.AgentPoolMode)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withMode(AgentPoolMode mode)"
name: "withMode(AgentPoolMode mode)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withMode(AgentPoolMode mode)"
summary: "Set the mode property: A cluster must have at least one 'System' Agent Pool at all times."
parameters:
- description: "the mode value to set."
name: "mode"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolMode?alt=com.azure.resourcemanager.containerservice.models.AgentPoolMode&text=AgentPoolMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withMode(AgentPoolMode mode)"
desc: "Set the mode property: 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."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withNetworkProfile(com.azure.resourcemanager.containerservice.models.AgentPoolNetworkProfile)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withNetworkProfile(AgentPoolNetworkProfile networkProfile)"
name: "withNetworkProfile(AgentPoolNetworkProfile networkProfile)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withNetworkProfile(AgentPoolNetworkProfile networkProfile)"
summary: "Set the network<wbr>Profile property: Network-related settings of an agent pool."
parameters:
- description: "the networkProfile value to set."
name: "networkProfile"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolNetworkProfile?alt=com.azure.resourcemanager.containerservice.models.AgentPoolNetworkProfile&text=AgentPoolNetworkProfile\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withNetworkProfile(AgentPoolNetworkProfile networkProfile)"
desc: "Set the networkProfile property: Network-related settings of an agent pool."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withNodeLabels(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withNodeLabels(Map<String,String> nodeLabels)"
name: "withNodeLabels(Map<String,String> nodeLabels)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withNodeLabels(Map<String,String> nodeLabels)"
summary: "Set the node<wbr>Labels property: The node labels to be persisted across all nodes in agent pool."
parameters:
- description: "the nodeLabels value to set."
name: "nodeLabels"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public ManagedClusterAgentPoolProfileProperties withNodeLabels(Map<String,String> nodeLabels)"
desc: "Set the nodeLabels property: The node labels to be persisted across all nodes in agent pool."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withNodePublicIpPrefixId(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withNodePublicIpPrefixId(String nodePublicIpPrefixId)"
name: "withNodePublicIpPrefixId(String nodePublicIpPrefixId)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withNodePublicIpPrefixId(String nodePublicIpPrefixId)"
summary: "Set the node<wbr>Public<wbr>IpPrefix<wbr>Id property: This is of the form: /subscriptions/\\{subscription<wbr>Id\\}/resource<wbr>Groups/\\{resource<wbr>Group<wbr>Name\\}/providers/Microsoft.<wbr>Network/public<wbr>IPPrefixes/\\{public<wbr>IPPrefix<wbr>Name\\}."
parameters:
- description: "the nodePublicIpPrefixId value to set."
name: "nodePublicIpPrefixId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withNodePublicIpPrefixId(String nodePublicIpPrefixId)"
desc: "Set the nodePublicIpPrefixId property: This is of the form: /subscriptions/\\{subscriptionId\\}/resourceGroups/\\{resourceGroupName\\}/providers/Microsoft.Network/publicIPPrefixes/\\{publicIPPrefixName\\}."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withNodeTaints(java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withNodeTaints(List<String> nodeTaints)"
name: "withNodeTaints(List<String> nodeTaints)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withNodeTaints(List<String> nodeTaints)"
summary: "Set the node<wbr>Taints property: The taints added to new nodes during node pool create and scale."
parameters:
- description: "the nodeTaints value to set."
name: "nodeTaints"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public ManagedClusterAgentPoolProfileProperties withNodeTaints(List<String> nodeTaints)"
desc: "Set the nodeTaints property: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOrchestratorVersion(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOrchestratorVersion(String orchestratorVersion)"
name: "withOrchestratorVersion(String orchestratorVersion)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOrchestratorVersion(String orchestratorVersion)"
summary: "Set the orchestrator<wbr>Version property: Both patch version <major.<wbr>minor.<wbr>patch> (e.<wbr>g."
parameters:
- description: "the orchestratorVersion value to set."
name: "orchestratorVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withOrchestratorVersion(String orchestratorVersion)"
desc: "Set the orchestratorVersion property: 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\\](https://docs.microsoft.com/azure/aks/use-multiple-node-pools\\#upgrade-a-node-pool)."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOsDiskSizeGB(java.lang.Integer)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOsDiskSizeGB(Integer osDiskSizeGB)"
name: "withOsDiskSizeGB(Integer osDiskSizeGB)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOsDiskSizeGB(Integer osDiskSizeGB)"
summary: "Set the os<wbr>Disk<wbr>SizeGB property: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool."
parameters:
- description: "the osDiskSizeGB value to set."
name: "osDiskSizeGB"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withOsDiskSizeGB(Integer osDiskSizeGB)"
desc: "Set the osDiskSizeGB property: 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."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOsDiskType(com.azure.resourcemanager.containerservice.models.OSDiskType)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOsDiskType(OSDiskType osDiskType)"
name: "withOsDiskType(OSDiskType osDiskType)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOsDiskType(OSDiskType osDiskType)"
summary: "Set the os<wbr>Disk<wbr>Type property: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDisk<wbr>SizeGB."
parameters:
- description: "the osDiskType value to set."
name: "osDiskType"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.OSDiskType?alt=com.azure.resourcemanager.containerservice.models.OSDiskType&text=OSDiskType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withOsDiskType(OSDiskType osDiskType)"
desc: "Set the osDiskType property: 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\\](https://docs.microsoft.com/azure/aks/cluster-configuration\\#ephemeral-os)."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOsSku(com.azure.resourcemanager.containerservice.models.OSSku)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOsSku(OSSku osSku)"
name: "withOsSku(OSSku osSku)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOsSku(OSSku osSku)"
summary: "Set the os<wbr>Sku property: Specifies the OS SKU used by the agent pool."
parameters:
- description: "the osSku value to set."
name: "osSku"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.OSSku?alt=com.azure.resourcemanager.containerservice.models.OSSku&text=OSSku\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withOsSku(OSSku osSku)"
desc: "Set the osSku property: 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."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOsType(com.azure.resourcemanager.containerservice.models.OSType)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withOsType(OSType osType)"
name: "withOsType(OSType osType)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOsType(OSType osType)"
summary: "Set the os<wbr>Type property: Os<wbr>Type to be used to specify os type."
parameters:
- description: "the osType value to set."
name: "osType"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.OSType?alt=com.azure.resourcemanager.containerservice.models.OSType&text=OSType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withOsType(OSType osType)"
desc: "Set the osType property: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withPodSubnetId(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withPodSubnetId(String podSubnetId)"
name: "withPodSubnetId(String podSubnetId)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withPodSubnetId(String podSubnetId)"
summary: "Set the pod<wbr>Subnet<wbr>Id property: If omitted, pod IPs are statically assigned on the node subnet (see vnet<wbr>SubnetID for more details)."
parameters:
- description: "the podSubnetId value to set."
name: "podSubnetId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withPodSubnetId(String podSubnetId)"
desc: "Set the podSubnetId property: 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\\}."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withPowerState(com.azure.resourcemanager.containerservice.models.PowerState)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withPowerState(PowerState powerState)"
name: "withPowerState(PowerState powerState)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withPowerState(PowerState powerState)"
summary: "Set the power<wbr>State property: When an Agent Pool is first created it is initially Running."
parameters:
- description: "the powerState value to set."
name: "powerState"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.PowerState?alt=com.azure.resourcemanager.containerservice.models.PowerState&text=PowerState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withPowerState(PowerState powerState)"
desc: "Set the powerState property: 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."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withProximityPlacementGroupId(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withProximityPlacementGroupId(String proximityPlacementGroupId)"
name: "withProximityPlacementGroupId(String proximityPlacementGroupId)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withProximityPlacementGroupId(String proximityPlacementGroupId)"
summary: "Set the proximity<wbr>Placement<wbr>Group<wbr>Id property: The ID for Proximity Placement Group."
parameters:
- description: "the proximityPlacementGroupId value to set."
name: "proximityPlacementGroupId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withProximityPlacementGroupId(String proximityPlacementGroupId)"
desc: "Set the proximityPlacementGroupId property: The ID for Proximity Placement Group."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withScaleDownMode(com.azure.resourcemanager.containerservice.models.ScaleDownMode)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withScaleDownMode(ScaleDownMode scaleDownMode)"
name: "withScaleDownMode(ScaleDownMode scaleDownMode)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withScaleDownMode(ScaleDownMode scaleDownMode)"
summary: "Set the scale<wbr>Down<wbr>Mode property: This also effects the cluster autoscaler behavior."
parameters:
- description: "the scaleDownMode value to set."
name: "scaleDownMode"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.ScaleDownMode?alt=com.azure.resourcemanager.containerservice.models.ScaleDownMode&text=ScaleDownMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withScaleDownMode(ScaleDownMode scaleDownMode)"
desc: "Set the scaleDownMode property: This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withScaleSetEvictionPolicy(com.azure.resourcemanager.containerservice.models.ScaleSetEvictionPolicy)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)"
name: "withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)"
summary: "Set the scale<wbr>Set<wbr>Eviction<wbr>Policy property: This cannot be specified unless the scale<wbr>Set<wbr>Priority is 'Spot'."
parameters:
- description: "the scaleSetEvictionPolicy value to set."
name: "scaleSetEvictionPolicy"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.ScaleSetEvictionPolicy?alt=com.azure.resourcemanager.containerservice.models.ScaleSetEvictionPolicy&text=ScaleSetEvictionPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)"
desc: "Set the scaleSetEvictionPolicy property: This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withScaleSetPriority(com.azure.resourcemanager.containerservice.models.ScaleSetPriority)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withScaleSetPriority(ScaleSetPriority scaleSetPriority)"
name: "withScaleSetPriority(ScaleSetPriority scaleSetPriority)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withScaleSetPriority(ScaleSetPriority scaleSetPriority)"
summary: "Set the scale<wbr>Set<wbr>Priority property: The Virtual Machine Scale Set priority."
parameters:
- description: "the scaleSetPriority value to set."
name: "scaleSetPriority"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.ScaleSetPriority?alt=com.azure.resourcemanager.containerservice.models.ScaleSetPriority&text=ScaleSetPriority\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withScaleSetPriority(ScaleSetPriority scaleSetPriority)"
desc: "Set the scaleSetPriority property: The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withSpotMaxPrice(java.lang.Float)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withSpotMaxPrice(Float spotMaxPrice)"
name: "withSpotMaxPrice(Float spotMaxPrice)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withSpotMaxPrice(Float spotMaxPrice)"
summary: "Set the spot<wbr>Max<wbr>Price property: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price."
parameters:
- description: "the spotMaxPrice value to set."
name: "spotMaxPrice"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withSpotMaxPrice(Float spotMaxPrice)"
desc: "Set the spotMaxPrice property: 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\\](https://docs.microsoft.com/azure/virtual-machines/spot-vms\\#pricing)."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withTags(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withTags(Map<String,String> tags)"
name: "withTags(Map<String,String> tags)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withTags(Map<String,String> tags)"
summary: "Set the tags property: The tags to be persisted on the agent pool virtual machine scale set."
parameters:
- description: "the tags value to set."
name: "tags"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public ManagedClusterAgentPoolProfileProperties withTags(Map<String,String> tags)"
desc: "Set the tags property: The tags to be persisted on the agent pool virtual machine scale set."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withType(com.azure.resourcemanager.containerservice.models.AgentPoolType)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withType(AgentPoolType type)"
name: "withType(AgentPoolType type)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withType(AgentPoolType type)"
summary: "Set the type property: The type of Agent Pool."
parameters:
- description: "the type value to set."
name: "type"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolType?alt=com.azure.resourcemanager.containerservice.models.AgentPoolType&text=AgentPoolType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withType(AgentPoolType type)"
desc: "Set the type property: The type of Agent Pool."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withUpgradeSettings(com.azure.resourcemanager.containerservice.models.AgentPoolUpgradeSettings)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)"
name: "withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)"
summary: "Set the upgrade<wbr>Settings property: Settings for upgrading the agentpool."
parameters:
- description: "the upgradeSettings value to set."
name: "upgradeSettings"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolUpgradeSettings?alt=com.azure.resourcemanager.containerservice.models.AgentPoolUpgradeSettings&text=AgentPoolUpgradeSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)"
desc: "Set the upgradeSettings property: Settings for upgrading the agentpool."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withVmSize(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withVmSize(String vmSize)"
name: "withVmSize(String vmSize)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withVmSize(String vmSize)"
summary: "Set the vm<wbr>Size property: VM size availability varies by region."
parameters:
- description: "the vmSize value to set."
name: "vmSize"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withVmSize(String vmSize)"
desc: "Set the vmSize property: 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."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withVnetSubnetId(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withVnetSubnetId(String vnetSubnetId)"
name: "withVnetSubnetId(String vnetSubnetId)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withVnetSubnetId(String vnetSubnetId)"
summary: "Set the vnet<wbr>Subnet<wbr>Id property: If this is not specified, a VNET and subnet will be generated and used."
parameters:
- description: "the vnetSubnetId value to set."
name: "vnetSubnetId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedClusterAgentPoolProfileProperties withVnetSubnetId(String vnetSubnetId)"
desc: "Set the vnetSubnetId property: 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\\}."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withWindowsProfile(com.azure.resourcemanager.containerservice.models.AgentPoolWindowsProfile)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withWindowsProfile(AgentPoolWindowsProfile windowsProfile)"
name: "withWindowsProfile(AgentPoolWindowsProfile windowsProfile)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withWindowsProfile(AgentPoolWindowsProfile windowsProfile)"
summary: "Set the windows<wbr>Profile property: The Windows agent pool's specific profile."
parameters:
- description: "the windowsProfile value to set."
name: "windowsProfile"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolWindowsProfile?alt=com.azure.resourcemanager.containerservice.models.AgentPoolWindowsProfile&text=AgentPoolWindowsProfile\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withWindowsProfile(AgentPoolWindowsProfile windowsProfile)"
desc: "Set the windowsProfile property: The Windows agent pool's specific profile."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withWorkloadRuntime(com.azure.resourcemanager.containerservice.models.WorkloadRuntime)"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.withWorkloadRuntime(WorkloadRuntime workloadRuntime)"
name: "withWorkloadRuntime(WorkloadRuntime workloadRuntime)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withWorkloadRuntime(WorkloadRuntime workloadRuntime)"
summary: "Set the workload<wbr>Runtime property: Determines the type of workload a node can run."
parameters:
- description: "the workloadRuntime value to set."
name: "workloadRuntime"
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.WorkloadRuntime?alt=com.azure.resourcemanager.containerservice.models.WorkloadRuntime&text=WorkloadRuntime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withWorkloadRuntime(WorkloadRuntime workloadRuntime)"
desc: "Set the workloadRuntime property: Determines the type of workload a node can run."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.workloadRuntime()"
fullName: "com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties.workloadRuntime()"
name: "workloadRuntime()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.workloadRuntime()"
summary: "Get the workload<wbr>Runtime property: Determines the type of workload a node can run."
syntax: "public WorkloadRuntime workloadRuntime()"
desc: "Get the workloadRuntime property: Determines the type of workload a node can run."
returns:
description: "the workloadRuntime value."
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.WorkloadRuntime?alt=com.azure.resourcemanager.containerservice.models.WorkloadRuntime&text=WorkloadRuntime\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Properties for the container service agent pool profile."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties?alt=com.azure.resourcemanager.containerservice.fluent.models.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.containerservice.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-containerservice:2.42.0