Class: Azure::Storage::Mgmt::V2021_01_01::Models::StorageAccount

Inherits:
TrackedResource show all
Includes:
MsRestAzure
Defined in:
lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb

Overview

The storage account.

Instance Attribute Summary collapse

Attributes inherited from TrackedResource

#location, #tags

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#access_tier ⇒ AccessTier

BlobStorage. The access tier used for billing. Possible values include: ‘Hot’, ‘Cool’

Returns:

  • (AccessTier) —

    Required for storage accounts where kind =



85
86
87
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 85

def access_tier
  @access_tier
end

#allow_blob_public_access ⇒ Boolean

containers in the storage account. The default interpretation is true for this property.

Returns:

  • (Boolean) —

    Allow or disallow public access to all blobs or



128
129
130
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 128

def allow_blob_public_access
  @allow_blob_public_access
end

#allow_shared_key_access ⇒ Boolean

requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.

Returns:

  • (Boolean) —

    Indicates whether the storage account permits



140
141
142
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 140

def allow_shared_key_access
  @allow_shared_key_access
end

#azure_files_identity_based_authentication ⇒ AzureFilesIdentityBasedAuthentication

based authentication settings for Azure Files.

Returns:



89
90
91
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 89

def azure_files_identity_based_authentication
  @azure_files_identity_based_authentication
end

#blob_restore_status ⇒ BlobRestoreStatus

Returns Blob restore status.

Returns:



123
124
125
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 123

def blob_restore_status
  @blob_restore_status
end

#creation_time ⇒ DateTime

account in UTC.

Returns:

  • (DateTime) —

    Gets the creation date and time of the storage



67
68
69
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 67

def creation_time
  @creation_time
end

#custom_domain ⇒ CustomDomain

storage account.

Returns:

  • (CustomDomain) —

    Gets the custom domain the user assigned to this



71
72
73
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 71

def custom_domain
  @custom_domain
end

#enable_https_traffic_only ⇒ Boolean

to true.

Returns:

  • (Boolean) —

    Allows https traffic only to storage service if sets



93
94
95
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 93

def enable_https_traffic_only
  @enable_https_traffic_only
end

#enable_nfs_v3 ⇒ Boolean

Returns NFS 3.0 protocol support enabled if set to true.

Returns:

  • (Boolean) —

    NFS 3.0 protocol support enabled if set to true.



143
144
145
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 143

def enable_nfs_v3
  @enable_nfs_v3
end

#encryption ⇒ Encryption

unspecified, the account is unencrypted.

Returns:

  • (Encryption) —

    Gets the encryption settings on the account. If



80
81
82
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 80

def encryption
  @encryption
end

#extended_location ⇒ ExtendedLocation

Returns The extendedLocation of the resource.

Returns:



26
27
28
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 26

def extended_location
  @extended_location
end

#failover_in_progress ⇒ Boolean

true, otherwise, it will be null.

Returns:

  • (Boolean) —

    If the failover is in progress, the value will be



107
108
109
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 107

def failover_in_progress
  @failover_in_progress
end

#geo_replication_stats ⇒ GeoReplicationStats

Returns Geo Replication Stats.

Returns:



103
104
105
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 103

def geo_replication_stats
  @geo_replication_stats
end

#identity ⇒ Identity

Returns The identity of the resource.

Returns:

  • (Identity) —

    The identity of the resource.



23
24
25
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 23

def identity
  @identity
end

#is_hns_enabled ⇒ Boolean

true.

Returns:

  • (Boolean) —

    Account HierarchicalNamespace enabled if sets to



100
101
102
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 100

def is_hns_enabled
  @is_hns_enabled
end

#kind ⇒ Kind

‘StorageV2’, ‘BlobStorage’, ‘FileStorage’, ‘BlockBlobStorage’

Returns:

  • (Kind) —

    Gets the Kind. Possible values include: ‘Storage’,



20
21
22
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 20

def kind
  @kind
end

#large_file_shares_state ⇒ LargeFileSharesState

Enabled. It cannot be disabled once it is enabled. Possible values include: ‘Disabled’, ‘Enabled’

Returns:



112
113
114
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 112

def large_file_shares_state
  @large_file_shares_state
end

#last_geo_failover_time ⇒ DateTime

failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.

Returns:

  • (DateTime) —

    Gets the timestamp of the most recent instance of a



52
53
54
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 52

def last_geo_failover_time
  @last_geo_failover_time
end

#minimum_tls_version ⇒ MinimumTlsVersion

on requests to storage. The default interpretation is TLS 1.0 for this property. Possible values include: ‘TLS1_0’, ‘TLS1_1’, ‘TLS1_2’

Returns:



133
134
135
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 133

def minimum_tls_version
  @minimum_tls_version
end

#network_rule_set ⇒ NetworkRuleSet

Returns Network rule set.

Returns:



96
97
98
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 96

def network_rule_set
  @network_rule_set
end

#primary_endpoints ⇒ Endpoints

of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.

Returns:

  • (Endpoints) —

    Gets the URLs that are used to perform a retrieval



36
37
38
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 36

def primary_endpoints
  @primary_endpoints
end

#primary_location ⇒ String

storage account.

Returns:

  • (String) —

    Gets the location of the primary data center for the



40
41
42
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 40

