Class: Azure::ContainerService::Mgmt::V2020_06_01::Models::AgentPool

Inherits:
SubResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb

Overview

Agent Pool.

Instance Attribute Summary collapse

Attributes inherited from SubResource

#id, #name, #type

Class Method Summary collapse

Instance Attribute Details

#agent_pool_type ⇒ AgentPoolType

pool. Possible values include: ‘VirtualMachineScaleSets’, ‘AvailabilitySet’

Returns:



105
106
107
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 105

def agent_pool_type
  @agent_pool_type
end

#availability_zones ⇒ Array<String>

VirtualMachineScaleSets AgentPoolType.

Returns:

  • (Array<String>) —

    Availability zones for nodes. Must use



127
128
129
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 127

def availability_zones
  @availability_zones
end

#count ⇒ Integer

Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1.

Returns:

  • (Integer) —

    Number of agents (VMs) to host docker containers.



19
20
21
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 19

def count
  @count
end

#enable_auto_scaling ⇒ Boolean

Returns Whether to enable auto-scaler.

Returns:

  • (Boolean) —

    Whether to enable auto-scaler



100
101
102
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 100

def enable_auto_scaling
  @enable_auto_scaling
end

#enable_node_public_ip ⇒ Boolean

Returns Enable public IP for nodes.

Returns:

  • (Boolean) —

    Enable public IP for nodes



130
131
132
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 130

def enable_node_public_ip
  @enable_node_public_ip
end

#max_count ⇒ Integer

Returns Maximum number of nodes for auto-scaling.

Returns:

  • (Integer) —

    Maximum number of nodes for auto-scaling



94
95
96
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 94

def max_count
  @max_count
end

#max_pods ⇒ Integer

Returns Maximum number of pods that can run on a node.

Returns:

  • (Integer) —

    Maximum number of pods that can run on a node.



86
87
88
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 86

def max_pods
  @max_pods
end

#min_count ⇒ Integer

Returns Minimum number of nodes for auto-scaling.

Returns:

  • (Integer) —

    Minimum number of nodes for auto-scaling



97
98
99
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 97

def min_count
  @min_count
end

#mode ⇒ AgentPoolMode

Possible values include: ‘System’, ‘User’

Returns:

  • (AgentPoolMode) —

    AgentPoolMode represents mode of an agent pool.



109
110
111
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 109

def mode
  @mode
end

#node_image_version ⇒ String

Returns Version of node image.

Returns:

  • (String) —

    Version of node image



116
117
118
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 116

def node_image_version
  @node_image_version
end

#node_labels ⇒ Hash{String => String}

across all nodes in agent pool.

Returns:

  • (Hash{String => String}) —

    Agent pool node labels to be persisted



155
156
157
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 155

def node_labels
  @node_labels
end

#node_taints ⇒ Array<String>

create and scale. For example, key=value:NoSchedule.

Returns:

  • (Array<String>) —

    Taints added to new nodes during node pool



159
160
161
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 159

def node_taints
  @node_taints
end

#orchestrator_version ⇒ String

managed cluster.

Returns:

  • (String) —

    Version of orchestrator specified when creating the



113
114
115
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 113

def orchestrator_version
  @orchestrator_version
end

#os_disk_size_gb ⇒ Integer

size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

Returns:

  • (Integer) —

    OS Disk Size in GB to be used to specify the disk



80
81
82
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 80

def os_disk_size_gb
  @os_disk_size_gb
end

#os_type ⇒ OSType

Linux and Windows. Default to Linux. Possible values include: ‘Linux’, ‘Windows’. Default value: ‘Linux’ .

Returns:

  • (OSType) —

    OsType to be used to specify os type. Choose from



91
92
93
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 91

def os_type
  @os_type
end

#provisioning_state ⇒ String

only appears in the response.

Returns:

  • (String) —

    The current deployment or provisioning state, which



123
124
125
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 123

def provisioning_state
  @provisioning_state
end

#proximity_placement_group_id ⇒ String

Returns The ID for Proximity Placement Group.

Returns:

  • (String) —

    The ID for Proximity Placement Group.



162
163
164
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 162

def proximity_placement_group_id
  @proximity_placement_group_id
end

#scale_set_eviction_policy ⇒ ScaleSetEvictionPolicy

specify eviction policy for Spot virtual machine scale set. Default to Delete. Possible values include: ‘Delete’, ‘Deallocate’. Default value: ‘Delete’ .

Returns:



141
142
143
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 141

def scale_set_eviction_policy
  @scale_set_eviction_policy
end

#scale_set_priority ⇒ ScaleSetPriority

virtual machine scale set priority. Default to regular. Possible values include: ‘Spot’, ‘Regular’. Default value: ‘Regular’ .

