/
com.azure.resourcemanager.batch.fluent.models.PoolInner.yml
626 lines (626 loc) · 58.6 KB
/
com.azure.resourcemanager.batch.fluent.models.PoolInner.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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
### YamlMime:JavaType
uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner"
name: "PoolInner"
nameWithType: "PoolInner"
summary: "Contains information about a pool."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.management.ProxyResource?alt=com.azure.core.management.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.core.management.ProxyResource.id()?alt=com.azure.core.management.ProxyResource.id&text=id\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource.name()?alt=com.azure.core.management.ProxyResource.name&text=name\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource.type()?alt=com.azure.core.management.ProxyResource.type&text=type\" 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#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **PoolInner**</br> extends <xref href=\"com.azure.core.management.ProxyResource?alt=com.azure.core.management.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.PoolInner()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.PoolInner()"
name: "PoolInner()"
nameWithType: "PoolInner.PoolInner()"
summary: "Creates an instance of Pool<wbr>Inner class."
syntax: "public PoolInner()"
desc: "Creates an instance of PoolInner class."
methods:
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.allocationState()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.allocationState()"
name: "allocationState()"
nameWithType: "PoolInner.allocationState()"
summary: "Get the allocation<wbr>State property: Whether the pool is resizing."
syntax: "public AllocationState allocationState()"
desc: "Get the allocationState property: Whether the pool is resizing."
returns:
description: "the allocationState value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.AllocationState?alt=com.azure.resourcemanager.batch.models.AllocationState&text=AllocationState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.allocationStateTransitionTime()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.allocationStateTransitionTime()"
name: "allocationStateTransitionTime()"
nameWithType: "PoolInner.allocationStateTransitionTime()"
summary: "Get the allocation<wbr>State<wbr>Transition<wbr>Time property: The time at which the pool entered its current allocation state."
syntax: "public OffsetDateTime allocationStateTransitionTime()"
desc: "Get the allocationStateTransitionTime property: The time at which the pool entered its current allocation state."
returns:
description: "the allocationStateTransitionTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.applicationLicenses()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.applicationLicenses()"
name: "applicationLicenses()"
nameWithType: "PoolInner.applicationLicenses()"
summary: "Get the application<wbr>Licenses property: The list of application licenses the Batch service will make available on each compute node in the pool."
syntax: "public List<String> applicationLicenses()"
desc: "Get the applicationLicenses property: The list of application licenses the Batch service will make available on each compute node in the pool. 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."
returns:
description: "the applicationLicenses value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.applicationPackages()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.applicationPackages()"
name: "applicationPackages()"
nameWithType: "PoolInner.applicationPackages()"
summary: "Get the application<wbr>Packages property: The list of application packages to be installed on each compute node in the pool."
syntax: "public List<ApplicationPackageReference> applicationPackages()"
desc: "Get the applicationPackages property: The list of application packages to be installed on each compute node in the pool. 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."
returns:
description: "the applicationPackages value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.ApplicationPackageReference?alt=com.azure.resourcemanager.batch.models.ApplicationPackageReference&text=ApplicationPackageReference\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.autoScaleRun()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.autoScaleRun()"
name: "autoScaleRun()"
nameWithType: "PoolInner.autoScaleRun()"
summary: "Get the auto<wbr>Scale<wbr>Run property: The results and errors from an execution of a pool autoscale formula."
syntax: "public AutoScaleRun autoScaleRun()"
desc: "Get the autoScaleRun property: The results and errors from an execution of a pool autoscale formula. This property is set only if the pool automatically scales, i.e. autoScaleSettings are used."
returns:
description: "the autoScaleRun value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.AutoScaleRun?alt=com.azure.resourcemanager.batch.models.AutoScaleRun&text=AutoScaleRun\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.certificates()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.certificates()"
name: "certificates()"
nameWithType: "PoolInner.certificates()"
summary: "Get the certificates property: The list of certificates to be installed on each compute node in the pool."
syntax: "public List<CertificateReference> certificates()"
desc: "Get the certificates property: The list of certificates to be installed on each compute node in the pool. 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."
returns:
description: "the certificates value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.CertificateReference?alt=com.azure.resourcemanager.batch.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.creationTime()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.creationTime()"
name: "creationTime()"
nameWithType: "PoolInner.creationTime()"
summary: "Get the creation<wbr>Time property: The creation time of the pool."
syntax: "public OffsetDateTime creationTime()"
desc: "Get the creationTime property: The creation time of the pool."
returns:
description: "the creationTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.currentDedicatedNodes()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.currentDedicatedNodes()"
name: "currentDedicatedNodes()"
nameWithType: "PoolInner.currentDedicatedNodes()"
summary: "Get the current<wbr>Dedicated<wbr>Nodes property: The number of dedicated compute nodes currently in the pool."
syntax: "public Integer currentDedicatedNodes()"
desc: "Get the currentDedicatedNodes property: The number of dedicated compute nodes currently in the pool."
returns:
description: "the currentDedicatedNodes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.currentLowPriorityNodes()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.currentLowPriorityNodes()"
name: "currentLowPriorityNodes()"
nameWithType: "PoolInner.currentLowPriorityNodes()"
summary: "Get the current<wbr>Low<wbr>Priority<wbr>Nodes property: The number of Spot/low-priority compute nodes currently in the pool."
syntax: "public Integer currentLowPriorityNodes()"
desc: "Get the currentLowPriorityNodes property: The number of Spot/low-priority compute nodes currently in the pool."
returns:
description: "the currentLowPriorityNodes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.currentNodeCommunicationMode()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.currentNodeCommunicationMode()"
name: "currentNodeCommunicationMode()"
nameWithType: "PoolInner.currentNodeCommunicationMode()"
summary: "Get the current<wbr>Node<wbr>Communication<wbr>Mode property: Determines how a pool communicates with the Batch service."
syntax: "public NodeCommunicationMode currentNodeCommunicationMode()"
desc: "Get the currentNodeCommunicationMode property: Determines how a pool communicates with the Batch service."
returns:
description: "the currentNodeCommunicationMode value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.NodeCommunicationMode?alt=com.azure.resourcemanager.batch.models.NodeCommunicationMode&text=NodeCommunicationMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.deploymentConfiguration()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.deploymentConfiguration()"
name: "deploymentConfiguration()"
nameWithType: "PoolInner.deploymentConfiguration()"
summary: "Get the deployment<wbr>Configuration property: Deployment configuration properties."
syntax: "public DeploymentConfiguration deploymentConfiguration()"
desc: "Get the deploymentConfiguration property: Deployment configuration properties. Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS)."
returns:
description: "the deploymentConfiguration value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.DeploymentConfiguration?alt=com.azure.resourcemanager.batch.models.DeploymentConfiguration&text=DeploymentConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.displayName()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.displayName()"
name: "displayName()"
nameWithType: "PoolInner.displayName()"
summary: "Get the display<wbr>Name property: The display name for the pool."
syntax: "public String displayName()"
desc: "Get the displayName property: The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
returns:
description: "the displayName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.etag()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.etag()"
name: "etag()"
nameWithType: "PoolInner.etag()"
summary: "Get the etag property: The ETag of the resource, used for concurrency statements."
syntax: "public String etag()"
desc: "Get the etag property: The ETag of the resource, used for concurrency statements."
returns:
description: "the etag value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.identity()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.identity()"
name: "identity()"
nameWithType: "PoolInner.identity()"
summary: "Get the identity property: The type of identity used for the Batch Pool."
syntax: "public BatchPoolIdentity identity()"
desc: "Get the identity property: The type of identity used for the Batch Pool."
returns:
description: "the identity value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.BatchPoolIdentity?alt=com.azure.resourcemanager.batch.models.BatchPoolIdentity&text=BatchPoolIdentity\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.interNodeCommunication()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.interNodeCommunication()"
name: "interNodeCommunication()"
nameWithType: "PoolInner.interNodeCommunication()"
summary: "Get the inter<wbr>Node<wbr>Communication property: Whether the pool permits direct communication between nodes."
syntax: "public InterNodeCommunicationState interNodeCommunication()"
desc: "Get the interNodeCommunication property: Whether the pool permits direct communication between nodes. 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'."
returns:
description: "the interNodeCommunication value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.InterNodeCommunicationState?alt=com.azure.resourcemanager.batch.models.InterNodeCommunicationState&text=InterNodeCommunicationState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.lastModified()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.lastModified()"
name: "lastModified()"
nameWithType: "PoolInner.lastModified()"
summary: "Get the last<wbr>Modified property: The last modified time of the pool."
syntax: "public OffsetDateTime lastModified()"
desc: "Get the lastModified property: The last modified time of the pool. 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."
returns:
description: "the lastModified value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.metadata()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.metadata()"
name: "metadata()"
nameWithType: "PoolInner.metadata()"
summary: "Get the metadata property: A list of name-value pairs associated with the pool as metadata."
syntax: "public List<MetadataItem> metadata()"
desc: "Get the metadata property: A list of name-value pairs associated with the pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code."
returns:
description: "the metadata value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.MetadataItem?alt=com.azure.resourcemanager.batch.models.MetadataItem&text=MetadataItem\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.mountConfiguration()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.mountConfiguration()"
name: "mountConfiguration()"
nameWithType: "PoolInner.mountConfiguration()"
summary: "Get the mount<wbr>Configuration property: A list of file systems to mount on each node in the pool."
syntax: "public List<MountConfiguration> mountConfiguration()"
desc: "Get the mountConfiguration property: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse."
returns:
description: "the mountConfiguration value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.MountConfiguration?alt=com.azure.resourcemanager.batch.models.MountConfiguration&text=MountConfiguration\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.networkConfiguration()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.networkConfiguration()"
name: "networkConfiguration()"
nameWithType: "PoolInner.networkConfiguration()"
summary: "Get the network<wbr>Configuration property: The network configuration for a pool."
syntax: "public NetworkConfiguration networkConfiguration()"
desc: "Get the networkConfiguration property: The network configuration for a pool."
returns:
description: "the networkConfiguration value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.NetworkConfiguration?alt=com.azure.resourcemanager.batch.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.provisioningState()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.provisioningState()"
name: "provisioningState()"
nameWithType: "PoolInner.provisioningState()"
summary: "Get the provisioning<wbr>State property: The current state of the pool."
syntax: "public PoolProvisioningState provisioningState()"
desc: "Get the provisioningState property: The current state of the pool."
returns:
description: "the provisioningState value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.PoolProvisioningState?alt=com.azure.resourcemanager.batch.models.PoolProvisioningState&text=PoolProvisioningState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.provisioningStateTransitionTime()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.provisioningStateTransitionTime()"
name: "provisioningStateTransitionTime()"
nameWithType: "PoolInner.provisioningStateTransitionTime()"
summary: "Get the provisioning<wbr>State<wbr>Transition<wbr>Time property: The time at which the pool entered its current state."
syntax: "public OffsetDateTime provisioningStateTransitionTime()"
desc: "Get the provisioningStateTransitionTime property: The time at which the pool entered its current state."
returns:
description: "the provisioningStateTransitionTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.resizeOperationStatus()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.resizeOperationStatus()"
name: "resizeOperationStatus()"
nameWithType: "PoolInner.resizeOperationStatus()"
summary: "Get the resize<wbr>Operation<wbr>Status property: Details about the current or last completed resize operation."
syntax: "public ResizeOperationStatus resizeOperationStatus()"
desc: "Get the resizeOperationStatus property: Details about the current or last completed resize operation. Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady)."
returns:
description: "the resizeOperationStatus value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResizeOperationStatus?alt=com.azure.resourcemanager.batch.models.ResizeOperationStatus&text=ResizeOperationStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.resourceTags()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.resourceTags()"
name: "resourceTags()"
nameWithType: "PoolInner.resourceTags()"
summary: "Get the resource<wbr>Tags property: The user-defined tags to be associated with the Azure Batch Pool."
syntax: "public Map<String,String> resourceTags()"
desc: "Get the resourceTags property: 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'."
returns:
description: "the resourceTags value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.scaleSettings()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.scaleSettings()"
name: "scaleSettings()"
nameWithType: "PoolInner.scaleSettings()"
summary: "Get the scale<wbr>Settings property: Scale settings for the pool Defines the desired size of the pool."
syntax: "public ScaleSettings scaleSettings()"
desc: "Get the scaleSettings property: Scale settings for the pool 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."
returns:
description: "the scaleSettings value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ScaleSettings?alt=com.azure.resourcemanager.batch.models.ScaleSettings&text=ScaleSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.startTask()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.startTask()"
name: "startTask()"
nameWithType: "PoolInner.startTask()"
summary: "Get the start<wbr>Task property: A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged."
syntax: "public StartTask startTask()"
desc: "Get the startTask property: A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool."
returns:
description: "the startTask value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.StartTask?alt=com.azure.resourcemanager.batch.models.StartTask&text=StartTask\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.targetNodeCommunicationMode()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.targetNodeCommunicationMode()"
name: "targetNodeCommunicationMode()"
nameWithType: "PoolInner.targetNodeCommunicationMode()"
summary: "Get the target<wbr>Node<wbr>Communication<wbr>Mode property: Determines how a pool communicates with the Batch service."
syntax: "public NodeCommunicationMode targetNodeCommunicationMode()"
desc: "Get the targetNodeCommunicationMode property: Determines how a pool communicates with the Batch service. If omitted, the default value is Default."
returns:
description: "the targetNodeCommunicationMode value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.NodeCommunicationMode?alt=com.azure.resourcemanager.batch.models.NodeCommunicationMode&text=NodeCommunicationMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.taskSchedulingPolicy()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.taskSchedulingPolicy()"
name: "taskSchedulingPolicy()"
nameWithType: "PoolInner.taskSchedulingPolicy()"
summary: "Get the task<wbr>Scheduling<wbr>Policy property: Specifies how tasks should be distributed across compute nodes."
syntax: "public TaskSchedulingPolicy taskSchedulingPolicy()"
desc: "Get the taskSchedulingPolicy property: Specifies how tasks should be distributed across compute nodes. If not specified, the default is spread."
returns:
description: "the taskSchedulingPolicy value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.TaskSchedulingPolicy?alt=com.azure.resourcemanager.batch.models.TaskSchedulingPolicy&text=TaskSchedulingPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.taskSlotsPerNode()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.taskSlotsPerNode()"
name: "taskSlotsPerNode()"
nameWithType: "PoolInner.taskSlotsPerNode()"
summary: "Get the task<wbr>Slots<wbr>Per<wbr>Node property: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool."
syntax: "public Integer taskSlotsPerNode()"
desc: "Get the taskSlotsPerNode property: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. 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."
returns:
description: "the taskSlotsPerNode value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.upgradePolicy()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.upgradePolicy()"
name: "upgradePolicy()"
nameWithType: "PoolInner.upgradePolicy()"
summary: "Get the upgrade<wbr>Policy property: Describes an upgrade policy - automatic, manual, or rolling."
syntax: "public UpgradePolicy upgradePolicy()"
desc: "Get the upgradePolicy property: Describes an upgrade policy - automatic, manual, or rolling."
returns:
description: "the upgradePolicy value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.UpgradePolicy?alt=com.azure.resourcemanager.batch.models.UpgradePolicy&text=UpgradePolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.userAccounts()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.userAccounts()"
name: "userAccounts()"
nameWithType: "PoolInner.userAccounts()"
summary: "Get the user<wbr>Accounts property: The list of user accounts to be created on each node in the pool."
syntax: "public List<UserAccount> userAccounts()"
desc: "Get the userAccounts property: The list of user accounts to be created on each node in the pool."
returns:
description: "the userAccounts value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.validate()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.validate()"
name: "validate()"
nameWithType: "PoolInner.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.vmSize()"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.vmSize()"
name: "vmSize()"
nameWithType: "PoolInner.vmSize()"
summary: "Get the vm<wbr>Size property: The size of virtual machines in the pool."
syntax: "public String vmSize()"
desc: "Get the vmSize property: The size of virtual machines in the pool. All VMs in a pool are the same size. 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)."
returns:
description: "the vmSize value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withApplicationLicenses(java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withApplicationLicenses(List<String> applicationLicenses)"
name: "withApplicationLicenses(List<String> applicationLicenses)"
nameWithType: "PoolInner.withApplicationLicenses(List<String> applicationLicenses)"
summary: "Set the application<wbr>Licenses property: The list of application licenses the Batch service will make available on each compute node in the pool."
parameters:
- description: "the applicationLicenses value to set."
name: "applicationLicenses"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
syntax: "public PoolInner withApplicationLicenses(List<String> applicationLicenses)"
desc: "Set the applicationLicenses property: The list of application licenses the Batch service will make available on each compute node in the pool. 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."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withApplicationPackages(java.util.List<com.azure.resourcemanager.batch.models.ApplicationPackageReference>)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withApplicationPackages(List<ApplicationPackageReference> applicationPackages)"
name: "withApplicationPackages(List<ApplicationPackageReference> applicationPackages)"
nameWithType: "PoolInner.withApplicationPackages(List<ApplicationPackageReference> applicationPackages)"
summary: "Set the application<wbr>Packages property: The list of application packages to be installed on each compute node in the pool."
parameters:
- description: "the applicationPackages value to set."
name: "applicationPackages"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.ApplicationPackageReference?alt=com.azure.resourcemanager.batch.models.ApplicationPackageReference&text=ApplicationPackageReference\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PoolInner withApplicationPackages(List<ApplicationPackageReference> applicationPackages)"
desc: "Set the applicationPackages property: The list of application packages to be installed on each compute node in the pool. 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."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withCertificates(java.util.List<com.azure.resourcemanager.batch.models.CertificateReference>)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withCertificates(List<CertificateReference> certificates)"
name: "withCertificates(List<CertificateReference> certificates)"
nameWithType: "PoolInner.withCertificates(List<CertificateReference> certificates)"
summary: "Set the certificates property: The list of certificates to be installed on each compute node in the pool."
parameters:
- description: "the certificates value to set."
name: "certificates"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.CertificateReference?alt=com.azure.resourcemanager.batch.models.CertificateReference&text=CertificateReference\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PoolInner withCertificates(List<CertificateReference> certificates)"
desc: "Set the certificates property: The list of certificates to be installed on each compute node in the pool. 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."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withDeploymentConfiguration(com.azure.resourcemanager.batch.models.DeploymentConfiguration)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)"
name: "withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)"
nameWithType: "PoolInner.withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)"
summary: "Set the deployment<wbr>Configuration property: Deployment configuration properties."
parameters:
- description: "the deploymentConfiguration value to set."
name: "deploymentConfiguration"
type: "<xref href=\"com.azure.resourcemanager.batch.models.DeploymentConfiguration?alt=com.azure.resourcemanager.batch.models.DeploymentConfiguration&text=DeploymentConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withDeploymentConfiguration(DeploymentConfiguration deploymentConfiguration)"
desc: "Set the deploymentConfiguration property: Deployment configuration properties. Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS)."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withDisplayName(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withDisplayName(String displayName)"
name: "withDisplayName(String displayName)"
nameWithType: "PoolInner.withDisplayName(String displayName)"
summary: "Set the display<wbr>Name property: The display name for the pool."
parameters:
- description: "the displayName value to set."
name: "displayName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PoolInner withDisplayName(String displayName)"
desc: "Set the displayName property: The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withIdentity(com.azure.resourcemanager.batch.models.BatchPoolIdentity)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withIdentity(BatchPoolIdentity identity)"
name: "withIdentity(BatchPoolIdentity identity)"
nameWithType: "PoolInner.withIdentity(BatchPoolIdentity identity)"
summary: "Set the identity property: The type of identity used for the Batch Pool."
parameters:
- description: "the identity value to set."
name: "identity"
type: "<xref href=\"com.azure.resourcemanager.batch.models.BatchPoolIdentity?alt=com.azure.resourcemanager.batch.models.BatchPoolIdentity&text=BatchPoolIdentity\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withIdentity(BatchPoolIdentity identity)"
desc: "Set the identity property: The type of identity used for the Batch Pool."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withInterNodeCommunication(com.azure.resourcemanager.batch.models.InterNodeCommunicationState)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication)"
name: "withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication)"
nameWithType: "PoolInner.withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication)"
summary: "Set the inter<wbr>Node<wbr>Communication property: Whether the pool permits direct communication between nodes."
parameters:
- description: "the interNodeCommunication value to set."
name: "interNodeCommunication"
type: "<xref href=\"com.azure.resourcemanager.batch.models.InterNodeCommunicationState?alt=com.azure.resourcemanager.batch.models.InterNodeCommunicationState&text=InterNodeCommunicationState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withInterNodeCommunication(InterNodeCommunicationState interNodeCommunication)"
desc: "Set the interNodeCommunication property: Whether the pool permits direct communication between nodes. 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'."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withMetadata(java.util.List<com.azure.resourcemanager.batch.models.MetadataItem>)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withMetadata(List<MetadataItem> metadata)"
name: "withMetadata(List<MetadataItem> metadata)"
nameWithType: "PoolInner.withMetadata(List<MetadataItem> metadata)"
summary: "Set the metadata property: A list of name-value pairs associated with the pool as metadata."
parameters:
- description: "the metadata value to set."
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.MetadataItem?alt=com.azure.resourcemanager.batch.models.MetadataItem&text=MetadataItem\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PoolInner withMetadata(List<MetadataItem> metadata)"
desc: "Set the metadata property: A list of name-value pairs associated with the pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withMountConfiguration(java.util.List<com.azure.resourcemanager.batch.models.MountConfiguration>)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withMountConfiguration(List<MountConfiguration> mountConfiguration)"
name: "withMountConfiguration(List<MountConfiguration> mountConfiguration)"
nameWithType: "PoolInner.withMountConfiguration(List<MountConfiguration> mountConfiguration)"
summary: "Set the mount<wbr>Configuration property: A list of file systems to mount on each node in the pool."
parameters:
- description: "the mountConfiguration value to set."
name: "mountConfiguration"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.MountConfiguration?alt=com.azure.resourcemanager.batch.models.MountConfiguration&text=MountConfiguration\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PoolInner withMountConfiguration(List<MountConfiguration> mountConfiguration)"
desc: "Set the mountConfiguration property: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withNetworkConfiguration(com.azure.resourcemanager.batch.models.NetworkConfiguration)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withNetworkConfiguration(NetworkConfiguration networkConfiguration)"
name: "withNetworkConfiguration(NetworkConfiguration networkConfiguration)"
nameWithType: "PoolInner.withNetworkConfiguration(NetworkConfiguration networkConfiguration)"
summary: "Set the network<wbr>Configuration property: The network configuration for a pool."
parameters:
- description: "the networkConfiguration value to set."
name: "networkConfiguration"
type: "<xref href=\"com.azure.resourcemanager.batch.models.NetworkConfiguration?alt=com.azure.resourcemanager.batch.models.NetworkConfiguration&text=NetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withNetworkConfiguration(NetworkConfiguration networkConfiguration)"
desc: "Set the networkConfiguration property: The network configuration for a pool."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withResourceTags(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withResourceTags(Map<String,String> resourceTags)"
name: "withResourceTags(Map<String,String> resourceTags)"
nameWithType: "PoolInner.withResourceTags(Map<String,String> resourceTags)"
summary: "Set the resource<wbr>Tags property: The user-defined tags to be associated with the Azure Batch Pool."
parameters:
- description: "the resourceTags value to set."
name: "resourceTags"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
syntax: "public PoolInner withResourceTags(Map<String,String> resourceTags)"
desc: "Set the resourceTags property: 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'."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withScaleSettings(com.azure.resourcemanager.batch.models.ScaleSettings)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withScaleSettings(ScaleSettings scaleSettings)"
name: "withScaleSettings(ScaleSettings scaleSettings)"
nameWithType: "PoolInner.withScaleSettings(ScaleSettings scaleSettings)"
summary: "Set the scale<wbr>Settings property: Scale settings for the pool Defines the desired size of the pool."
parameters:
- description: "the scaleSettings value to set."
name: "scaleSettings"
type: "<xref href=\"com.azure.resourcemanager.batch.models.ScaleSettings?alt=com.azure.resourcemanager.batch.models.ScaleSettings&text=ScaleSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withScaleSettings(ScaleSettings scaleSettings)"
desc: "Set the scaleSettings property: Scale settings for the pool 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."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withStartTask(com.azure.resourcemanager.batch.models.StartTask)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withStartTask(StartTask startTask)"
name: "withStartTask(StartTask startTask)"
nameWithType: "PoolInner.withStartTask(StartTask startTask)"
summary: "Set the start<wbr>Task property: A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged."
parameters:
- description: "the startTask value to set."
name: "startTask"
type: "<xref href=\"com.azure.resourcemanager.batch.models.StartTask?alt=com.azure.resourcemanager.batch.models.StartTask&text=StartTask\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withStartTask(StartTask startTask)"
desc: "Set the startTask property: A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withTargetNodeCommunicationMode(com.azure.resourcemanager.batch.models.NodeCommunicationMode)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)"
name: "withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)"
nameWithType: "PoolInner.withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)"
summary: "Set the target<wbr>Node<wbr>Communication<wbr>Mode property: Determines how a pool communicates with the Batch service."
parameters:
- description: "the targetNodeCommunicationMode value to set."
name: "targetNodeCommunicationMode"
type: "<xref href=\"com.azure.resourcemanager.batch.models.NodeCommunicationMode?alt=com.azure.resourcemanager.batch.models.NodeCommunicationMode&text=NodeCommunicationMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withTargetNodeCommunicationMode(NodeCommunicationMode targetNodeCommunicationMode)"
desc: "Set the targetNodeCommunicationMode property: Determines how a pool communicates with the Batch service. If omitted, the default value is Default."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withTaskSchedulingPolicy(com.azure.resourcemanager.batch.models.TaskSchedulingPolicy)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)"
name: "withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)"
nameWithType: "PoolInner.withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)"
summary: "Set the task<wbr>Scheduling<wbr>Policy property: Specifies how tasks should be distributed across compute nodes."
parameters:
- description: "the taskSchedulingPolicy value to set."
name: "taskSchedulingPolicy"
type: "<xref href=\"com.azure.resourcemanager.batch.models.TaskSchedulingPolicy?alt=com.azure.resourcemanager.batch.models.TaskSchedulingPolicy&text=TaskSchedulingPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)"
desc: "Set the taskSchedulingPolicy property: Specifies how tasks should be distributed across compute nodes. If not specified, the default is spread."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withTaskSlotsPerNode(java.lang.Integer)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withTaskSlotsPerNode(Integer taskSlotsPerNode)"
name: "withTaskSlotsPerNode(Integer taskSlotsPerNode)"
nameWithType: "PoolInner.withTaskSlotsPerNode(Integer taskSlotsPerNode)"
summary: "Set the task<wbr>Slots<wbr>Per<wbr>Node property: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool."
parameters:
- description: "the taskSlotsPerNode value to set."
name: "taskSlotsPerNode"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public PoolInner withTaskSlotsPerNode(Integer taskSlotsPerNode)"
desc: "Set the taskSlotsPerNode property: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. 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."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withUpgradePolicy(com.azure.resourcemanager.batch.models.UpgradePolicy)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withUpgradePolicy(UpgradePolicy upgradePolicy)"
name: "withUpgradePolicy(UpgradePolicy upgradePolicy)"
nameWithType: "PoolInner.withUpgradePolicy(UpgradePolicy upgradePolicy)"
summary: "Set the upgrade<wbr>Policy property: Describes an upgrade policy - automatic, manual, or rolling."
parameters:
- description: "the upgradePolicy value to set."
name: "upgradePolicy"
type: "<xref href=\"com.azure.resourcemanager.batch.models.UpgradePolicy?alt=com.azure.resourcemanager.batch.models.UpgradePolicy&text=UpgradePolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PoolInner withUpgradePolicy(UpgradePolicy upgradePolicy)"
desc: "Set the upgradePolicy property: Describes an upgrade policy - automatic, manual, or rolling."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withUserAccounts(java.util.List<com.azure.resourcemanager.batch.models.UserAccount>)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withUserAccounts(List<UserAccount> userAccounts)"
name: "withUserAccounts(List<UserAccount> userAccounts)"
nameWithType: "PoolInner.withUserAccounts(List<UserAccount> userAccounts)"
summary: "Set the user<wbr>Accounts property: The list of user accounts to be created on each node in the pool."
parameters:
- description: "the userAccounts value to set."
name: "userAccounts"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.UserAccount?alt=com.azure.resourcemanager.batch.models.UserAccount&text=UserAccount\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PoolInner withUserAccounts(List<UserAccount> userAccounts)"
desc: "Set the userAccounts property: The list of user accounts to be created on each node in the pool."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withVmSize(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.fluent.models.PoolInner.withVmSize(String vmSize)"
name: "withVmSize(String vmSize)"
nameWithType: "PoolInner.withVmSize(String vmSize)"
summary: "Set the vm<wbr>Size property: The size of virtual machines in the pool."
parameters:
- description: "the vmSize value to set."
name: "vmSize"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PoolInner withVmSize(String vmSize)"
desc: "Set the vmSize property: The size of virtual machines in the pool. All VMs in a pool are the same size. 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)."
returns:
description: "the PoolInner object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.fluent.models.PoolInner?alt=com.azure.resourcemanager.batch.fluent.models.PoolInner&text=PoolInner\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Contains information about a pool."
metadata: {}
package: "com.azure.resourcemanager.batch.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:1.1.0-beta.4