azure-docs-sdk-java/legacy/docs-ref-autogen/com.microsoft.azure.managem...

618 строки
62 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties"
fullName: "com.microsoft.azure.management.containerservice.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: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **ManagedClusterAgentPoolProfileProperties**"
constructors:
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.ManagedClusterAgentPoolProfileProperties()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.ManagedClusterAgentPoolProfileProperties()"
name: "ManagedClusterAgentPoolProfileProperties()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.ManagedClusterAgentPoolProfileProperties()"
syntax: "public ManagedClusterAgentPoolProfileProperties()"
methods:
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.availabilityZones()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.availabilityZones()"
name: "availabilityZones()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.availabilityZones()"
summary: "Get availability zones for nodes."
syntax: "public List<String> availabilityZones()"
desc: "Get availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType."
returns:
description: "the availabilityZones value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.count()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.count()"
name: "count()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.count()"
summary: "Get number of agents (VMs) to host docker containers."
syntax: "public Integer count()"
desc: "Get number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1."
returns:
description: "the count value"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.enableAutoScaling()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.enableAutoScaling()"
name: "enableAutoScaling()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.enableAutoScaling()"
summary: "Get whether to enable auto-scaler."
syntax: "public Boolean enableAutoScaling()"
desc: "Get whether to enable auto-scaler."
returns:
description: "the enableAutoScaling value"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.enableNodePublicIP()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.enableNodePublicIP()"
name: "enableNodePublicIP()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.enableNodePublicIP()"
summary: "Get enable public IP for nodes."
syntax: "public Boolean enableNodePublicIP()"
desc: "Get enable public IP for nodes."
returns:
description: "the enableNodePublicIP value"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.maxCount()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.maxCount()"
name: "maxCount()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.maxCount()"
summary: "Get maximum number of nodes for auto-scaling."
syntax: "public Integer maxCount()"
desc: "Get maximum number of nodes for auto-scaling."
returns:
description: "the maxCount value"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.maxPods()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.maxPods()"
name: "maxPods()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.maxPods()"
summary: "Get maximum number of pods that can run on a node."
syntax: "public Integer maxPods()"
desc: "Get maximum number of pods that can run on a node."
returns:
description: "the maxPods value"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.minCount()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.minCount()"
name: "minCount()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.minCount()"
summary: "Get minimum number of nodes for auto-scaling."
syntax: "public Integer minCount()"
desc: "Get minimum number of nodes for auto-scaling."
returns:
description: "the minCount value"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.mode()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.mode()"
name: "mode()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.mode()"
summary: "Get agent<wbr>Pool<wbr>Mode represents mode of an agent pool."
syntax: "public AgentPoolMode mode()"
desc: "Get agentPoolMode represents mode of an agent pool. Possible values include: 'System', 'User'."
returns:
description: "the mode value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.AgentPoolMode?alt=com.microsoft.azure.management.containerservice.AgentPoolMode&text=AgentPoolMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.nodeImageVersion()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.nodeImageVersion()"
name: "nodeImageVersion()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.nodeImageVersion()"
summary: "Get version of node image."
syntax: "public String nodeImageVersion()"
desc: "Get version of node image."
returns:
description: "the nodeImageVersion value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.nodeLabels()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.nodeLabels()"
name: "nodeLabels()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.nodeLabels()"
summary: "Get agent pool node labels to be persisted across all nodes in agent pool."
syntax: "public Map<String,String> nodeLabels()"
desc: "Get agent pool node labels to be persisted across all nodes in agent pool."
returns:
description: "the nodeLabels value"
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.nodeTaints()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.nodeTaints()"
name: "nodeTaints()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.nodeTaints()"
summary: "Get taints added to new nodes during node pool create and scale."
syntax: "public List<String> nodeTaints()"
desc: "Get taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
returns:
description: "the nodeTaints value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.orchestratorVersion()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.orchestratorVersion()"
name: "orchestratorVersion()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.orchestratorVersion()"
summary: "Get version of orchestrator specified when creating the managed cluster."
syntax: "public String orchestratorVersion()"
desc: "Get version of orchestrator specified when creating the managed cluster."
returns:
description: "the orchestratorVersion value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.osDiskSizeGB()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.osDiskSizeGB()"
name: "osDiskSizeGB()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.osDiskSizeGB()"
summary: "Get oS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool."
syntax: "public Integer osDiskSizeGB()"
desc: "Get oS Disk Size in GB to be used to specify the disk size for every machine in this 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: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.osDiskType()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.osDiskType()"
name: "osDiskType()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.osDiskType()"
summary: "Get oS disk type to be used for machines in a given agent pool."
syntax: "public OSDiskType osDiskType()"
desc: "Get oS disk type to be used for machines in a given agent pool. Allowed values are 'Ephemeral' and 'Managed'. Defaults to 'Managed'. May not be changed after creation. Possible values include: 'Managed', 'Ephemeral'."
returns:
description: "the osDiskType value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.OSDiskType?alt=com.microsoft.azure.management.containerservice.OSDiskType&text=OSDiskType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.osType()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.osType()"
name: "osType()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.osType()"
summary: "Get os<wbr>Type to be used to specify os type."
syntax: "public OSType osType()"
desc: "Get osType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'."
returns:
description: "the osType value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.OSType?alt=com.microsoft.azure.management.containerservice.OSType&text=OSType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.powerState()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.powerState()"
name: "powerState()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.powerState()"
summary: "Get describes whether the Agent Pool is Running or Stopped."
syntax: "public PowerState powerState()"
desc: "Get describes whether the Agent Pool is Running or Stopped."
returns:
description: "the powerState value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.PowerState?alt=com.microsoft.azure.management.containerservice.PowerState&text=PowerState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.provisioningState()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.provisioningState()"
name: "provisioningState()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.provisioningState()"
summary: "Get the current deployment or provisioning state, which only appears in the response."
syntax: "public String provisioningState()"
desc: "Get the current deployment or provisioning state, which only appears in the response."
returns:
description: "the provisioningState value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID()"
name: "proximityPlacementGroupID()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID()"
summary: "Get the ID for Proximity Placement Group."
syntax: "public String proximityPlacementGroupID()"
desc: "Get the ID for Proximity Placement Group."
returns:
description: "the proximityPlacementGroupID value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy()"
name: "scaleSetEvictionPolicy()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy()"
summary: "Get scale<wbr>Set<wbr>Eviction<wbr>Policy to be used to specify eviction policy for Spot virtual machine scale set."
syntax: "public ScaleSetEvictionPolicy scaleSetEvictionPolicy()"
desc: "Get scaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. Possible values include: 'Delete', 'Deallocate'."
returns:
description: "the scaleSetEvictionPolicy value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.ScaleSetEvictionPolicy?alt=com.microsoft.azure.management.containerservice.ScaleSetEvictionPolicy&text=ScaleSetEvictionPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.scaleSetPriority()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.scaleSetPriority()"
name: "scaleSetPriority()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.scaleSetPriority()"
summary: "Get scale<wbr>Set<wbr>Priority to be used to specify virtual machine scale set priority."
syntax: "public ScaleSetPriority scaleSetPriority()"
desc: "Get scaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. Possible values include: 'Spot', 'Regular'."
returns:
description: "the scaleSetPriority value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.ScaleSetPriority?alt=com.microsoft.azure.management.containerservice.ScaleSetPriority&text=ScaleSetPriority\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.spotMaxPrice()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.spotMaxPrice()"
name: "spotMaxPrice()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.spotMaxPrice()"
summary: "Get spot<wbr>Max<wbr>Price to be used to specify the maximum price you are willing to pay in US Dollars."
syntax: "public Double spotMaxPrice()"
desc: "Get spotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand."
returns:
description: "the spotMaxPrice value"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.tags()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.tags()"
name: "tags()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.tags()"
summary: "Get agent pool tags to be persisted on the agent pool virtual machine scale set."
syntax: "public Map<String,String> tags()"
desc: "Get agent pool tags to be persisted on the agent pool virtual machine scale set."
returns:
description: "the tags value"
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.type()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.type()"
name: "type()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.type()"
summary: "Get agent<wbr>Pool<wbr>Type represents types of an agent pool."
syntax: "public AgentPoolType type()"
desc: "Get agentPoolType represents types of an agent pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet'."
returns:
description: "the type value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.AgentPoolType?alt=com.microsoft.azure.management.containerservice.AgentPoolType&text=AgentPoolType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.upgradeSettings()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.upgradeSettings()"
name: "upgradeSettings()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.upgradeSettings()"
summary: "Get settings for upgrading the agentpool."
syntax: "public AgentPoolUpgradeSettings upgradeSettings()"
desc: "Get settings for upgrading the agentpool."
returns:
description: "the upgradeSettings value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.AgentPoolUpgradeSettings?alt=com.microsoft.azure.management.containerservice.AgentPoolUpgradeSettings&text=AgentPoolUpgradeSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.vmSize()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.vmSize()"
name: "vmSize()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.vmSize()"
summary: "Get size of agent VMs."
syntax: "public ContainerServiceVMSizeTypes vmSize()"
desc: "Get size of agent VMs. Possible values include: 'Standard\\_A1', 'Standard\\_A10', 'Standard\\_A11', 'Standard\\_A1\\_v2', 'Standard\\_A2', 'Standard\\_A2\\_v2', 'Standard\\_A2m\\_v2', 'Standard\\_A3', 'Standard\\_A4', 'Standard\\_A4\\_v2', 'Standard\\_A4m\\_v2', 'Standard\\_A5', 'Standard\\_A6', 'Standard\\_A7', 'Standard\\_A8', 'Standard\\_A8\\_v2', 'Standard\\_A8m\\_v2', 'Standard\\_A9', 'Standard\\_B2ms', 'Standard\\_B2s', 'Standard\\_B4ms', 'Standard\\_B8ms', 'Standard\\_D1', 'Standard\\_D11', 'Standard\\_D11\\_v2', 'Standard\\_D11\\_v2\\_Promo', 'Standard\\_D12', 'Standard\\_D12\\_v2', 'Standard\\_D12\\_v2\\_Promo', 'Standard\\_D13', 'Standard\\_D13\\_v2', 'Standard\\_D13\\_v2\\_Promo', 'Standard\\_D14', 'Standard\\_D14\\_v2', 'Standard\\_D14\\_v2\\_Promo', 'Standard\\_D15\\_v2', 'Standard\\_D16\\_v3', 'Standard\\_D16s\\_v3', 'Standard\\_D1\\_v2', 'Standard\\_D2', 'Standard\\_D2\\_v2', 'Standard\\_D2\\_v2\\_Promo', 'Standard\\_D2\\_v3', 'Standard\\_D2s\\_v3', 'Standard\\_D3', 'Standard\\_D32\\_v3', 'Standard\\_D32s\\_v3', 'Standard\\_D3\\_v2', 'Standard\\_D3\\_v2\\_Promo', 'Standard\\_D4', 'Standard\\_D4\\_v2', 'Standard\\_D4\\_v2\\_Promo', 'Standard\\_D4\\_v3', 'Standard\\_D4s\\_v3', 'Standard\\_D5\\_v2', 'Standard\\_D5\\_v2\\_Promo', 'Standard\\_D64\\_v3', 'Standard\\_D64s\\_v3', 'Standard\\_D8\\_v3', 'Standard\\_D8s\\_v3', 'Standard\\_DS1', 'Standard\\_DS11', 'Standard\\_DS11\\_v2', 'Standard\\_DS11\\_v2\\_Promo', 'Standard\\_DS12', 'Standard\\_DS12\\_v2', 'Standard\\_DS12\\_v2\\_Promo', 'Standard\\_DS13', 'Standard\\_DS13-2\\_v2', 'Standard\\_DS13-4\\_v2', 'Standard\\_DS13\\_v2', 'Standard\\_DS13\\_v2\\_Promo', 'Standard\\_DS14', 'Standard\\_DS14-4\\_v2', 'Standard\\_DS14-8\\_v2', 'Standard\\_DS14\\_v2', 'Standard\\_DS14\\_v2\\_Promo', 'Standard\\_DS15\\_v2', 'Standard\\_DS1\\_v2', 'Standard\\_DS2', 'Standard\\_DS2\\_v2', 'Standard\\_DS2\\_v2\\_Promo', 'Standard\\_DS3', 'Standard\\_DS3\\_v2', 'Standard\\_DS3\\_v2\\_Promo', 'Standard\\_DS4', 'Standard\\_DS4\\_v2', 'Standard\\_DS4\\_v2\\_Promo', 'Standard\\_DS5\\_v2', 'Standard\\_DS5\\_v2\\_Promo', 'Standard\\_E16\\_v3', 'Standard\\_E16s\\_v3', 'Standard\\_E2\\_v3', 'Standard\\_E2s\\_v3', 'Standard\\_E32-16s\\_v3', 'Standard\\_E32-8s\\_v3', 'Standard\\_E32\\_v3', 'Standard\\_E32s\\_v3', 'Standard\\_E4\\_v3', 'Standard\\_E4s\\_v3', 'Standard\\_E64-16s\\_v3', 'Standard\\_E64-32s\\_v3', 'Standard\\_E64\\_v3', 'Standard\\_E64s\\_v3', 'Standard\\_E8\\_v3', 'Standard\\_E8s\\_v3', 'Standard\\_F1', 'Standard\\_F16', 'Standard\\_F16s', 'Standard\\_F16s\\_v2', 'Standard\\_F1s', 'Standard\\_F2', 'Standard\\_F2s', 'Standard\\_F2s\\_v2', 'Standard\\_F32s\\_v2', 'Standard\\_F4', 'Standard\\_F4s', 'Standard\\_F4s\\_v2', 'Standard\\_F64s\\_v2', 'Standard\\_F72s\\_v2', 'Standard\\_F8', 'Standard\\_F8s', 'Standard\\_F8s\\_v2', 'Standard\\_G1', 'Standard\\_G2', 'Standard\\_G3', 'Standard\\_G4', 'Standard\\_G5', 'Standard\\_GS1', 'Standard\\_GS2', 'Standard\\_GS3', 'Standard\\_GS4', 'Standard\\_GS4-4', 'Standard\\_GS4-8', 'Standard\\_GS5', 'Standard\\_GS5-16', 'Standard\\_GS5-8', 'Standard\\_H16', 'Standard\\_H16m', 'Standard\\_H16mr', 'Standard\\_H16r', 'Standard\\_H8', 'Standard\\_H8m', 'Standard\\_L16s', 'Standard\\_L32s', 'Standard\\_L4s', 'Standard\\_L8s', 'Standard\\_M128-32ms', 'Standard\\_M128-64ms', 'Standard\\_M128ms', 'Standard\\_M128s', 'Standard\\_M64-16ms', 'Standard\\_M64-32ms', 'Standard\\_M64ms', 'Standard\\_M64s', 'Standard\\_NC12', 'Standard\\_NC12s\\_v2', 'Standard\\_NC12s\\_v3', 'Standard\\_NC24', 'Standard\\_NC24r', 'Standard\\_NC24rs\\_v2', 'Standard\\_NC24rs\\_v3', 'Standard\\_NC24s\\_v2', 'Standard\\_NC24s\\_v3', 'Standard\\_NC6', 'Standard\\_NC6s\\_v2', 'Standard\\_NC6s\\_v3', 'Standard\\_ND12s', 'Standard\\_ND24rs', 'Standard\\_ND24s', 'Standard\\_ND6s', 'Standard\\_NV12', 'Standard\\_NV24', 'Standard\\_NV6'."
returns:
description: "the vmSize value"
type: "<xref href=\"com.microsoft.azure.management.containerservice.ContainerServiceVMSizeTypes?alt=com.microsoft.azure.management.containerservice.ContainerServiceVMSizeTypes&text=ContainerServiceVMSizeTypes\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.vnetSubnetID()"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.vnetSubnetID()"
name: "vnetSubnetID()"
nameWithType: "ManagedClusterAgentPoolProfileProperties.vnetSubnetID()"
summary: "Get v<wbr>Net SubnetID specifies the VNet's subnet identifier."
syntax: "public String vnetSubnetID()"
desc: "Get vNet SubnetID specifies the VNet's subnet identifier."
returns:
description: "the vnetSubnetID value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withAvailabilityZones(java.util.List<java.lang.String>)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withAvailabilityZones(List<String> availabilityZones)"
name: "withAvailabilityZones(List<String> availabilityZones)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withAvailabilityZones(List<String> availabilityZones)"
summary: "Set availability zones for nodes."
parameters:
- description: "the availabilityZones value to set"
name: "availabilityZones"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public ManagedClusterAgentPoolProfileProperties withAvailabilityZones(List<String> availabilityZones)"
desc: "Set availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withCount(java.lang.Integer)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withCount(Integer count)"
name: "withCount(Integer count)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withCount(Integer count)"
summary: "Set number of agents (VMs) to host docker containers."
parameters:
- description: "the count value to set"
name: "count"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withCount(Integer count)"
desc: "Set number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withEnableAutoScaling(java.lang.Boolean)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withEnableAutoScaling(Boolean enableAutoScaling)"
name: "withEnableAutoScaling(Boolean enableAutoScaling)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withEnableAutoScaling(Boolean enableAutoScaling)"
summary: "Set whether to enable auto-scaler."
parameters:
- description: "the enableAutoScaling value to set"
name: "enableAutoScaling"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withEnableAutoScaling(Boolean enableAutoScaling)"
desc: "Set whether to enable auto-scaler."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withEnableNodePublicIP(java.lang.Boolean)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withEnableNodePublicIP(Boolean enableNodePublicIP)"
name: "withEnableNodePublicIP(Boolean enableNodePublicIP)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withEnableNodePublicIP(Boolean enableNodePublicIP)"
summary: "Set enable public IP for nodes."
parameters:
- description: "the enableNodePublicIP value to set"
name: "enableNodePublicIP"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withEnableNodePublicIP(Boolean enableNodePublicIP)"
desc: "Set enable public IP for nodes."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withMaxCount(java.lang.Integer)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withMaxCount(Integer maxCount)"
name: "withMaxCount(Integer maxCount)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withMaxCount(Integer maxCount)"
summary: "Set maximum number of nodes for auto-scaling."
parameters:
- description: "the maxCount value to set"
name: "maxCount"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withMaxCount(Integer maxCount)"
desc: "Set maximum number of nodes for auto-scaling."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withMaxPods(java.lang.Integer)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withMaxPods(Integer maxPods)"
name: "withMaxPods(Integer maxPods)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withMaxPods(Integer maxPods)"
summary: "Set maximum number of pods that can run on a node."
parameters:
- description: "the maxPods value to set"
name: "maxPods"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withMaxPods(Integer maxPods)"
desc: "Set maximum number of pods that can run on a node."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withMinCount(java.lang.Integer)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withMinCount(Integer minCount)"
name: "withMinCount(Integer minCount)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withMinCount(Integer minCount)"
summary: "Set minimum number of nodes for auto-scaling."
parameters:
- description: "the minCount value to set"
name: "minCount"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withMinCount(Integer minCount)"
desc: "Set minimum number of nodes for auto-scaling."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withMode(com.microsoft.azure.management.containerservice.AgentPoolMode)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withMode(AgentPoolMode mode)"
name: "withMode(AgentPoolMode mode)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withMode(AgentPoolMode mode)"
summary: "Set agent<wbr>Pool<wbr>Mode represents mode of an agent pool."
parameters:
- description: "the mode value to set"
name: "mode"
type: "<xref href=\"com.microsoft.azure.management.containerservice.AgentPoolMode?alt=com.microsoft.azure.management.containerservice.AgentPoolMode&text=AgentPoolMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withMode(AgentPoolMode mode)"
desc: "Set agentPoolMode represents mode of an agent pool. Possible values include: 'System', 'User'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withNodeLabels(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withNodeLabels(Map<String,String> nodeLabels)"
name: "withNodeLabels(Map<String,String> nodeLabels)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withNodeLabels(Map<String,String> nodeLabels)"
summary: "Set agent pool node labels to be persisted across all nodes in agent pool."
parameters:
- description: "the nodeLabels value to set"
name: "nodeLabels"
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public ManagedClusterAgentPoolProfileProperties withNodeLabels(Map<String,String> nodeLabels)"
desc: "Set agent pool node labels to be persisted across all nodes in agent pool."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withNodeTaints(java.util.List<java.lang.String>)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withNodeTaints(List<String> nodeTaints)"
name: "withNodeTaints(List<String> nodeTaints)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withNodeTaints(List<String> nodeTaints)"
summary: "Set taints added to new nodes during node pool create and scale."
parameters:
- description: "the nodeTaints value to set"
name: "nodeTaints"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public ManagedClusterAgentPoolProfileProperties withNodeTaints(List<String> nodeTaints)"
desc: "Set 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.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withOrchestratorVersion(java.lang.String)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withOrchestratorVersion(String orchestratorVersion)"
name: "withOrchestratorVersion(String orchestratorVersion)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOrchestratorVersion(String orchestratorVersion)"
summary: "Set version of orchestrator specified when creating the managed cluster."
parameters:
- description: "the orchestratorVersion value to set"
name: "orchestratorVersion"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withOrchestratorVersion(String orchestratorVersion)"
desc: "Set version of orchestrator specified when creating the managed cluster."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withOsDiskSizeGB(java.lang.Integer)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withOsDiskSizeGB(Integer osDiskSizeGB)"
name: "withOsDiskSizeGB(Integer osDiskSizeGB)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOsDiskSizeGB(Integer osDiskSizeGB)"
summary: "Set oS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool."
parameters:
- description: "the osDiskSizeGB value to set"
name: "osDiskSizeGB"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withOsDiskSizeGB(Integer osDiskSizeGB)"
desc: "Set oS Disk Size in GB to be used to specify the disk size for every machine in this 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.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withOsDiskType(com.microsoft.azure.management.containerservice.OSDiskType)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withOsDiskType(OSDiskType osDiskType)"
name: "withOsDiskType(OSDiskType osDiskType)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOsDiskType(OSDiskType osDiskType)"
summary: "Set oS disk type to be used for machines in a given agent pool."
parameters:
- description: "the osDiskType value to set"
name: "osDiskType"
type: "<xref href=\"com.microsoft.azure.management.containerservice.OSDiskType?alt=com.microsoft.azure.management.containerservice.OSDiskType&text=OSDiskType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withOsDiskType(OSDiskType osDiskType)"
desc: "Set oS disk type to be used for machines in a given agent pool. Allowed values are 'Ephemeral' and 'Managed'. Defaults to 'Managed'. May not be changed after creation. Possible values include: 'Managed', 'Ephemeral'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withOsType(com.microsoft.azure.management.containerservice.OSType)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withOsType(OSType osType)"
name: "withOsType(OSType osType)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withOsType(OSType osType)"
summary: "Set os<wbr>Type to be used to specify os type."
parameters:
- description: "the osType value to set"
name: "osType"
type: "<xref href=\"com.microsoft.azure.management.containerservice.OSType?alt=com.microsoft.azure.management.containerservice.OSType&text=OSType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withOsType(OSType osType)"
desc: "Set osType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withProximityPlacementGroupID(java.lang.String)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withProximityPlacementGroupID(String proximityPlacementGroupID)"
name: "withProximityPlacementGroupID(String proximityPlacementGroupID)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withProximityPlacementGroupID(String proximityPlacementGroupID)"
summary: "Set the ID for Proximity Placement Group."
parameters:
- description: "the proximityPlacementGroupID value to set"
name: "proximityPlacementGroupID"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withProximityPlacementGroupID(String proximityPlacementGroupID)"
desc: "Set the ID for Proximity Placement Group."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withScaleSetEvictionPolicy(com.microsoft.azure.management.containerservice.ScaleSetEvictionPolicy)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)"
name: "withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)"
summary: "Set scale<wbr>Set<wbr>Eviction<wbr>Policy to be used to specify eviction policy for Spot virtual machine scale set."
parameters:
- description: "the scaleSetEvictionPolicy value to set"
name: "scaleSetEvictionPolicy"
type: "<xref href=\"com.microsoft.azure.management.containerservice.ScaleSetEvictionPolicy?alt=com.microsoft.azure.management.containerservice.ScaleSetEvictionPolicy&text=ScaleSetEvictionPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withScaleSetEvictionPolicy(ScaleSetEvictionPolicy scaleSetEvictionPolicy)"
desc: "Set scaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. Possible values include: 'Delete', 'Deallocate'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withScaleSetPriority(com.microsoft.azure.management.containerservice.ScaleSetPriority)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withScaleSetPriority(ScaleSetPriority scaleSetPriority)"
name: "withScaleSetPriority(ScaleSetPriority scaleSetPriority)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withScaleSetPriority(ScaleSetPriority scaleSetPriority)"
summary: "Set scale<wbr>Set<wbr>Priority to be used to specify virtual machine scale set priority."
parameters:
- description: "the scaleSetPriority value to set"
name: "scaleSetPriority"
type: "<xref href=\"com.microsoft.azure.management.containerservice.ScaleSetPriority?alt=com.microsoft.azure.management.containerservice.ScaleSetPriority&text=ScaleSetPriority\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withScaleSetPriority(ScaleSetPriority scaleSetPriority)"
desc: "Set scaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. Possible values include: 'Spot', 'Regular'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withSpotMaxPrice(java.lang.Double)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withSpotMaxPrice(Double spotMaxPrice)"
name: "withSpotMaxPrice(Double spotMaxPrice)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withSpotMaxPrice(Double spotMaxPrice)"
summary: "Set spot<wbr>Max<wbr>Price to be used to specify the maximum price you are willing to pay in US Dollars."
parameters:
- description: "the spotMaxPrice value to set"
name: "spotMaxPrice"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withSpotMaxPrice(Double spotMaxPrice)"
desc: "Set spotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withTags(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withTags(Map<String,String> tags)"
name: "withTags(Map<String,String> tags)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withTags(Map<String,String> tags)"
summary: "Set agent pool tags to be persisted on the agent pool virtual machine scale set."
parameters:
- description: "the tags value to set"
name: "tags"
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public ManagedClusterAgentPoolProfileProperties withTags(Map<String,String> tags)"
desc: "Set agent pool tags to be persisted on the agent pool virtual machine scale set."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withType(com.microsoft.azure.management.containerservice.AgentPoolType)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withType(AgentPoolType type)"
name: "withType(AgentPoolType type)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withType(AgentPoolType type)"
summary: "Set agent<wbr>Pool<wbr>Type represents types of an agent pool."
parameters:
- description: "the type value to set"
name: "type"
type: "<xref href=\"com.microsoft.azure.management.containerservice.AgentPoolType?alt=com.microsoft.azure.management.containerservice.AgentPoolType&text=AgentPoolType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withType(AgentPoolType type)"
desc: "Set agentPoolType represents types of an agent pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withUpgradeSettings(com.microsoft.azure.management.containerservice.AgentPoolUpgradeSettings)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)"
name: "withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)"
summary: "Set settings for upgrading the agentpool."
parameters:
- description: "the upgradeSettings value to set"
name: "upgradeSettings"
type: "<xref href=\"com.microsoft.azure.management.containerservice.AgentPoolUpgradeSettings?alt=com.microsoft.azure.management.containerservice.AgentPoolUpgradeSettings&text=AgentPoolUpgradeSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withUpgradeSettings(AgentPoolUpgradeSettings upgradeSettings)"
desc: "Set settings for upgrading the agentpool."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withVmSize(com.microsoft.azure.management.containerservice.ContainerServiceVMSizeTypes)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withVmSize(ContainerServiceVMSizeTypes vmSize)"
name: "withVmSize(ContainerServiceVMSizeTypes vmSize)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withVmSize(ContainerServiceVMSizeTypes vmSize)"
summary: "Set size of agent VMs."
parameters:
- description: "the vmSize value to set"
name: "vmSize"
type: "<xref href=\"com.microsoft.azure.management.containerservice.ContainerServiceVMSizeTypes?alt=com.microsoft.azure.management.containerservice.ContainerServiceVMSizeTypes&text=ContainerServiceVMSizeTypes\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withVmSize(ContainerServiceVMSizeTypes vmSize)"
desc: "Set size of agent VMs. Possible values include: 'Standard\\_A1', 'Standard\\_A10', 'Standard\\_A11', 'Standard\\_A1\\_v2', 'Standard\\_A2', 'Standard\\_A2\\_v2', 'Standard\\_A2m\\_v2', 'Standard\\_A3', 'Standard\\_A4', 'Standard\\_A4\\_v2', 'Standard\\_A4m\\_v2', 'Standard\\_A5', 'Standard\\_A6', 'Standard\\_A7', 'Standard\\_A8', 'Standard\\_A8\\_v2', 'Standard\\_A8m\\_v2', 'Standard\\_A9', 'Standard\\_B2ms', 'Standard\\_B2s', 'Standard\\_B4ms', 'Standard\\_B8ms', 'Standard\\_D1', 'Standard\\_D11', 'Standard\\_D11\\_v2', 'Standard\\_D11\\_v2\\_Promo', 'Standard\\_D12', 'Standard\\_D12\\_v2', 'Standard\\_D12\\_v2\\_Promo', 'Standard\\_D13', 'Standard\\_D13\\_v2', 'Standard\\_D13\\_v2\\_Promo', 'Standard\\_D14', 'Standard\\_D14\\_v2', 'Standard\\_D14\\_v2\\_Promo', 'Standard\\_D15\\_v2', 'Standard\\_D16\\_v3', 'Standard\\_D16s\\_v3', 'Standard\\_D1\\_v2', 'Standard\\_D2', 'Standard\\_D2\\_v2', 'Standard\\_D2\\_v2\\_Promo', 'Standard\\_D2\\_v3', 'Standard\\_D2s\\_v3', 'Standard\\_D3', 'Standard\\_D32\\_v3', 'Standard\\_D32s\\_v3', 'Standard\\_D3\\_v2', 'Standard\\_D3\\_v2\\_Promo', 'Standard\\_D4', 'Standard\\_D4\\_v2', 'Standard\\_D4\\_v2\\_Promo', 'Standard\\_D4\\_v3', 'Standard\\_D4s\\_v3', 'Standard\\_D5\\_v2', 'Standard\\_D5\\_v2\\_Promo', 'Standard\\_D64\\_v3', 'Standard\\_D64s\\_v3', 'Standard\\_D8\\_v3', 'Standard\\_D8s\\_v3', 'Standard\\_DS1', 'Standard\\_DS11', 'Standard\\_DS11\\_v2', 'Standard\\_DS11\\_v2\\_Promo', 'Standard\\_DS12', 'Standard\\_DS12\\_v2', 'Standard\\_DS12\\_v2\\_Promo', 'Standard\\_DS13', 'Standard\\_DS13-2\\_v2', 'Standard\\_DS13-4\\_v2', 'Standard\\_DS13\\_v2', 'Standard\\_DS13\\_v2\\_Promo', 'Standard\\_DS14', 'Standard\\_DS14-4\\_v2', 'Standard\\_DS14-8\\_v2', 'Standard\\_DS14\\_v2', 'Standard\\_DS14\\_v2\\_Promo', 'Standard\\_DS15\\_v2', 'Standard\\_DS1\\_v2', 'Standard\\_DS2', 'Standard\\_DS2\\_v2', 'Standard\\_DS2\\_v2\\_Promo', 'Standard\\_DS3', 'Standard\\_DS3\\_v2', 'Standard\\_DS3\\_v2\\_Promo', 'Standard\\_DS4', 'Standard\\_DS4\\_v2', 'Standard\\_DS4\\_v2\\_Promo', 'Standard\\_DS5\\_v2', 'Standard\\_DS5\\_v2\\_Promo', 'Standard\\_E16\\_v3', 'Standard\\_E16s\\_v3', 'Standard\\_E2\\_v3', 'Standard\\_E2s\\_v3', 'Standard\\_E32-16s\\_v3', 'Standard\\_E32-8s\\_v3', 'Standard\\_E32\\_v3', 'Standard\\_E32s\\_v3', 'Standard\\_E4\\_v3', 'Standard\\_E4s\\_v3', 'Standard\\_E64-16s\\_v3', 'Standard\\_E64-32s\\_v3', 'Standard\\_E64\\_v3', 'Standard\\_E64s\\_v3', 'Standard\\_E8\\_v3', 'Standard\\_E8s\\_v3', 'Standard\\_F1', 'Standard\\_F16', 'Standard\\_F16s', 'Standard\\_F16s\\_v2', 'Standard\\_F1s', 'Standard\\_F2', 'Standard\\_F2s', 'Standard\\_F2s\\_v2', 'Standard\\_F32s\\_v2', 'Standard\\_F4', 'Standard\\_F4s', 'Standard\\_F4s\\_v2', 'Standard\\_F64s\\_v2', 'Standard\\_F72s\\_v2', 'Standard\\_F8', 'Standard\\_F8s', 'Standard\\_F8s\\_v2', 'Standard\\_G1', 'Standard\\_G2', 'Standard\\_G3', 'Standard\\_G4', 'Standard\\_G5', 'Standard\\_GS1', 'Standard\\_GS2', 'Standard\\_GS3', 'Standard\\_GS4', 'Standard\\_GS4-4', 'Standard\\_GS4-8', 'Standard\\_GS5', 'Standard\\_GS5-16', 'Standard\\_GS5-8', 'Standard\\_H16', 'Standard\\_H16m', 'Standard\\_H16mr', 'Standard\\_H16r', 'Standard\\_H8', 'Standard\\_H8m', 'Standard\\_L16s', 'Standard\\_L32s', 'Standard\\_L4s', 'Standard\\_L8s', 'Standard\\_M128-32ms', 'Standard\\_M128-64ms', 'Standard\\_M128ms', 'Standard\\_M128s', 'Standard\\_M64-16ms', 'Standard\\_M64-32ms', 'Standard\\_M64ms', 'Standard\\_M64s', 'Standard\\_NC12', 'Standard\\_NC12s\\_v2', 'Standard\\_NC12s\\_v3', 'Standard\\_NC24', 'Standard\\_NC24r', 'Standard\\_NC24rs\\_v2', 'Standard\\_NC24rs\\_v3', 'Standard\\_NC24s\\_v2', 'Standard\\_NC24s\\_v3', 'Standard\\_NC6', 'Standard\\_NC6s\\_v2', 'Standard\\_NC6s\\_v3', 'Standard\\_ND12s', 'Standard\\_ND24rs', 'Standard\\_ND24s', 'Standard\\_ND6s', 'Standard\\_NV12', 'Standard\\_NV24', 'Standard\\_NV6'."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withVnetSubnetID(java.lang.String)"
fullName: "com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties.withVnetSubnetID(String vnetSubnetID)"
name: "withVnetSubnetID(String vnetSubnetID)"
nameWithType: "ManagedClusterAgentPoolProfileProperties.withVnetSubnetID(String vnetSubnetID)"
summary: "Set v<wbr>Net SubnetID specifies the VNet's subnet identifier."
parameters:
- description: "the vnetSubnetID value to set"
name: "vnetSubnetID"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ManagedClusterAgentPoolProfileProperties withVnetSubnetID(String vnetSubnetID)"
desc: "Set vNet SubnetID specifies the VNet's subnet identifier."
returns:
description: "the ManagedClusterAgentPoolProfileProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties?alt=com.microsoft.azure.management.containerservice.ManagedClusterAgentPoolProfileProperties&text=ManagedClusterAgentPoolProfileProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Properties for the container service agent pool profile."
metadata: {}
package: "com.microsoft.azure.management.containerservice"
artifact: com.microsoft.azure:azure-mgmt-containerservice:1.41.4