-
Notifications
You must be signed in to change notification settings - Fork 180
/
RetentionPolicy.yml
40 lines (40 loc) · 1.2 KB
/
RetentionPolicy.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
### YamlMime:TSType
name: RetentionPolicy
uid: '@azure/storage-file-share.RetentionPolicy'
package: '@azure/storage-file-share'
summary: The retention policy.
fullName: RetentionPolicy
remarks: ''
isDeprecated: false
type: interface
properties:
- name: days
uid: '@azure/storage-file-share.RetentionPolicy.days'
package: '@azure/storage-file-share'
summary: >-
Indicates the number of days that metrics data should be retained. All
data older than this value will be deleted. Metrics data is deleted on a
best-effort basis after the retention period expires.
fullName: days
remarks: ''
isDeprecated: false
syntax:
content: 'days?: number'
return:
description: ''
type: number
- name: enabled
uid: '@azure/storage-file-share.RetentionPolicy.enabled'
package: '@azure/storage-file-share'
summary: >-
Indicates whether a retention policy is enabled for the File service. If
false, metrics data is retained, and the user is responsible for deleting
it.
fullName: enabled
remarks: ''
isDeprecated: false
syntax:
content: 'enabled: boolean'
return:
description: ''
type: boolean