Class: Azure::Batch::Mgmt::V2018_12_01::Models::Pool

Inherits:
ProxyResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb

Overview

Contains information about a pool.

Instance Attribute Summary collapse

Attributes inherited from ProxyResource

#etag, #id, #name, #type

Class Method Summary collapse

Instance Attribute Details

#allocation_state ⇒ AllocationState

include: ‘Steady’, ‘Resizing’, ‘Stopping’

Returns:



39
40
41
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 39

def allocation_state
  @allocation_state
end

#allocation_state_transition_time ⇒ DateTime

allocation state.

Returns:

  • (DateTime) —

    The time at which the pool entered its current



43
44
45
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 43

def allocation_state_transition_time
  @allocation_state_transition_time
end

#application_licenses ⇒ Array<String>

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:

  • (Array<String>) —

    The list of application licenses the Batch



141
142
143
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 141

def application_licenses
  @application_licenses
end

#application_packages ⇒ Array<ApplicationPackageReference>

packages to be installed on each compute node in the pool. Changes to application packages 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.

Returns:



134
135
136
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 134

def application_packages
  @application_packages
end

#auto_scale_run ⇒ AutoScaleRun

of the autoscale formula. This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.

Returns:

  • (AutoScaleRun) —

    The results and errors from the last execution



82
83
84
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 82

def auto_scale_run
  @auto_scale_run
end

#certificates ⇒ Array<CertificateReference>

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.

Returns:



127
128
129
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 127

def certificates
  @certificates
end

#creation_time ⇒ DateTime

Returns The creation time of the pool.

Returns:

  • (DateTime) —

    The creation time of the pool.



27
28
29
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 27

def creation_time
  @creation_time
end

#current_dedicated_nodes ⇒ Integer

Returns The number of compute nodes currently in the pool.

Returns:

  • (Integer) —

    The number of compute nodes currently in the pool.



69
70
71
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 69

def current_dedicated_nodes
  @current_dedicated_nodes
end

#current_low_priority_nodes ⇒ Integer

the pool.

Returns:

  • (Integer) —

    The number of low priority compute nodes currently in



73
74
75
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 73

def current_low_priority_nodes
  @current_low_priority_nodes
end

#deployment_configuration ⇒ DeploymentConfiguration

nodes will be deployed - using Cloud Services or Virtual Machines. Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).

Returns:



66
67
68
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 66

def deployment_configuration
  @deployment_configuration
end

#display_name ⇒ String

not be unique and can contain any Unicode characters up to a maximum length of 1024.

Returns:

  • (String) —

    The display name for the pool. The display name need



18
19
20
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 18

def display_name
  @display_name
end

#inter_node_communication ⇒ InterNodeCommunicationState

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’. Possible values include: ‘Enabled’, ‘Disabled’

Returns:



90
91
92
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 90

def inter_node_communication
  @inter_node_communication
end

#last_modified ⇒ DateTime

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:

  • (DateTime) —

    The last modified time of the pool. This is the last



24
25
26
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 24

def last_modified
  @last_modified
end

#max_tasks_per_node ⇒ Integer

on a single compute node in the pool.

Returns:

  • (Integer) —

    The maximum number of tasks that can run concurrently



97
98
99
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 97

def max_tasks_per_node
  @max_tasks_per_node
end

#metadata ⇒ Array<MetadataItem>

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:

  • (Array<MetadataItem>) —

    A list of name-value pairs associated



110
111
112
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 110

def metadata
  @metadata
end

#network_configuration ⇒ NetworkConfiguration

Returns The network configuration for the pool.

Returns:



93
94
95
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 93

def network_configuration
  @network_configuration
end

#provisioning_state ⇒ PoolProvisioningState

values include: ‘Succeeded’, ‘Deleting’

Returns:



31
32
33
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 31

def provisioning_state
  @provisioning_state
end

#provisioning_state_transition_time ⇒ DateTime

state.

Returns:

  • (DateTime) —

    The time at which the pool entered its current



35
36
37
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 35

def provisioning_state_transition_time
  @provisioning_state_transition_time
end

