Class: Azure::Compute::Mgmt::V2018_10_01::Models::VirtualMachine

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb

Overview

Describes a 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.

Returns:



34
35
36
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 34

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



59
60
61
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 59

def availability_set
  @availability_set
end

#diagnostics_profile ⇒ DiagnosticsProfile

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

Returns:



46
47
48
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 46

def diagnostics_profile
  @diagnostics_profile
end

#hardware_profile ⇒ HardwareProfile

virtual machine.

Returns:



26
27
28
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 26

def hardware_profile
  @hardware_profile
end

#identity ⇒ VirtualMachineIdentity

if configured.

Returns:



95
96
97
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 95

def identity
  @identity
end

#instance_view ⇒ VirtualMachineInstanceView

Returns The virtual machine instance view.

Returns:



71
72
73
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 71

def instance_view
  @instance_view
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



82
83
84
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 82

def license_type
  @license_type
end

#network_profile ⇒ NetworkProfile

virtual machine.

Returns:



42
43
44
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 42

def network_profile
  @network_profile
end

#os_profile ⇒ OSProfile

virtual machine.

Returns:

  • (OSProfile) —

    Specifies the operating system settings for the



38
39
40
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 38

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



22
23
24
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 22

def plan
  @plan
end

#provisioning_state ⇒ String

response.

Returns:

  • (String) —

    The provisioning state, which only appears in the



68
69
70
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 68

def provisioning_state
  @provisioning_state
end

#proximity_placement_group ⇒ SubResource

placement group that the virtual machine should be assigned to.
Minimum api-version: 2018-04-01.

Returns:

  • (SubResource) —

    Specifies information about the proximity



64
65
66
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 64

def proximity_placement_group
  @proximity_placement_group
end

#resources ⇒ Array<VirtualMachineExtension>

extension resources.

Returns:



91
92
93
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 91

def resources
  @resources
end

#storage_profile ⇒ StorageProfile

machine disks.

Returns:



30
31
32
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 30

def storage_profile
  @storage_profile
end

#vm_id ⇒ String

identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

Returns:

  • (String) —

    Specifies the VM unique ID which is a 128-bits



87
88
89
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 87

def vm_id
  @vm_id
end

#zones ⇒ Array<String>

Returns The virtual machine zones.

Returns:

  • (Array<String>) —

    The virtual machine zones.



98
99
100
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 98

def zones
  @zones
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2018-10-01/generated/azure_mgmt_compute/models/virtual_machine.rb', line 105

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VirtualMachine',
    type: {
      name: 'Composite',
      class_name: 'VirtualMachine',
      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'
                }
            }
          }
        },
        plan: {
          client_side_validation: true,
          required: false,
          serialized_name: 'plan',
          type: {
            name: 'Composite',
            class_name: 'Plan'
          }
        },
        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'
          }
        },
        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'
          }
        },
        proximity_placement_group: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.proximityPlacementGroup',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        instance_view: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.instanceView',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineInstanceView'
          }
        },
        license_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.licenseType',
          type: {
            name: 'String'
          }
        },
        vm_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.vmId',
          type: {
            name: 'String'
          }
        },
        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'
                }
            }
          }
        },
        identity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'identity',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineIdentity'
          }
        },
        zones: {
          client_side_validation: true,
          required: false,
          serialized_name: 'zones',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end