Class: Azure::ARM::DevTestLabs::Models::LabVirtualMachineCreationParameter

Inherits:
Object
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb

Overview

Properties for creating a virtual machine.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#allow_claimBoolean

the virtual machine

Returns:

  • (Boolean)

    Indicates whether another user can take ownership of



104
105
106
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 104

def allow_claim
  @allow_claim
end

#applicable_scheduleApplicableSchedule

machine.

Returns:



97
98
99
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 97

def applicable_schedule
  @applicable_schedule
end

#artifact_deployment_statusArtifactDeploymentStatusProperties

status for the virtual machine.

Returns:



83
84
85
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 83

def artifact_deployment_status
  @artifact_deployment_status
end

#artifactsArray<ArtifactInstallProperties>

installed on the virtual machine.

Returns:



79
80
81
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 79

def artifacts
  @artifacts
end

#bulk_creation_parametersBulkCreationParameters

instances to create.

Returns:



18
19
20
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 18

def bulk_creation_parameters
  @bulk_creation_parameters
end

#compute_vmComputeVmProperties

Returns The compute virtual machine properties.

Returns:



90
91
92
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 90

def compute_vm
  @compute_vm
end

#created_by_userString

Returns The email address of creator of the virtual machine.

Returns:

  • (String)

    The email address of creator of the virtual machine.



35
36
37
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 35

def created_by_user
  @created_by_user
end

#created_by_user_idString

machine.

Returns:

  • (String)

    The object identifier of the creator of the virtual



32
33
34
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 32

def created_by_user_id
  @created_by_user_id
end

#created_dateDateTime

Returns The creation date of the virtual machine.

Returns:

  • (DateTime)

    The creation date of the virtual machine.



38
39
40
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 38

def created_date
  @created_date
end

#custom_image_idString

Returns The custom image identifier of the virtual machine.

Returns:

  • (String)

    The custom image identifier of the virtual machine.



41
42
43
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 41

def custom_image_id
  @custom_image_id
end

#disallow_public_ip_addressBoolean

created without a public IP address.

Returns:

  • (Boolean)

    Indicates whether the virtual machine is to be



75
76
77
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 75

def disallow_public_ip_address
  @disallow_public_ip_address
end

#environment_idString

virtual machine, if any.

Returns:

  • (String)

    The resource ID of the environment that contains this



117
118
119
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 117

def environment_id
  @environment_id
end

#expiration_dateDateTime

Returns The expiration date for VM.

Returns:

  • (DateTime)

    The expiration date for VM.



100
101
102
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 100

def expiration_date
  @expiration_date
end

#fqdnString

machine.

Returns:

  • (String)

    The fully-qualified domain name of the virtual



64
65
66
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 64

def fqdn
  @fqdn
end

reference of the virtual machine.

Returns:



87
88
89
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 87

def gallery_image_reference
  @gallery_image_reference
end

#is_authentication_with_ssh_keyBoolean

key for authentication.

Returns:

  • (Boolean)

    Indicates whether this virtual machine uses an SSH



60
61
62
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 60

def is_authentication_with_ssh_key
  @is_authentication_with_ssh_key
end

#lab_subnet_nameString

Returns The lab subnet name of the virtual machine.

Returns:

  • (String)

    The lab subnet name of the virtual machine.



67
68
69
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 67

def lab_subnet_name
  @lab_subnet_name
end

#lab_virtual_network_idString

machine.

Returns:

  • (String)

    The lab virtual network identifier of the virtual



71
72
73
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 71

def lab_virtual_network_id
  @lab_virtual_network_id
end

#locationString

Returns The location of the new virtual machine or environment.

Returns:

  • (String)

    The location of the new virtual machine or environment



129
130
131
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 129

def location
  @location
end

#nameString

Returns The name of the virtual machine or environment.

Returns:

  • (String)

    The name of the virtual machine or environment



126
127
128
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 126

def name
  @name
end

#network_interfaceNetworkInterfaceProperties

Returns The network interface properties.

Returns:



93
94
95
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 93

def network_interface
  @network_interface
end

#notesString

Returns The notes of the virtual machine.

Returns:

  • (String)

    The notes of the virtual machine.



21
22
23
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 21

def notes
  @notes
end

#os_typeString

Returns The OS type of the virtual machine.

Returns:

  • (String)

    The OS type of the virtual machine.



44
45
46
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 44

def os_type
  @os_type
end

#owner_object_idString

machine.

Returns:

  • (String)

    The object identifier of the owner of the virtual



25
26
27
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 25

def owner_object_id
  @owner_object_id
end

#owner_user_principal_nameString

Returns The user principal name of the virtual machine owner.

Returns:

  • (String)

    The user principal name of the virtual machine owner.



28
29
30
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 28

def owner_user_principal_name
  @owner_user_principal_name
end

#passwordString

Returns The password of the virtual machine administrator.

Returns:

  • (String)

    The password of the virtual machine administrator.



53
54
55
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 53

def password
  @password
end

#provisioning_stateString

Returns The provisioning status of the resource.

Returns:

  • (String)

    The provisioning status of the resource.



120
121
122
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 120

def provisioning_state
  @provisioning_state
end

#sizeString

Returns The size of the virtual machine.

Returns:

  • (String)

    The size of the virtual machine.



47
48
49
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 47

def size
  @size
end

#ssh_keyString

Returns The SSH key of the virtual machine administrator.

Returns:

  • (String)

    The SSH key of the virtual machine administrator.



56
57
58
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 56

def ssh_key
  @ssh_key
end

#storage_typeString

Standard, Premium).

