-
Notifications
You must be signed in to change notification settings - Fork 180
/
FileSASPermissions.yml
117 lines (110 loc) · 3.27 KB
/
FileSASPermissions.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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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
### YamlMime:TSType
name: FileSASPermissions
uid: '@azure/storage-file.FileSASPermissions'
package: '@azure/storage-file'
summary: >
ONLY AVAILABLE IN NODE.JS RUNTIME.
This is a helper class to construct a string representing the permissions
granted by a ServiceSAS to a file. Setting
a value to true means that any SAS which uses these permissions will grant
permissions for that operation. Once all
the values are set, this should be serialized with toString and set as the
permissions field on a
<xref:IFileSASSignatureValues> object. It is possible to construct the
permissions string without this class, but
the order of the permissions is particular and this class guarantees
correctness.
fullName: FileSASPermissions
remarks: ''
isPreview: false
isDeprecated: false
type: class
properties:
- name: create
uid: '@azure/storage-file.FileSASPermissions.create'
package: '@azure/storage-file'
summary: Specifies Create access granted.
fullName: create
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'create: boolean'
return:
type: boolean
description: ''
- name: delete
uid: '@azure/storage-file.FileSASPermissions.delete'
package: '@azure/storage-file'
summary: Specifies Delete access granted.
fullName: delete
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'delete: boolean'
return:
type: boolean
description: ''
- name: read
uid: '@azure/storage-file.FileSASPermissions.read'
package: '@azure/storage-file'
summary: Specifies Read access granted.
fullName: read
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'read: boolean'
return:
type: boolean
description: ''
- name: write
uid: '@azure/storage-file.FileSASPermissions.write'
package: '@azure/storage-file'
summary: Specifies Write access granted.
fullName: write
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'write: boolean'
return:
type: boolean
description: ''
methods:
- name: parse(string)
uid: '@azure/storage-file.FileSASPermissions.parse'
package: '@azure/storage-file'
summary: >-
Creates a FileSASPermissions from the specified permissions string. This
method will throw an
Error if it encounters a character that does not correspond to a valid
permission.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'static function parse(permissions: string)'
parameters:
- id: permissions
type: string
description: ''
return:
type: <xref uid="@azure/storage-file.FileSASPermissions" />
description: ''
- name: toString()
uid: '@azure/storage-file.FileSASPermissions.toString'
package: '@azure/storage-file'
summary: >-
Converts the given permissions to a string. Using this method will
guarantee the permissions are in an
order accepted by the service.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: function toString()
return:
type: string
description: A string which represents the FileSASPermissions