def primary_location
  @primary_location
end

#private_endpoint_connections ⇒ Array<PrivateEndpointConnection>

connection associated with the specified storage account

Returns:



116
117
118
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 116

def private_endpoint_connections
  @private_endpoint_connections
end

#provisioning_state ⇒ ProvisioningState

the time the operation was called. Possible values include: ‘Creating’, ‘ResolvingDNS’, ‘Succeeded’

Returns:



31
32
33
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 31

def provisioning_state
  @provisioning_state
end

#routing_preference ⇒ RoutingPreference

routing choice opted by the user for data transfer

Returns:



120
121
122
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 120

def routing_preference
  @routing_preference
end

#secondary_endpoints ⇒ Endpoints

of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS.

Returns:

  • (Endpoints) —

    Gets the URLs that are used to perform a retrieval



76
77
78
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 76

def secondary_endpoints
  @secondary_endpoints
end

#secondary_location ⇒ String

the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

Returns:

  • (String) —

    Gets the location of the geo-replicated secondary for



57
58
59
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 57

def secondary_location
  @secondary_location
end

#sku ⇒ Sku

Returns Gets the SKU.

Returns:

  • (Sku) —

    Gets the SKU.



16
17
18
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 16

def sku
  @sku
end

#status_of_primary ⇒ AccountStatus

location of the storage account is available or unavailable. Possible values include: ‘available’, ‘unavailable’

Returns:

  • (AccountStatus) —

    Gets the status indicating whether the primary



45
46
47
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 45

def status_of_primary
  @status_of_primary
end

#status_of_secondary ⇒ AccountStatus

secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS. Possible values include: ‘available’, ‘unavailable’

Returns:



63
64
65
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 63

def status_of_secondary
  @status_of_secondary
end

Class Method Details

.mapper ⇒ Object

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



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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/storage_account.rb', line 150

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'StorageAccount',
    type: {
      name: 'Composite',
      class_name: 'StorageAccount',
      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'
          }
        },
        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'
                }
            }
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        identity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'identity',
          type: {
            name: 'Composite',
            class_name: 'Identity'
          }
        },
        extended_location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'extendedLocation',
          type: {
            name: 'Composite',
            class_name: 'ExtendedLocation'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        primary_endpoints: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.primaryEndpoints',
          type: {
            name: 'Composite',
            class_name: 'Endpoints'
          }
        },
        primary_location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.primaryLocation',
          type: {
            name: 'String'
          }
        },
        status_of_primary: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.statusOfPrimary',
          type: {
            name: 'Enum',
            module: 'AccountStatus'
          }
        },
        last_geo_failover_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastGeoFailoverTime',
          type: {
            name: 'DateTime'
          }
        },
        secondary_location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.secondaryLocation',
          type: {
            name: 'String'
          }
        },
        status_of_secondary: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.statusOfSecondary',
          type: {
            name: 'Enum',
            module: 'AccountStatus'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.creationTime',
          type: {
            name: 'DateTime'
          }
        },
        custom_domain: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.customDomain',
          type: {
            name: 'Composite',
            class_name: 'CustomDomain'
          }
        },
        secondary_endpoints: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.secondaryEndpoints',
          type: {
            name: 'Composite',
            class_name: 'Endpoints'
          }
        },
        encryption: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.encryption',
          type: {
            name: 'Composite',
            class_name: 'Encryption'
          }
        },
        access_tier: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accessTier',
          type: {
            name: 'Enum',
            module: 'AccessTier'
          }
        },
        azure_files_identity_based_authentication: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.azureFilesIdentityBasedAuthentication',
          type: {
            name: 'Composite',
            class_name: 'AzureFilesIdentityBasedAuthentication'
          }
        },
        enable_https_traffic_only: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.supportsHttpsTrafficOnly',
          type: {
            name: 'Boolean'
          }
        },
        network_rule_set: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.networkAcls',
          type: {
            name: 'Composite',
            class_name: 'NetworkRuleSet'
          }
        },
        is_hns_enabled: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isHnsEnabled',
          type: {
            name: 'Boolean'
          }
        },
        geo_replication_stats: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.geoReplicationStats',
          type: {
            name: 'Composite',
            class_name: 'GeoReplicationStats'
          }
        },
        failover_in_progress: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.failoverInProgress',
          type: {
            name: 'Boolean'
          }
        },
        large_file_shares_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.largeFileSharesState',
          type: {
            name: 'String'
          }
        },
        private_endpoint_connections: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.privateEndpointConnections',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PrivateEndpointConnectionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PrivateEndpointConnection'
                }
            }
          }
        },
        routing_preference: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.routingPreference',
          type: {
            name: 'Composite',
            class_name: 'RoutingPreference'
          }
        },
        blob_restore_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.blobRestoreStatus',
          type: {
            name: 'Composite',
            class_name: 'BlobRestoreStatus'
          }
        },
        allow_blob_public_access: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.allowBlobPublicAccess',
          type: {
            name: 'Boolean'
          }
        },
        minimum_tls_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.minimumTlsVersion',
          type: {
            name: 'String'
          }
        },
        allow_shared_key_access: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.allowSharedKeyAccess',
          type: {
            name: 'Boolean'
          }
        },
        enable_nfs_v3: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isNfsV3Enabled',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end