Returns:

  • (String)

    Storage type to use for virtual machine (i.e.



108
109
110
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 108

def storage_type
  @storage_type
end

#tagsHash{String => String}

Returns The tags of the resource.

Returns:

  • (Hash{String => String})

    The tags of the resource.



132
133
134
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 132

def tags
  @tags
end

#unique_identifierString

Returns The unique immutable identifier of a resource (Guid).

Returns:

  • (String)

    The unique immutable identifier of a resource (Guid).



123
124
125
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 123

def unique_identifier
  @unique_identifier
end

#user_nameString

Returns The user name of the virtual machine.

Returns:

  • (String)

    The user name of the virtual machine.



50
51
52
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 50

def user_name
  @user_name
end

#virtual_machine_creation_sourceVirtualMachineCreationSource

virtual machine. Output property only. Possible values include: ‘FromCustomImage’, ‘FromGalleryImage’

Returns:



113
114
115
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 113

def virtual_machine_creation_source
  @virtual_machine_creation_source
end

Class Method Details

.mapperObject

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



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
# File 'lib/generated/azure_mgmt_devtestlabs/models/lab_virtual_machine_creation_parameter.rb', line 139

def self.mapper()
  {
    required: false,
    serialized_name: 'LabVirtualMachineCreationParameter',
    type: {
      name: 'Composite',
      class_name: 'LabVirtualMachineCreationParameter',
      model_properties: {
        bulk_creation_parameters: {
          required: false,
          serialized_name: 'properties.bulkCreationParameters',
          type: {
            name: 'Composite',
            class_name: 'BulkCreationParameters'
          }
        },
        notes: {
          required: false,
          serialized_name: 'properties.notes',
          type: {
            name: 'String'
          }
        },
        owner_object_id: {
          required: false,
          serialized_name: 'properties.ownerObjectId',
          type: {
            name: 'String'
          }
        },
        owner_user_principal_name: {
          required: false,
          serialized_name: 'properties.ownerUserPrincipalName',
          type: {
            name: 'String'
          }
        },
        created_by_user_id: {
          required: false,
          serialized_name: 'properties.createdByUserId',
          type: {
            name: 'String'
          }
        },
        created_by_user: {
          required: false,
          serialized_name: 'properties.createdByUser',
          type: {
            name: 'String'
          }
        },
        created_date: {
          required: false,
          serialized_name: 'properties.createdDate',
          type: {
            name: 'DateTime'
          }
        },
        custom_image_id: {
          required: false,
          serialized_name: 'properties.customImageId',
          type: {
            name: 'String'
          }
        },
        os_type: {
          required: false,
          serialized_name: 'properties.osType',
          type: {
            name: 'String'
          }
        },
        size: {
          required: false,
          serialized_name: 'properties.size',
          type: {
            name: 'String'
          }
        },
        user_name: {
          required: false,
          serialized_name: 'properties.userName',
          type: {
            name: 'String'
          }
        },
        password: {
          required: false,
          serialized_name: 'properties.password',
          type: {
            name: 'String'
          }
        },
        ssh_key: {
          required: false,
          serialized_name: 'properties.sshKey',
          type: {
            name: 'String'
          }
        },
        is_authentication_with_ssh_key: {
          required: false,
          serialized_name: 'properties.isAuthenticationWithSshKey',
          type: {
            name: 'Boolean'
          }
        },
        fqdn: {
          required: false,
          serialized_name: 'properties.fqdn',
          type: {
            name: 'String'
          }
        },
        lab_subnet_name: {
          required: false,
          serialized_name: 'properties.labSubnetName',
          type: {
            name: 'String'
          }
        },
        lab_virtual_network_id: {
          required: false,
          serialized_name: 'properties.labVirtualNetworkId',
          type: {
            name: 'String'
          }
        },
        disallow_public_ip_address: {
          required: false,
          serialized_name: 'properties.disallowPublicIpAddress',
          type: {
            name: 'Boolean'
          }
        },
        artifacts: {
          required: false,
          serialized_name: 'properties.artifacts',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'ArtifactInstallPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ArtifactInstallProperties'
                }
            }
          }
        },
        artifact_deployment_status: {
          required: false,
          serialized_name: 'properties.artifactDeploymentStatus',
          type: {
            name: 'Composite',
            class_name: 'ArtifactDeploymentStatusProperties'
          }
        },
        gallery_image_reference: {
          required: false,
          serialized_name: 'properties.galleryImageReference',
          type: {
            name: 'Composite',
            class_name: 'GalleryImageReference'
          }
        },
        compute_vm: {
          required: false,
          serialized_name: 'properties.computeVm',
          type: {
            name: 'Composite',
            class_name: 'ComputeVmProperties'
          }
        },
        network_interface: {
          required: false,
          serialized_name: 'properties.networkInterface',
          type: {
            name: 'Composite',
            class_name: 'NetworkInterfaceProperties'
          }
        },
        applicable_schedule: {
          required: false,
          serialized_name: 'properties.applicableSchedule',
          type: {
            name: 'Composite',
            class_name: 'ApplicableSchedule'
          }
        },
        expiration_date: {
          required: false,
          serialized_name: 'properties.expirationDate',
          type: {
            name: 'DateTime'
          }
        },
        allow_claim: {
          required: false,
          serialized_name: 'properties.allowClaim',
          type: {
            name: 'Boolean'
          }
        },
        storage_type: {
          required: false,
          serialized_name: 'properties.storageType',
          type: {
            name: 'String'
          }
        },
        virtual_machine_creation_source: {
          required: false,
          serialized_name: 'properties.virtualMachineCreationSource',
          type: {
            name: 'String'
          }
        },
        environment_id: {
          required: false,
          serialized_name: 'properties.environmentId',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        unique_identifier: {
          required: false,
          serialized_name: 'properties.uniqueIdentifier',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        location: {
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end