Returns:



135
136
137
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 135

def scale_set_priority
  @scale_set_priority
end

#spot_max_price ⇒ Float

you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.

Returns:

  • (Float) —

    SpotMaxPrice to be used to specify the maximum price



147
148
149
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 147

def spot_max_price
  @spot_max_price
end

#tags ⇒ Hash{String => String}

agent pool virtual machine scale set.

Returns:

  • (Hash{String => String}) —

    Agent pool tags to be persisted on the



151
152
153
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 151

def tags
  @tags
end

#upgrade_settings ⇒ AgentPoolUpgradeSettings

Returns Settings for upgrading the agentpool.

Returns:



119
120
121
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 119

def upgrade_settings
  @upgrade_settings
end

#vm_size ⇒ ContainerServiceVMSizeTypes

values include: ‘Standard_A1’, ‘Standard_A10’, ‘Standard_A11’, ‘Standard_A1_v2’, ‘Standard_A2’, ‘Standard_A2_v2’, ‘Standard_A2m_v2’, ‘Standard_A3’, ‘Standard_A4’, ‘Standard_A4_v2’, ‘Standard_A4m_v2’, ‘Standard_A5’, ‘Standard_A6’, ‘Standard_A7’, ‘Standard_A8’, ‘Standard_A8_v2’, ‘Standard_A8m_v2’, ‘Standard_A9’, ‘Standard_B2ms’, ‘Standard_B2s’, ‘Standard_B4ms’, ‘Standard_B8ms’, ‘Standard_D1’, ‘Standard_D11’, ‘Standard_D11_v2’, ‘Standard_D11_v2_Promo’, ‘Standard_D12’, ‘Standard_D12_v2’, ‘Standard_D12_v2_Promo’, ‘Standard_D13’, ‘Standard_D13_v2’, ‘Standard_D13_v2_Promo’, ‘Standard_D14’, ‘Standard_D14_v2’, ‘Standard_D14_v2_Promo’, ‘Standard_D15_v2’, ‘Standard_D16_v3’, ‘Standard_D16s_v3’, ‘Standard_D1_v2’, ‘Standard_D2’, ‘Standard_D2_v2’, ‘Standard_D2_v2_Promo’, ‘Standard_D2_v3’, ‘Standard_D2s_v3’, ‘Standard_D3’, ‘Standard_D32_v3’, ‘Standard_D32s_v3’, ‘Standard_D3_v2’, ‘Standard_D3_v2_Promo’, ‘Standard_D4’, ‘Standard_D4_v2’, ‘Standard_D4_v2_Promo’, ‘Standard_D4_v3’, ‘Standard_D4s_v3’, ‘Standard_D5_v2’, ‘Standard_D5_v2_Promo’, ‘Standard_D64_v3’, ‘Standard_D64s_v3’, ‘Standard_D8_v3’, ‘Standard_D8s_v3’, ‘Standard_DS1’, ‘Standard_DS11’, ‘Standard_DS11_v2’, ‘Standard_DS11_v2_Promo’, ‘Standard_DS12’, ‘Standard_DS12_v2’, ‘Standard_DS12_v2_Promo’, ‘Standard_DS13’, ‘Standard_DS13-2_v2’, ‘Standard_DS13-4_v2’, ‘Standard_DS13_v2’, ‘Standard_DS13_v2_Promo’, ‘Standard_DS14’, ‘Standard_DS14-4_v2’, ‘Standard_DS14-8_v2’, ‘Standard_DS14_v2’, ‘Standard_DS14_v2_Promo’, ‘Standard_DS15_v2’, ‘Standard_DS1_v2’, ‘Standard_DS2’, ‘Standard_DS2_v2’, ‘Standard_DS2_v2_Promo’, ‘Standard_DS3’, ‘Standard_DS3_v2’, ‘Standard_DS3_v2_Promo’, ‘Standard_DS4’, ‘Standard_DS4_v2’, ‘Standard_DS4_v2_Promo’, ‘Standard_DS5_v2’, ‘Standard_DS5_v2_Promo’, ‘Standard_E16_v3’, ‘Standard_E16s_v3’, ‘Standard_E2_v3’, ‘Standard_E2s_v3’, ‘Standard_E32-16s_v3’, ‘Standard_E32-8s_v3’, ‘Standard_E32_v3’, ‘Standard_E32s_v3’, ‘Standard_E4_v3’, ‘Standard_E4s_v3’, ‘Standard_E64-16s_v3’, ‘Standard_E64-32s_v3’, ‘Standard_E64_v3’, ‘Standard_E64s_v3’, ‘Standard_E8_v3’, ‘Standard_E8s_v3’, ‘Standard_F1’, ‘Standard_F16’, ‘Standard_F16s’, ‘Standard_F16s_v2’, ‘Standard_F1s’, ‘Standard_F2’, ‘Standard_F2s’, ‘Standard_F2s_v2’, ‘Standard_F32s_v2’, ‘Standard_F4’, ‘Standard_F4s’, ‘Standard_F4s_v2’, ‘Standard_F64s_v2’, ‘Standard_F72s_v2’, ‘Standard_F8’, ‘Standard_F8s’, ‘Standard_F8s_v2’, ‘Standard_G1’, ‘Standard_G2’, ‘Standard_G3’, ‘Standard_G4’, ‘Standard_G5’, ‘Standard_GS1’, ‘Standard_GS2’, ‘Standard_GS3’, ‘Standard_GS4’, ‘Standard_GS4-4’, ‘Standard_GS4-8’, ‘Standard_GS5’, ‘Standard_GS5-16’, ‘Standard_GS5-8’, ‘Standard_H16’, ‘Standard_H16m’, ‘Standard_H16mr’, ‘Standard_H16r’, ‘Standard_H8’, ‘Standard_H8m’, ‘Standard_L16s’, ‘Standard_L32s’, ‘Standard_L4s’, ‘Standard_L8s’, ‘Standard_M128-32ms’, ‘Standard_M128-64ms’, ‘Standard_M128ms’, ‘Standard_M128s’, ‘Standard_M64-16ms’, ‘Standard_M64-32ms’, ‘Standard_M64ms’, ‘Standard_M64s’, ‘Standard_NC12’, ‘Standard_NC12s_v2’, ‘Standard_NC12s_v3’, ‘Standard_NC24’, ‘Standard_NC24r’, ‘Standard_NC24rs_v2’, ‘Standard_NC24rs_v3’, ‘Standard_NC24s_v2’, ‘Standard_NC24s_v3’, ‘Standard_NC6’, ‘Standard_NC6s_v2’, ‘Standard_NC6s_v3’, ‘Standard_ND12s’, ‘Standard_ND24rs’, ‘Standard_ND24s’, ‘Standard_ND6s’, ‘Standard_NV12’, ‘Standard_NV24’, ‘Standard_NV6’

