Class: Azure::Compute::Mgmt::V2019_12_01::Models::VirtualMachineScaleSetVM

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb

Overview

Describes a virtual machine scale set virtual machine.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#additional_capabilities ⇒ AdditionalCapabilities

enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

Returns:



44
45
46
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 44

def additional_capabilities
  @additional_capabilities
end

#availability_set ⇒ SubResource

that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

Returns:

  • (SubResource) —

    Specifies information about the availability set



73
74
75
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 73

def availability_set
  @availability_set
end

#diagnostics_profile ⇒ DiagnosticsProfile

state.
Minimum api-version: 2015-06-15.

Returns:



60
61
62
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 60

def diagnostics_profile
  @diagnostics_profile
end

#hardware_profile ⇒ HardwareProfile

virtual machine.

Returns:



34
35
36
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 34

def hardware_profile
  @hardware_profile
end

#instance_id ⇒ String

Returns The virtual machine instance ID.

Returns:

  • (String) —

    The virtual machine instance ID.



16
17
18
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 16

def instance_id
  @instance_id
end

#instance_view ⇒ VirtualMachineScaleSetVMInstanceView

instance view.

Returns:



30
31
32
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 30

def instance_view
  @instance_view
end

#latest_model_applied ⇒ Boolean

to the virtual machine.

Returns:

  • (Boolean) —

    Specifies whether the latest model has been applied



23
24
25
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 23

def latest_model_applied
  @latest_model_applied
end

#license_type ⇒ String

was licensed on-premises. This element is only used for images that contain the Windows Server operating system.
Possible values are:
Windows_Client
Windows_Server
If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.
For more information, see [Azure Hybrid Use Benefit for Windows Server](docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)
Minimum api-version: 2015-06-15

Returns:

  • (String) —

    Specifies that the image or disk that is being used



88
89
90
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 88

def license_type
  @license_type
end

#model_definition_applied ⇒ String

machine is the model of the virtual machine scale set or the customized model for the virtual machine.

Returns:

  • (String) —

    Specifies whether the model applied to the virtual



93
94
95
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 93

def model_definition_applied
  @model_definition_applied
end

#network_profile ⇒ NetworkProfile

virtual machine.

Returns:



52
53
54
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 52

def network_profile
  @network_profile
end

#network_profile_configuration ⇒ VirtualMachineScaleSetVMNetworkProfileConfiguration

the network profile configuration of the virtual machine.

Returns:



56
57
58
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 56

def network_profile_configuration
  @network_profile_configuration
end

#os_profile ⇒ OSProfile

virtual machine.

Returns:

  • (OSProfile) —

    Specifies the operating system settings for the



48
49
50
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 48

def os_profile
  @os_profile
end

#plan ⇒ Plan

to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click *Save*.

Returns:

  • (Plan) —

    Specifies information about the marketplace image used



106
107
108
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 106

def plan
  @plan
end

#protection_policy ⇒ VirtualMachineScaleSetVMProtectionPolicy

protection policy of the virtual machine.

Returns:



97
98
99
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 97

def protection_policy
  @protection_policy
end

#provisioning_state ⇒ String

response.

Returns:

  • (String) —

    The provisioning state, which only appears in the



77
78
79
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 77

def provisioning_state
  @provisioning_state
end

#resources ⇒ Array<VirtualMachineExtension>

extension resources.

Returns:



110
111
112
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 110

def resources
  @resources
end

#sku ⇒ Sku

Returns The virtual machine SKU.

Returns:

  • (Sku) —

    The virtual machine SKU.



19
20
21
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 19

def sku
  @sku
end

#storage_profile ⇒ StorageProfile

machine disks.

Returns:



38
39
40
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 38

def storage_profile
  @storage_profile
end

#vm_id ⇒ String

Returns Azure VM unique ID.

Returns:

  • (String) —

    Azure VM unique ID.



26
27
28
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 26

def vm_id
  @vm_id
end

#zones ⇒ Array<String>

Returns The virtual machine zones.

Returns:

  • (Array<String>) —

    The virtual machine zones.



113
114
115
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 113

def zones
  @zones
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2019-12-01/generated/azure_mgmt_compute/models/virtual_machine_scale_set_vm.rb', line 120

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VirtualMachineScaleSetVM',
    type: {
      name: 'Composite',
      class_name: 'VirtualMachineScaleSetVM',
      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'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        instance_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'instanceId',
          type: {
            name: 'String'
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        },
        latest_model_applied: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.latestModelApplied',
          type: {
            name: 'Boolean'
          }
        },
        vm_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.vmId',
          type: {
            name: 'String'
          }
        },
        instance_view: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.instanceView',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineScaleSetVMInstanceView'
          }
        },
        hardware_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.hardwareProfile',
          type: {
            name: 'Composite',
            class_name: 'HardwareProfile'
          }
        },
        storage_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.storageProfile',
          type: {
            name: 'Composite',
            class_name: 'StorageProfile'
          }
        },
        additional_capabilities: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.additionalCapabilities',
          type: {
            name: 'Composite',
            class_name: 'AdditionalCapabilities'
          }
        },
        os_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.osProfile',
          type: {
            name: 'Composite',
            class_name: 'OSProfile'
          }
        },
        network_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkProfile',
          type: {
            name: 'Composite',
            class_name: 'NetworkProfile'
          }
        },
        network_profile_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkProfileConfiguration',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineScaleSetVMNetworkProfileConfiguration'
          }
        },
        diagnostics_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diagnosticsProfile',
          type: {
            name: 'Composite',
            class_name: 'DiagnosticsProfile'
          }
        },
        availability_set: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.availabilitySet',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        license_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.licenseType',
          type: {
            name: 'String'
          }
        },
        model_definition_applied: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.modelDefinitionApplied',
          type: {
            name: 'String'
          }
        },
        protection_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.protectionPolicy',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineScaleSetVMProtectionPolicy'
          }
        },
        plan: {
          client_side_validation: true,
          required: false,
          serialized_name: 'plan',
          type: {
            name: 'Composite',
            class_name: 'Plan'
          }
        },
        resources: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'resources',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VirtualMachineExtensionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VirtualMachineExtension'
                }
            }
          }
        },
        zones: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'zones',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end