Class: Azure::Storage::Mgmt::V2021_01_01::Models::BlobContainer

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

Overview

Properties of the blob container, including Id, resource name, resource type, Etag.

Instance Attribute Summary collapse

Attributes inherited from AzureEntityResource

#etag

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#default_encryption_scope ⇒ String

scope for all writes.

Returns:

  • (String) —

    Default the container to use specified encryption



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

def default_encryption_scope
  @default_encryption_scope
end

#deleted ⇒ Boolean

Returns Indicates whether the blob container was deleted.

Returns:

  • (Boolean) —

    Indicates whether the blob container was deleted.



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

def deleted
  @deleted
end

#deleted_time ⇒ DateTime

Returns Blob container deletion time.

Returns:

  • (DateTime) —

    Blob container deletion time.



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

def deleted_time
  @deleted_time
end

#deny_encryption_scope_override ⇒ Boolean

default.

Returns:

  • (Boolean) —

    Block override of encryption scope from the container



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

def deny_encryption_scope_override
  @deny_encryption_scope_override
end

#has_immutability_policy ⇒ Boolean

true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.

Returns:

  • (Boolean) —

    The hasImmutabilityPolicy public property is set to



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

def has_immutability_policy
  @has_immutability_policy
end

#has_legal_hold ⇒ Boolean

SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.

Returns:

  • (Boolean) —

    The hasLegalHold public property is set to true by



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

def has_legal_hold
  @has_legal_hold
end

#immutability_policy ⇒ ImmutabilityPolicyProperties

of the container.

Returns:



65
66
67
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/blob_container.rb', line 65

def immutability_policy
  @immutability_policy
end

#last_modified_time ⇒ DateTime

modified.

Returns:

  • (DateTime) —

    Returns the date and time the container was last



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

def last_modified_time
  @last_modified_time
end

#lease_duration ⇒ LeaseDuration

of infinite or fixed duration, only when the container is leased. Possible values include: ‘Infinite’, ‘Fixed’

Returns:

  • (LeaseDuration) —

    Specifies whether the lease on a container is



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

def lease_duration
  @lease_duration
end

#lease_state ⇒ LeaseState

include: ‘Available’, ‘Leased’, ‘Expired’, ‘Breaking’, ‘Broken’

Returns:

  • (LeaseState) —

    Lease state of the container. Possible values



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

def lease_state
  @lease_state
end

#lease_status ⇒ LeaseStatus

values include: ‘Locked’, ‘Unlocked’

Returns:

  • (LeaseStatus) —

    The lease status of the container. Possible



48
49
50
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/blob_container.rb', line 48

def lease_status
  @lease_status
end

#legal_hold ⇒ LegalHoldProperties

Returns The LegalHold property of the container.

Returns:



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

def legal_hold
  @legal_hold
end

#metadata ⇒ Hash{String => String}

the container as metadata.

Returns:

  • (Hash{String => String}) —

    A name-value pair to associate with



61
62
63
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/blob_container.rb', line 61

def metadata
  @metadata
end

#public_access ⇒ PublicAccess

accessed publicly and the level of access. Possible values include: ‘Container’, ‘Blob’, ‘None’

Returns:

  • (PublicAccess) —

    Specifies whether data in the container may be



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

def public_access
  @public_access
end

#remaining_retention_days ⇒ Integer

container.

Returns:

  • (Integer) —

    Remaining retention days for soft deleted blob



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

def remaining_retention_days
  @remaining_retention_days
end

#version ⇒ String

Returns The version of the deleted blob container.

Returns:

  • (String) —

    The version of the deleted blob container.



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

def version
  @version
end

Class Method Details

.mapper ⇒ Object

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



88
89
90
91
92
93
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
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/blob_container.rb', line 88

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'BlobContainer',
    type: {
      name: 'Composite',
      class_name: 'BlobContainer',
      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'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        },
        version: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.version',
          type: {
            name: 'String'
          }
        },
        deleted: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.deleted',
          type: {
            name: 'Boolean'
          }
        },
        deleted_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.deletedTime',
          type: {
            name: 'DateTime'
          }
        },
        remaining_retention_days: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.remainingRetentionDays',
          type: {
            name: 'Number'
          }
        },
        default_encryption_scope: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.defaultEncryptionScope',
          type: {
            name: 'String'
          }
        },
        deny_encryption_scope_override: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.denyEncryptionScopeOverride',
          type: {
            name: 'Boolean'
          }
        },
        public_access: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.publicAccess',
          type: {
            name: 'Enum',
            module: 'PublicAccess'
          }
        },
        last_modified_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModifiedTime',
          type: {
            name: 'DateTime'
          }
        },
        lease_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.leaseStatus',
          type: {
            name: 'String'
          }
        },
        lease_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.leaseState',
          type: {
            name: 'String'
          }
        },
        lease_duration: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.leaseDuration',
          type: {
            name: 'String'
          }
        },
        metadata: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.metadata',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        immutability_policy: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.immutabilityPolicy',
          type: {
            name: 'Composite',
            class_name: 'ImmutabilityPolicyProperties'
          }
        },
        legal_hold: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.legalHold',
          type: {
            name: 'Composite',
            class_name: 'LegalHoldProperties'
          }
        },
        has_legal_hold: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.hasLegalHold',
          type: {
            name: 'Boolean'
          }
        },
        has_immutability_policy: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.hasImmutabilityPolicy',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end