Returns:



75
76
77
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 75

def vm_size
  @vm_size
end

#vnet_subnet_id ⇒ String

Returns VNet SubnetID specifies the VNet’s subnet identifier.

Returns:

  • (String) —

    VNet SubnetID specifies the VNet’s subnet identifier.



83
84
85
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 83

def vnet_subnet_id
  @vnet_subnet_id
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/models/agent_pool.rb', line 169

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'AgentPool',
    type: {
      name: 'Composite',
      class_name: 'AgentPool',
      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'
          }
        },
        count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.count',
          type: {
            name: 'Number'
          }
        },
        vm_size: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmSize',
          type: {
            name: 'String'
          }
        },
        os_disk_size_gb: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.osDiskSizeGB',
          type: {
            name: 'Number'
          }
        },
        vnet_subnet_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vnetSubnetID',
          type: {
            name: 'String'
          }
        },
        max_pods: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxPods',
          type: {
            name: 'Number'
          }
        },
        os_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.osType',
          default_value: 'Linux',
          type: {
            name: 'String'
          }
        },
        max_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxCount',
          type: {
            name: 'Number'
          }
        },
        min_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.minCount',
          type: {
            name: 'Number'
          }
        },
        enable_auto_scaling: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableAutoScaling',
          type: {
            name: 'Boolean'
          }
        },
        agent_pool_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.type',
          type: {
            name: 'String'
          }
        },
        mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.mode',
          type: {
            name: 'String'
          }
        },
        orchestrator_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.orchestratorVersion',
          type: {
            name: 'String'
          }
        },
        node_image_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.nodeImageVersion',
          type: {
            name: 'String'
          }
        },
        upgrade_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.upgradeSettings',
          type: {
            name: 'Composite',
            class_name: 'AgentPoolUpgradeSettings'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        availability_zones: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.availabilityZones',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        enable_node_public_ip: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableNodePublicIP',
          type: {
            name: 'Boolean'
          }
        },
        scale_set_priority: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.scaleSetPriority',
          default_value: 'Regular',
          type: {
            name: 'String'
          }
        },
        scale_set_eviction_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.scaleSetEvictionPolicy',
          default_value: 'Delete',
          type: {
            name: 'String'
          }
        },
        spot_max_price: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.spotMaxPrice',
          type: {
            name: 'Double'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        node_labels: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.nodeLabels',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        node_taints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.nodeTaints',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        proximity_placement_group_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.proximityPlacementGroupID',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end