Class: Azure::Storage::Mgmt::V2021_01_01::Models::FileShare

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

Overview

Properties of the file share, 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

#access_tier ⇒ ShareAccessTier

can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Possible values include: ‘TransactionOptimized’, ‘Hot’, ‘Cool’, ‘Premium’

Returns:



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

def access_tier
  @access_tier
end

#access_tier_change_time ⇒ DateTime

access tier.

Returns:

  • (DateTime) —

    Indicates the last modification time for share



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

def access_tier_change_time
  @access_tier_change_time
end

#access_tier_status ⇒ String

tier.

Returns:

  • (String) —

    Indicates if there is a pending transition for access



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

def access_tier_status
  @access_tier_status
end

#deleted ⇒ Boolean

Returns Indicates whether the share was deleted.

Returns:

  • (Boolean) —

    Indicates whether the share was deleted.



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

def deleted
  @deleted
end

#deleted_time ⇒ DateTime

Returns The deleted time if the share was deleted.

Returns:

  • (DateTime) —

    The deleted time if the share was deleted.



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

def deleted_time
  @deleted_time
end

#enabled_protocols ⇒ EnabledProtocols

the file share. Can only be specified when creating a share. Possible values include: ‘SMB’, ‘NFS’

Returns:



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

def enabled_protocols
  @enabled_protocols
end

#last_modified_time ⇒ DateTime

modified.

Returns:

  • (DateTime) —

    Returns the date and time the share was last



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

def last_modified_time
  @last_modified_time
end

#metadata ⇒ Hash{String => String}

the share as metadata.

Returns:

  • (Hash{String => String}) —

    A name-value pair to associate with



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

def metadata
  @metadata
end

#remaining_retention_days ⇒ Integer

deleted.

Returns:

  • (Integer) —

    Remaining retention days for share that was soft



50
51
52
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/file_share.rb', line 50

def remaining_retention_days
  @remaining_retention_days
end

#root_squash ⇒ RootSquashType

default is NoRootSquash. Possible values include: ‘NoRootSquash’, ‘RootSquash’, ‘AllSquash’

Returns:



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

def root_squash
  @root_squash
end

#share_quota ⇒ Integer

greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.

Returns:

  • (Integer) —

    The maximum size of the share, in gigabytes. Must be



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

def share_quota
  @share_quota
end

#share_usage_bytes ⇒ Integer

Note that this value may not include all recently created or recently resized files.

Returns:

  • (Integer) —

    The approximate size of the data stored on the share.



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

def share_usage_bytes
  @share_usage_bytes
end

#snapshot_time ⇒ DateTime

response of list shares with expand param “snapshots”.

Returns:

  • (DateTime) —

    Creation time of share snapshot returned in the



73
74
75
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/file_share.rb', line 73

def snapshot_time
  @snapshot_time
end

#version ⇒ String

Returns The version of the share.

Returns:

  • (String) —

    The version of the share.



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

def version
  @version
end

Class Method Details

.mapper ⇒ Object

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



80
81
82
83
84
85
86
87
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
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/models/file_share.rb', line 80

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'FileShare',
    type: {
      name: 'Composite',
      class_name: 'FileShare',
      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'
          }
        },
        last_modified_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModifiedTime',
          type: {
            name: 'DateTime'
          }
        },
        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'
                }
            }
          }
        },
        share_quota: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.shareQuota',
          constraints: {
            InclusiveMaximum: 102400,
            InclusiveMinimum: 1
          },
          type: {
            name: 'Number'
          }
        },
        enabled_protocols: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enabledProtocols',
          type: {
            name: 'String'
          }
        },
        root_squash: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.rootSquash',
          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'
          }
        },
        access_tier: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.accessTier',
          type: {
            name: 'String'
          }
        },
        access_tier_change_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accessTierChangeTime',
          type: {
            name: 'DateTime'
          }
        },
        access_tier_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accessTierStatus',
          type: {
            name: 'String'
          }
        },
        share_usage_bytes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.shareUsageBytes',
          type: {
            name: 'Number'
          }
        },
        snapshot_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.snapshotTime',
          type: {
            name: 'DateTime'
          }
        }
      }
    }
  }
end