#resize_operation_status ⇒ ResizeOperationStatus

last completed resize operation.

Returns:



145
146
147
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 145

def resize_operation_status
  @resize_operation_status
end

#scale_settings ⇒ ScaleSettings

the pool.

Returns:

  • (ScaleSettings) —

    Settings which configure the number of nodes in



77
78
79
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 77

def scale_settings
  @scale_settings
end

#start_task ⇒ StartTask

joins the pool. In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.

Returns:

  • (StartTask) —

    A task specified to run on each compute node as it



115
116
117
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 115

def start_task
  @start_task
end

#task_scheduling_policy ⇒ TaskSchedulingPolicy

nodes in a pool.

Returns:



101
102
103
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 101

def task_scheduling_policy
  @task_scheduling_policy
end

#user_accounts ⇒ Array<UserAccount>

each node in the pool.

Returns:

  • (Array<UserAccount>) —

    The list of user accounts to be created on



105
106
107
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 105

def user_accounts
  @user_accounts
end

#vm_size ⇒ String

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 (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) (azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (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:

  • (String) —

    The size of virtual machines in the pool. All VMs in a



59
60
61
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 59

def vm_size
  @vm_size
end

Class Method Details

.mapper ⇒ Object

Mapper for Pool class as Ruby Hash. This will be used for serialization/deserialization.



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
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/pool.rb', line 152

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Pool',
    type: {
      name: 'Composite',
      class_name: 'Pool',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        last_modified: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModified',
          type: {
            name: 'DateTime'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.creationTime',
          type: {
            name: 'DateTime'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'PoolProvisioningState'
          }
        },
        provisioning_state_transition_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningStateTransitionTime',
          type: {
            name: 'DateTime'
          }
        },
        allocation_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allocationState',
          type: {
            name: 'Enum',
            module: 'AllocationState'
          }
        },
        allocation_state_transition_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allocationStateTransitionTime',
          type: {
            name: 'DateTime'
          }
        },
        vm_size: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmSize',
          type: {
            name: 'String'
          }
        },
        deployment_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.deploymentConfiguration',
          type: {
            name: 'Composite',
            class_name: 'DeploymentConfiguration'
          }
        },
        current_dedicated_nodes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currentDedicatedNodes',
          type: {
            name: 'Number'
          }
        },
        current_low_priority_nodes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currentLowPriorityNodes',
          type: {
            name: 'Number'
          }
        },
        scale_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.scaleSettings',
          type: {
            name: 'Composite',
            class_name: 'ScaleSettings'
          }
        },
        auto_scale_run: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.autoScaleRun',
          type: {
            name: 'Composite',
            class_name: 'AutoScaleRun'
          }
        },
        inter_node_communication: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.interNodeCommunication',
          type: {
            name: 'Enum',
            module: 'InterNodeCommunicationState'
          }
        },
        network_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkConfiguration',
          type: {
            name: 'Composite',
            class_name: 'NetworkConfiguration'
          }
        },
        max_tasks_per_node: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxTasksPerNode',
          type: {
            name: 'Number'
          }
        },
        task_scheduling_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.taskSchedulingPolicy',
          type: {
            name: 'Composite',
            class_name: 'TaskSchedulingPolicy'
          }
        },
        user_accounts: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userAccounts',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'UserAccountElementType',
                type: {
                  name: 'Composite',
                  class_name: 'UserAccount'
                }
            }
          }
        },
        metadata: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.metadata',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MetadataItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MetadataItem'
                }
            }
          }
        },
        start_task: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.startTask',
          type: {
            name: 'Composite',
            class_name: 'StartTask'
          }
        },
        certificates: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.certificates',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CertificateReferenceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'CertificateReference'
                }
            }
          }
        },
        application_packages: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.applicationPackages',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ApplicationPackageReferenceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ApplicationPackageReference'
                }
            }
          }
        },
        application_licenses: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.applicationLicenses',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        resize_operation_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resizeOperationStatus',
          type: {
            name: 'Composite',
            class_name: 'ResizeOperationStatus'
          }
        }
      }
    }
  }
end