Class: Azure::Compute::Mgmt::V2019_11_01::Models::Disk

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

Overview

Disk resource.

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

#creation_data ⇒ CreationData

information cannot be changed after the disk has been created.

Returns:



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

def creation_data
  @creation_data
end

#disk_iopsread_only ⇒ Integer

all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.

Returns:

  • (Integer) —

    The total number of IOPS that will be allowed across



81
82
83
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 81

def disk_iopsread_only
  @disk_iopsread_only
end

#disk_iopsread_write ⇒ Integer

settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

Returns:

  • (Integer) —

    The number of IOPS allowed for this disk; only



71
72
73
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 71

def disk_iopsread_write
  @disk_iopsread_write
end

#disk_mbps_read_only ⇒ Integer

across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

Returns:

  • (Integer) —

    The total throughput (MBps) that will be allowed



87
88
89
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 87

def disk_mbps_read_only
  @disk_mbps_read_only
end

#disk_mbps_read_write ⇒ Integer

for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

Returns:

  • (Integer) —

    The bandwidth allowed for this disk; only settable



76
77
78
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 76

def disk_mbps_read_write
  @disk_mbps_read_write
end

#disk_size_bytes ⇒ Integer

only.

Returns:

  • (Integer) —

    The size of the disk in bytes. This field is read



55
56
57
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 55

def disk_size_bytes
  @disk_size_bytes
end

#disk_size_gb ⇒ Integer

mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

Returns:

  • (Integer) —

    If creationData.createOption is Empty, this field is



51
52
53
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 51

def disk_size_gb
  @disk_size_gb
end

#disk_state ⇒ DiskState

'Unattached', 'Attached', 'Reserved', 'ActiveSAS', 'ReadyToUpload', 'ActiveUpload'

Returns:

  • (DiskState) —

    The state of the disk. Possible values include:



92
93
94
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 92

def disk_state
  @disk_state
end

#encryption ⇒ Encryption

rest with customer managed keys or platform managed keys.

Returns:

  • (Encryption) —

    Encryption property can be used to encrypt data at



96
97
98
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 96

def encryption
  @encryption
end

#encryption_settings_collection ⇒ EncryptionSettingsCollection

used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

Returns:



63
64
65
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 63

def encryption_settings_collection
  @encryption_settings_collection
end

#hyper_vgeneration ⇒ HyperVGeneration

Machine. Applicable to OS disks only. Possible values include: 'V1', 'V2'

Returns:



40
41
42
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 40

def hyper_vgeneration
  @hyper_vgeneration
end

#managed_by ⇒ String

the disk attached.

Returns:

  • (String) —

    A relative URI containing the ID of the VM that has



17
18
19
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 17

def managed_by
  @managed_by
end

#managed_by_extended ⇒ Array<String>

VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.

Returns:

  • (Array<String>) —

    List of relative URIs containing the IDs of the



22
23
24
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 22

def managed_by_extended
  @managed_by_extended
end

#max_shares ⇒ Integer

at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.

Returns:

  • (Integer) —

    The maximum number of VMs that can attach to the disk



101
102
103
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 101

def max_shares
  @max_shares
end

#os_type ⇒ OperatingSystemTypes

values include: 'Windows', 'Linux'

Returns:



35
36
37
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 35

def os_type
  @os_type
end

#provisioning_state ⇒ String

Returns The disk provisioning state.

Returns:

  • (String) —

    The disk provisioning state.



66
67
68
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 66

def provisioning_state
  @provisioning_state
end

#share_info ⇒ Array<ShareInfoElement>

have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.

Returns:



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

def share_info
  @share_info
end

#sku ⇒ DiskSku

Returns:



25
26
27
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 25

def sku
  @sku
end

#time_created ⇒ DateTime

Returns The time when the disk was created.

Returns:

  • (DateTime) —

    The time when the disk was created.



31
32
33
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 31

def time_created
  @time_created
end

#unique_id ⇒ String

Returns Unique Guid identifying the resource.

Returns:

  • (String) —

    Unique Guid identifying the resource.



58
59
60
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 58

def unique_id
  @unique_id
end

#zones ⇒ Array<String>

Returns The Logical zone list for Disk.

Returns:

  • (Array<String>) —

    The Logical zone list for Disk.



28
29
30
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 28

def zones
  @zones
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/2019-11-01/generated/azure_mgmt_compute/models/disk.rb', line 113

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Disk',
    type: {
      name: 'Composite',
      class_name: 'Disk',
      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'
                }
            }
          }
        },
        managed_by: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'managedBy',
          type: {
            name: 'String'
          }
        },
        managed_by_extended: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'managedByExtended',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'DiskSku'
          }
        },
        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'
                }
            }
          }
        },
        time_created: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.timeCreated',
          type: {
            name: 'DateTime'
          }
        },
        os_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.osType',
          type: {
            name: 'Enum',
            module: 'OperatingSystemTypes'
          }
        },
        hyper_vgeneration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.hyperVGeneration',
          type: {
            name: 'String'
          }
        },
        creation_data: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.creationData',
          type: {
            name: 'Composite',
            class_name: 'CreationData'
          }
        },
        disk_size_gb: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diskSizeGB',
          type: {
            name: 'Number'
          }
        },
        disk_size_bytes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.diskSizeBytes',
          type: {
            name: 'Number'
          }
        },
        unique_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.uniqueId',
          type: {
            name: 'String'
          }
        },
        encryption_settings_collection: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.encryptionSettingsCollection',
          type: {
            name: 'Composite',
            class_name: 'EncryptionSettingsCollection'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        disk_iopsread_write: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diskIOPSReadWrite',
          type: {
            name: 'Number'
          }
        },
        disk_mbps_read_write: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diskMBpsReadWrite',
          type: {
            name: 'Number'
          }
        },
        disk_iopsread_only: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diskIOPSReadOnly',
          type: {
            name: 'Number'
          }
        },
        disk_mbps_read_only: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diskMBpsReadOnly',
          type: {
            name: 'Number'
          }
        },
        disk_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.diskState',
          type: {
            name: 'String'
          }
        },
        encryption: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.encryption',
          type: {
            name: 'Composite',
            class_name: 'Encryption'
          }
        },
        max_shares: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxShares',
          type: {
            name: 'Number'
          }
        },
        share_info: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.shareInfo',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ShareInfoElementElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ShareInfoElement'
                }
            }
          }
        }
      }
    }
  }
end