/
com.azure.resourcemanager.containerservice.models.AgentPoolMode.yml
97 lines (97 loc) · 7.21 KB
/
com.azure.resourcemanager.containerservice.models.AgentPoolMode.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
### YamlMime:JavaType
uid: "com.azure.resourcemanager.containerservice.models.AgentPoolMode"
fullName: "com.azure.resourcemanager.containerservice.models.AgentPoolMode"
name: "AgentPoolMode"
nameWithType: "AgentPoolMode"
summary: "The mode of an agent pool."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- 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#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#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#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 final class **AgentPoolMode**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolMode?alt=com.azure.resourcemanager.containerservice.models.AgentPoolMode&text=AgentPoolMode\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.AgentPoolMode()"
fullName: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.AgentPoolMode()"
name: "AgentPoolMode()"
nameWithType: "AgentPoolMode.AgentPoolMode()"
summary: "Creates a new instance of Agent<wbr>Pool<wbr>Mode value."
deprecatedTag: "Use the <xref uid=\"com.azure.resourcemanager.containerservice.models.AgentPoolMode.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public AgentPoolMode()"
desc: "Creates a new instance of AgentPoolMode value."
hasDeprecatedTag: true
fields:
- uid: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.SYSTEM"
fullName: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.SYSTEM"
name: "SYSTEM"
nameWithType: "AgentPoolMode.SYSTEM"
summary: "Static value System for Agent<wbr>Pool<wbr>Mode."
modifiers:
- "static"
- "final"
field:
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 static final AgentPoolMode SYSTEM"
desc: "Static value System for AgentPoolMode."
- uid: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.USER"
fullName: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.USER"
name: "USER"
nameWithType: "AgentPoolMode.USER"
summary: "Static value User for Agent<wbr>Pool<wbr>Mode."
modifiers:
- "static"
- "final"
field:
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 static final AgentPoolMode USER"
desc: "Static value User for AgentPoolMode."
methods:
- uid: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.fromString(java.lang.String)"
fullName: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.fromString(String name)"
name: "fromString(String name)"
nameWithType: "AgentPoolMode.fromString(String name)"
summary: "Creates or finds a Agent<wbr>Pool<wbr>Mode from its string representation."
modifiers:
- "static"
parameters:
- description: "a name to look for."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static AgentPoolMode fromString(String name)"
desc: "Creates or finds a AgentPoolMode from its string representation."
returns:
description: "the corresponding AgentPoolMode."
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.models.AgentPoolMode.values()"
fullName: "com.azure.resourcemanager.containerservice.models.AgentPoolMode.values()"
name: "values()"
nameWithType: "AgentPoolMode.values()"
summary: "Gets known Agent<wbr>Pool<wbr>Mode values."
modifiers:
- "static"
syntax: "public static Collection<AgentPoolMode> values()"
desc: "Gets known AgentPoolMode values."
returns:
description: "known AgentPoolMode values."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.resourcemanager.containerservice.models.AgentPoolMode?alt=com.azure.resourcemanager.containerservice.models.AgentPoolMode&text=AgentPoolMode\" data-throw-if-not-resolved=\"False\" />>"
type: "class"
desc: "The mode of an agent pool. A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools."
metadata: {}
package: "com.azure.resourcemanager.containerservice.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-containerservice:2.38.0