/
Pool.yml
556 lines (539 loc) · 18.6 KB
/
Pool.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
550
551
552
553
554
555
556
### YamlMime:TSType
name: Pool
uid: '@azure/arm-batch.Pool'
package: '@azure/arm-batch'
summary: Contains information about a pool.
fullName: Pool
remarks: ''
isDeprecated: false
type: interface
properties:
- name: allocationState
uid: '@azure/arm-batch.Pool.allocationState'
package: '@azure/arm-batch'
summary: >-
Whether the pool is resizing.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: allocationState
remarks: ''
isDeprecated: false
syntax:
content: 'allocationState?: AllocationState'
return:
description: ''
type: <xref uid="@azure/arm-batch.AllocationState" />
- name: allocationStateTransitionTime
uid: '@azure/arm-batch.Pool.allocationStateTransitionTime'
package: '@azure/arm-batch'
summary: >-
The time at which the pool entered its current allocation state.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: allocationStateTransitionTime
remarks: ''
isDeprecated: false
syntax:
content: 'allocationStateTransitionTime?: Date'
return:
description: ''
type: Date
- name: applicationLicenses
uid: '@azure/arm-batch.Pool.applicationLicenses'
package: '@azure/arm-batch'
summary: >-
The list of application licenses must be a subset of available Batch
service application licenses. If a license is requested which is not
supported, pool creation will fail.
fullName: applicationLicenses
remarks: ''
isDeprecated: false
syntax:
content: 'applicationLicenses?: string[]'
return:
description: ''
type: string[]
- name: applicationPackages
uid: '@azure/arm-batch.Pool.applicationPackages'
package: '@azure/arm-batch'
summary: >-
Changes to application package references affect all new compute nodes
joining the pool, but do not affect compute nodes that are already in the
pool until they are rebooted or reimaged. There is a maximum of 10
application package references on any given pool.
fullName: applicationPackages
remarks: ''
isDeprecated: false
syntax:
content: 'applicationPackages?: ApplicationPackageReference[]'
return:
description: ''
type: <xref uid="@azure/arm-batch.ApplicationPackageReference" />[]
- name: autoScaleRun
uid: '@azure/arm-batch.Pool.autoScaleRun'
package: '@azure/arm-batch'
summary: >-
This property is set only if the pool automatically scales, i.e.
autoScaleSettings are used.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: autoScaleRun
remarks: ''
isDeprecated: false
syntax:
content: 'autoScaleRun?: AutoScaleRun'
return:
description: ''
type: <xref uid="@azure/arm-batch.AutoScaleRun" />
- name: certificates
uid: '@azure/arm-batch.Pool.certificates'
package: '@azure/arm-batch'
summary: >-
For Windows compute nodes, the Batch service installs the certificates to
the specified certificate store and location. For Linux compute nodes, the
certificates are stored in a directory inside the task working directory
and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the
task to query for this location. For certificates with visibility of
'remoteUser', a 'certs' directory is created in the user's home directory
(e.g., /home/{user-name}/certs) and certificates are placed in that
directory.
Warning: This property is deprecated and will be removed after February,
2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
fullName: certificates
remarks: ''
isDeprecated: false
syntax:
content: 'certificates?: CertificateReference[]'
return:
description: ''
type: <xref uid="@azure/arm-batch.CertificateReference" />[]
- name: creationTime
uid: '@azure/arm-batch.Pool.creationTime'
package: '@azure/arm-batch'
summary: >-
The creation time of the pool.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: creationTime
remarks: ''
isDeprecated: false
syntax:
content: 'creationTime?: Date'
return:
description: ''
type: Date
- name: currentDedicatedNodes
uid: '@azure/arm-batch.Pool.currentDedicatedNodes'
package: '@azure/arm-batch'
summary: >-
The number of dedicated compute nodes currently in the pool.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: currentDedicatedNodes
remarks: ''
isDeprecated: false
syntax:
content: 'currentDedicatedNodes?: number'
return:
description: ''
type: number
- name: currentLowPriorityNodes
uid: '@azure/arm-batch.Pool.currentLowPriorityNodes'
package: '@azure/arm-batch'
summary: >-
The number of Spot/low-priority compute nodes currently in the pool.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: currentLowPriorityNodes
remarks: ''
isDeprecated: false
syntax:
content: 'currentLowPriorityNodes?: number'
return:
description: ''
type: number
- name: currentNodeCommunicationMode
uid: '@azure/arm-batch.Pool.currentNodeCommunicationMode'
package: '@azure/arm-batch'
summary: >-
Determines how a pool communicates with the Batch service.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: currentNodeCommunicationMode
remarks: ''
isDeprecated: false
syntax:
content: 'currentNodeCommunicationMode?: NodeCommunicationMode'
return:
description: ''
type: <xref uid="@azure/arm-batch.NodeCommunicationMode" />
- name: deploymentConfiguration
uid: '@azure/arm-batch.Pool.deploymentConfiguration'
package: '@azure/arm-batch'
summary: >-
Using CloudServiceConfiguration specifies that the nodes should be
creating using Azure Cloud Services (PaaS), while
VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).
fullName: deploymentConfiguration
remarks: ''
isDeprecated: false
syntax:
content: 'deploymentConfiguration?: DeploymentConfiguration'
return:
description: ''
type: <xref uid="@azure/arm-batch.DeploymentConfiguration" />
- name: displayName
uid: '@azure/arm-batch.Pool.displayName'
package: '@azure/arm-batch'
summary: >-
The display name need not be unique and can contain any Unicode characters
up to a maximum length of 1024.
fullName: displayName
remarks: ''
isDeprecated: false
syntax:
content: 'displayName?: string'
return:
description: ''
type: string
- name: identity
uid: '@azure/arm-batch.Pool.identity'
package: '@azure/arm-batch'
summary: The type of identity used for the Batch Pool.
fullName: identity
remarks: ''
isDeprecated: false
syntax:
content: 'identity?: BatchPoolIdentity'
return:
description: ''
type: <xref uid="@azure/arm-batch.BatchPoolIdentity" />
- name: interNodeCommunication
uid: '@azure/arm-batch.Pool.interNodeCommunication'
package: '@azure/arm-batch'
summary: >-
This imposes restrictions on which nodes can be assigned to the pool.
Enabling this value can reduce the chance of the requested number of nodes
to be allocated in the pool. If not specified, this value defaults to
'Disabled'.
fullName: interNodeCommunication
remarks: ''
isDeprecated: false
syntax:
content: 'interNodeCommunication?: InterNodeCommunicationState'
return:
description: ''
type: <xref uid="@azure/arm-batch.InterNodeCommunicationState" />
- name: lastModified
uid: '@azure/arm-batch.Pool.lastModified'
package: '@azure/arm-batch'
summary: >-
This is the last time at which the pool level data, such as the
targetDedicatedNodes or autoScaleSettings, changed. It does not factor in
node-level changes such as a compute node changing state.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: lastModified
remarks: ''
isDeprecated: false
syntax:
content: 'lastModified?: Date'
return:
description: ''
type: Date
- name: metadata
uid: '@azure/arm-batch.Pool.metadata'
package: '@azure/arm-batch'
summary: >-
The Batch service does not assign any meaning to metadata; it is solely
for the use of user code.
fullName: metadata
remarks: ''
isDeprecated: false
syntax:
content: 'metadata?: MetadataItem[]'
return:
description: ''
type: <xref uid="@azure/arm-batch.MetadataItem" />[]
- name: mountConfiguration
uid: '@azure/arm-batch.Pool.mountConfiguration'
package: '@azure/arm-batch'
summary: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
fullName: mountConfiguration
remarks: ''
isDeprecated: false
syntax:
content: 'mountConfiguration?: MountConfiguration[]'
return:
description: ''
type: <xref uid="@azure/arm-batch.MountConfiguration" />[]
- name: networkConfiguration
uid: '@azure/arm-batch.Pool.networkConfiguration'
package: '@azure/arm-batch'
summary: The network configuration for a pool.
fullName: networkConfiguration
remarks: ''
isDeprecated: false
syntax:
content: 'networkConfiguration?: NetworkConfiguration'
return:
description: ''
type: <xref uid="@azure/arm-batch.NetworkConfiguration" />
- name: provisioningState
uid: '@azure/arm-batch.Pool.provisioningState'
package: '@azure/arm-batch'
summary: >-
The current state of the pool.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: PoolProvisioningState'
return:
description: ''
type: <xref uid="@azure/arm-batch.PoolProvisioningState" />
- name: provisioningStateTransitionTime
uid: '@azure/arm-batch.Pool.provisioningStateTransitionTime'
package: '@azure/arm-batch'
summary: >-
The time at which the pool entered its current state.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: provisioningStateTransitionTime
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningStateTransitionTime?: Date'
return:
description: ''
type: Date
- name: resizeOperationStatus
uid: '@azure/arm-batch.Pool.resizeOperationStatus'
package: '@azure/arm-batch'
summary: >-
Describes either the current operation (if the pool AllocationState is
Resizing) or the previously completed operation (if the AllocationState is
Steady).
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: resizeOperationStatus
remarks: ''
isDeprecated: false
syntax:
content: 'resizeOperationStatus?: ResizeOperationStatus'
return:
description: ''
type: <xref uid="@azure/arm-batch.ResizeOperationStatus" />
- name: resourceTags
uid: '@azure/arm-batch.Pool.resourceTags'
package: '@azure/arm-batch'
summary: >-
The user-defined tags to be associated with the Azure Batch Pool. When
specified, these tags are propagated to the backing Azure resources
associated with the pool. This property can only be specified when the
Batch account was created with the poolAllocationMode property set to
'UserSubscription'.
fullName: resourceTags
remarks: ''
isDeprecated: false
syntax:
content: 'resourceTags?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
- name: scaleSettings
uid: '@azure/arm-batch.Pool.scaleSettings'
package: '@azure/arm-batch'
summary: >-
Defines the desired size of the pool. This can either be 'fixedScale'
where the requested targetDedicatedNodes is specified, or 'autoScale'
which defines a formula which is periodically reevaluated. If this
property is not specified, the pool will have a fixed scale with 0
targetDedicatedNodes.
fullName: scaleSettings
remarks: ''
isDeprecated: false
syntax:
content: 'scaleSettings?: ScaleSettings'
return:
description: ''
type: <xref uid="@azure/arm-batch.ScaleSettings" />
- name: startTask
uid: '@azure/arm-batch.Pool.startTask'
package: '@azure/arm-batch'
summary: >-
In an PATCH (update) operation, this property can be set to an empty
object to remove the start task from the pool.
fullName: startTask
remarks: ''
isDeprecated: false
syntax:
content: 'startTask?: StartTask'
return:
description: ''
type: <xref uid="@azure/arm-batch.StartTask" />
- name: targetNodeCommunicationMode
uid: '@azure/arm-batch.Pool.targetNodeCommunicationMode'
package: '@azure/arm-batch'
summary: If omitted, the default value is Default.
fullName: targetNodeCommunicationMode
remarks: ''
isDeprecated: false
syntax:
content: 'targetNodeCommunicationMode?: NodeCommunicationMode'
return:
description: ''
type: <xref uid="@azure/arm-batch.NodeCommunicationMode" />
- name: taskSchedulingPolicy
uid: '@azure/arm-batch.Pool.taskSchedulingPolicy'
package: '@azure/arm-batch'
summary: If not specified, the default is spread.
fullName: taskSchedulingPolicy
remarks: ''
isDeprecated: false
syntax:
content: 'taskSchedulingPolicy?: TaskSchedulingPolicy'
return:
description: ''
type: <xref uid="@azure/arm-batch.TaskSchedulingPolicy" />
- name: taskSlotsPerNode
uid: '@azure/arm-batch.Pool.taskSlotsPerNode'
package: '@azure/arm-batch'
summary: >-
The default value is 1. The maximum value is the smaller of 4 times the
number of cores of the vmSize of the pool or 256.
fullName: taskSlotsPerNode
remarks: ''
isDeprecated: false
syntax:
content: 'taskSlotsPerNode?: number'
return:
description: ''
type: number
- name: upgradePolicy
uid: '@azure/arm-batch.Pool.upgradePolicy'
package: '@azure/arm-batch'
summary: Describes an upgrade policy - automatic, manual, or rolling.
fullName: upgradePolicy
remarks: ''
isDeprecated: false
syntax:
content: 'upgradePolicy?: UpgradePolicy'
return:
description: ''
type: <xref uid="@azure/arm-batch.UpgradePolicy" />
- name: userAccounts
uid: '@azure/arm-batch.Pool.userAccounts'
package: '@azure/arm-batch'
summary: The list of user accounts to be created on each node in the pool.
fullName: userAccounts
remarks: ''
isDeprecated: false
syntax:
content: 'userAccounts?: UserAccount[]'
return:
description: ''
type: <xref uid="@azure/arm-batch.UserAccount" />[]
- name: vmSize
uid: '@azure/arm-batch.Pool.vmSize'
package: '@azure/arm-batch'
summary: >-
For information about available sizes of virtual machines for Cloud
Services pools (pools created with cloudServiceConfiguration), see Sizes
for Cloud Services
(https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
Batch supports all Cloud Services VM sizes except ExtraSmall. For
information about available VM sizes for pools using images from the
Virtual Machines Marketplace (pools created with
virtualMachineConfiguration) see Sizes for Virtual Machines (Linux)
(https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)
or Sizes for Virtual Machines (Windows)
(https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/).
Batch supports all Azure VM sizes except STANDARD_A0 and those with
premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
fullName: vmSize
remarks: ''
isDeprecated: false
syntax:
content: 'vmSize?: string'
return:
description: ''
type: string
inheritedProperties:
- name: etag
uid: '@azure/arm-batch.Pool.etag'
package: '@azure/arm-batch'
summary: >-
The ETag of the resource, used for concurrency statements.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: etag
remarks: ''
isDeprecated: false
syntax:
content: 'etag?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.etag](xref:@azure/arm-batch.ProxyResource.etag)
- name: id
uid: '@azure/arm-batch.Pool.id'
package: '@azure/arm-batch'
summary: >-
The ID of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.id](xref:@azure/arm-batch.ProxyResource.id)
- name: name
uid: '@azure/arm-batch.Pool.name'
package: '@azure/arm-batch'
summary: >-
The name of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.name](xref:@azure/arm-batch.ProxyResource.name)
- name: type
uid: '@azure/arm-batch.Pool.type'
package: '@azure/arm-batch'
summary: >-
The type of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.type](xref:@azure/arm-batch.ProxyResource.type)
extends: <xref uid="@azure/arm-batch.ProxyResource" />