-
Notifications
You must be signed in to change notification settings - Fork 244
/
azure.mgmt.containerservice.v2020_11_01.models.AgentPool.yml
549 lines (432 loc) · 19.6 KB
/
azure.mgmt.containerservice.v2020_11_01.models.AgentPool.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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
### YamlMime:PythonClass
uid: azure.mgmt.containerservice.v2020_11_01.models.AgentPool
name: AgentPool
fullName: azure.mgmt.containerservice.v2020_11_01.models.AgentPool
module: azure.mgmt.containerservice.v2020_11_01.models
inheritances:
- azure.mgmt.containerservice.v2020_11_01.models._models_py3.SubResource
summary: 'Agent Pool.
Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
syntax: 'AgentPool(*, count: int | None = None, vm_size: str | _models.ContainerServiceVMSizeTypes
| None = None, os_disk_size_gb: int | None = None, os_disk_type: str | _models.OSDiskType
| None = None, vnet_subnet_id: str | None = None, pod_subnet_id: str | None =
None, max_pods: int | None = None, os_type: str | _models.OSType = ''Linux'',
max_count: int | None = None, min_count: int | None = None, enable_auto_scaling:
bool | None = None, type_properties_type: str | _models.AgentPoolType | None =
None, mode: str | _models.AgentPoolMode | None = None, orchestrator_version: str
| None = None, upgrade_settings: _models.AgentPoolUpgradeSettings | None = None,
availability_zones: List[str] | None = None, enable_node_public_ip: bool | None
= None, scale_set_priority: str | _models.ScaleSetPriority = ''Regular'', scale_set_eviction_policy:
str | _models.ScaleSetEvictionPolicy = ''Delete'', spot_max_price: float = -1,
tags: Dict[str, str] | None = None, node_labels: Dict[str, str] | None = None,
node_taints: List[str] | None = None, proximity_placement_group_id: str | None
= None, kubelet_config: _models.KubeletConfig | None = None, linux_os_config:
_models.LinuxOSConfig | None = None, **kwargs: Any)'
keywordOnlyParameters:
- name: count
description: '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.'
types:
- <xref:int>
- name: vm_size
description: 'Size of agent VMs. Known values are: "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", and "Standard_NV6".'
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.ContainerServiceVMSizeTypes>
- name: os_disk_size_gb
description: '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.'
types:
- <xref:int>
- name: os_disk_type
description: 'OS disk type to be used for machines in a given agent pool. Allowed
values are ''Ephemeral'' and ''Managed''. If unspecified, defaults to ''Ephemeral''
when the VM
supports ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB.
Otherwise,
defaults to ''Managed''. May not be changed after creation. Known values are:
"Managed" and
"Ephemeral".'
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.OSDiskType>
- name: vnet_subnet_id
description: 'VNet SubnetID specifies the VNet''s subnet identifier for nodes
and
maybe pods.'
types:
- <xref:str>
- name: pod_subnet_id
description: Pod SubnetID specifies the VNet's subnet identifier for pods.
types:
- <xref:str>
- name: max_pods
description: Maximum number of pods that can run on a node.
types:
- <xref:int>
- name: os_type
description: 'OsType to be used to specify os type. Choose from Linux and Windows.
Default
to Linux. Known values are: "Linux" and "Windows".'
defaultValue: Linux
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.OSType>
- name: max_count
description: Maximum number of nodes for auto-scaling.
types:
- <xref:int>
- name: min_count
description: Minimum number of nodes for auto-scaling.
types:
- <xref:int>
- name: enable_auto_scaling
description: Whether to enable auto-scaler.
types:
- <xref:bool>
- name: type_properties_type
description: 'AgentPoolType represents types of an agent pool. Known values
are: "VirtualMachineScaleSets" and "AvailabilitySet".'
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.AgentPoolType>
- name: mode
description: 'AgentPoolMode represents mode of an agent pool. Known values are:
"System" and
"User".'
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.AgentPoolMode>
- name: orchestrator_version
description: 'Version of orchestrator specified when creating the managed
cluster.'
types:
- <xref:str>
- name: upgrade_settings
description: Settings for upgrading the agentpool.
types:
- <xref:azure.mgmt.containerservice.v2020_11_01.models.AgentPoolUpgradeSettings>
- name: availability_zones
description: 'Availability zones for nodes. Must use VirtualMachineScaleSets
AgentPoolType.'
types:
- <xref:list>[<xref:str>]
- name: enable_node_public_ip
description: Enable public IP for nodes.
types:
- <xref:bool>
- name: scale_set_priority
description: 'ScaleSetPriority to be used to specify virtual machine scale set
priority. Default to regular. Known values are: "Spot" and "Regular".'
defaultValue: Regular
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.ScaleSetPriority>
- name: scale_set_eviction_policy
description: 'ScaleSetEvictionPolicy to be used to specify eviction
policy for Spot virtual machine scale set. Default to Delete. Known values are:
"Delete" and
"Deallocate".'
defaultValue: Delete
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.ScaleSetEvictionPolicy>
- name: spot_max_price
description: '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.'
defaultValue: '-1'
types:
- <xref:float>
- name: tags
description: Agent pool tags to be persisted on the agent pool virtual machine
scale set.
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: node_labels
description: Agent pool node labels to be persisted across all nodes in agent
pool.
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: node_taints
description: 'Taints added to new nodes during node pool create and scale. For
example,
key=value:NoSchedule.'
types:
- <xref:list>[<xref:str>]
- name: proximity_placement_group_id
description: The ID for Proximity Placement Group.
types:
- <xref:str>
- name: kubelet_config
description: KubeletConfig specifies the configuration of kubelet on agent nodes.
types:
- <xref:azure.mgmt.containerservice.v2020_11_01.models.KubeletConfig>
- name: linux_os_config
description: LinuxOSConfig specifies the OS configuration of linux agent nodes.
types:
- <xref:azure.mgmt.containerservice.v2020_11_01.models.LinuxOSConfig>
variables:
- description: Resource ID.
name: id
types:
- <xref:str>
- description: 'The name of the resource that is unique within a resource group. This
name can be
used to access the resource.'
name: name
types:
- <xref:str>
- description: Resource type.
name: type
types:
- <xref:str>
- description: '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.'
name: count
types:
- <xref:int>
- description: 'Size of agent VMs. Known values are: "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", and "Standard_NV6".'
name: vm_size
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.ContainerServiceVMSizeTypes>
- description: '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.'
name: os_disk_size_gb
types:
- <xref:int>
- description: 'OS disk type to be used for machines in a given agent pool. Allowed
values
are ''Ephemeral'' and ''Managed''. If unspecified, defaults to ''Ephemeral'' when
the VM supports
ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB. Otherwise,
defaults
to ''Managed''. May not be changed after creation. Known values are: "Managed"
and "Ephemeral".'
name: os_disk_type
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.OSDiskType>
- description: 'VNet SubnetID specifies the VNet''s subnet identifier for nodes and
maybe
pods.'
name: vnet_subnet_id
types:
- <xref:str>
- description: Pod SubnetID specifies the VNet's subnet identifier for pods.
name: pod_subnet_id
types:
- <xref:str>
- description: Maximum number of pods that can run on a node.
name: max_pods
types:
- <xref:int>
- description: 'OsType to be used to specify os type. Choose from Linux and Windows.
Default to
Linux. Known values are: "Linux" and "Windows".'
name: os_type
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.OSType>
- description: Maximum number of nodes for auto-scaling.
name: max_count
types:
- <xref:int>
- description: Minimum number of nodes for auto-scaling.
name: min_count
types:
- <xref:int>
- description: Whether to enable auto-scaler.
name: enable_auto_scaling
types:
- <xref:bool>
- description: 'AgentPoolType represents types of an agent pool. Known values are:
"VirtualMachineScaleSets" and "AvailabilitySet".'
name: type_properties_type
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.AgentPoolType>
- description: 'AgentPoolMode represents mode of an agent pool. Known values are:
"System" and
"User".'
name: mode
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.AgentPoolMode>
- description: 'Version of orchestrator specified when creating the managed
cluster.'
name: orchestrator_version
types:
- <xref:str>
- description: Version of node image.
name: node_image_version
types:
- <xref:str>
- description: Settings for upgrading the agentpool.
name: upgrade_settings
types:
- <xref:azure.mgmt.containerservice.v2020_11_01.models.AgentPoolUpgradeSettings>
- description: 'The current deployment or provisioning state, which only appears in
the response.'
name: provisioning_state
types:
- <xref:str>
- description: Describes whether the Agent Pool is Running or Stopped.
name: power_state
types:
- <xref:azure.mgmt.containerservice.v2020_11_01.models.PowerState>
- description: 'Availability zones for nodes. Must use VirtualMachineScaleSets
AgentPoolType.'
name: availability_zones
types:
- <xref:list>[<xref:str>]
- description: Enable public IP for nodes.
name: enable_node_public_ip
types:
- <xref:bool>
- description: 'ScaleSetPriority to be used to specify virtual machine scale set
priority. Default to regular. Known values are: "Spot" and "Regular".'
name: scale_set_priority
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.ScaleSetPriority>
- description: 'ScaleSetEvictionPolicy to be used to specify eviction policy
for Spot virtual machine scale set. Default to Delete. Known values are: "Delete"
and
"Deallocate".'
name: scale_set_eviction_policy
types:
- <xref:str>
- <xref:azure.mgmt.containerservice.v2020_11_01.models.ScaleSetEvictionPolicy>
- description: '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.'
name: spot_max_price
types:
- <xref:float>
- description: Agent pool tags to be persisted on the agent pool virtual machine scale
set.
name: tags
types:
- <xref:dict>[<xref:str>, <xref:str>]
- description: Agent pool node labels to be persisted across all nodes in agent pool.
name: node_labels
types:
- <xref:dict>[<xref:str>, <xref:str>]
- description: 'Taints added to new nodes during node pool create and scale. For example,
key=value:NoSchedule.'
name: node_taints
types:
- <xref:list>[<xref:str>]
- description: The ID for Proximity Placement Group.
name: proximity_placement_group_id
types:
- <xref:str>
- description: KubeletConfig specifies the configuration of kubelet on agent nodes.
name: kubelet_config
types:
- <xref:azure.mgmt.containerservice.v2020_11_01.models.KubeletConfig>
- description: LinuxOSConfig specifies the OS configuration of linux agent nodes.
name: linux_os_config
types:
- <xref:azure.mgmt.containerservice.v2020_11_01.models.LinuxOSConfig>