Class: Azure::Compute::Mgmt::V2020_09_30::Models::Snapshot

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb

Overview

Snapshot 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:



43
44
45
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 43

def creation_data
  @creation_data
end

#disk_access_id ⇒ String

endpoints on disks.

Returns:

  • (String) —

    ARM id of the DiskAccess resource for using private



87
88
89
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 87

def disk_access_id
  @disk_access_id
end

#disk_size_bytes ⇒ Integer

only.

Returns:

  • (Integer) —

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



54
55
56
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 54

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



50
51
52
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 50

def disk_size_gb
  @disk_size_gb
end

#disk_state ⇒ DiskState

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

Returns:

  • (DiskState) —

    The state of the snapshot. Possible values include:



59
60
61
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 59

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



79
80
81
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 79

def encryption
  @encryption
end

#encryption_settings_collection ⇒ EncryptionSettingsCollection

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

Returns:



67
68
69
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 67

def encryption_settings_collection
  @encryption_settings_collection
end

#extended_location ⇒ ExtendedLocation

will be created. Extended location cannot be changed.

Returns:



23
24
25
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 23

def extended_location
  @extended_location
end

#hyper_vgeneration ⇒ HyperVGeneration

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

Returns:



35
36
37
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 35

def hyper_vgeneration
  @hyper_vgeneration
end

#incremental ⇒ Boolean

snapshots on the same disk occupy less space than full snapshots and can be diffed.

Returns:

  • (Boolean) —

    Whether a snapshot is incremental. Incremental



75
76
77
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 75

def incremental
  @incremental
end

#managed_by ⇒ String

Returns Unused. Always Null.

Returns:

  • (String) —

    Unused. Always Null.



16
17
18
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 16

def managed_by
  @managed_by
end

#network_access_policy ⇒ NetworkAccessPolicy

'AllowPrivate', 'DenyAll'

Returns:



83
84
85
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 83

def network_access_policy
  @network_access_policy
end

#os_type ⇒ OperatingSystemTypes

values include: 'Windows', 'Linux'

Returns:



30
31
32
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 30

def os_type
  @os_type
end

#provisioning_state ⇒ String

Returns The disk provisioning state.

Returns:

  • (String) —

    The disk provisioning state.



70
71
72
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 70

def provisioning_state
  @provisioning_state
end

#purchase_plan ⇒ PurchasePlan

which the source disk for the snapshot was originally created.

Returns:

  • (PurchasePlan) —

    Purchase plan information for the image from



39
40
41
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 39

def purchase_plan
  @purchase_plan
end

#sku ⇒ SnapshotSku

Returns:



19
20
21
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 19

def sku
  @sku
end

#time_created ⇒ DateTime

Returns The time when the snapshot was created.

Returns:

  • (DateTime) —

    The time when the snapshot was created.



26
27
28
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 26

def time_created
  @time_created
end

#unique_id ⇒ String

Returns Unique Guid identifying the resource.

Returns:

  • (String) —

    Unique Guid identifying the resource.



62
63
64
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 62

def unique_id
  @unique_id
end

Class Method Details

.mapper ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
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
 
# File 'lib/2020-09-30/generated/azure_mgmt_compute/models/snapshot.rb', line 94

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Snapshot',
    type: {
      name: 'Composite',
      class_name: 'Snapshot',
      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'
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'SnapshotSku'
          }
        },
        extended_location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'extendedLocation',
          type: {
            name: 'Composite',
            class_name: 'ExtendedLocation'
          }
        },
        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'
          }
        },
        purchase_plan: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.purchasePlan',
          type: {
            name: 'Composite',
            class_name: 'PurchasePlan'
          }
        },
        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'
          }
        },
        disk_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diskState',
          type: {
            name: 'String'
          }
        },
        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'
          }
        },
        incremental: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.incremental',
          type: {
            name: 'Boolean'
          }
        },
        encryption: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.encryption',
          type: {
            name: 'Composite',
            class_name: 'Encryption'
          }
        },
        network_access_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkAccessPolicy',
          type: {
            name: 'String'
          }
        },
        disk_access_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diskAccessId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end