-
Notifications
You must be signed in to change notification settings - Fork 181
/
BlobSASPermissions.yml
219 lines (210 loc) · 6.3 KB
/
BlobSASPermissions.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
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
### YamlMime:TSType
name: BlobSASPermissions
uid: '@azure/storage-blob.BlobSASPermissions'
package: '@azure/storage-blob'
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 blob. 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
[BlobSASSignatureValues](xref:@azure/storage-blob.BlobSASSignatureValues)
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: BlobSASPermissions
remarks: ''
isDeprecated: false
type: class
properties:
- name: add
uid: '@azure/storage-blob.BlobSASPermissions.add'
package: '@azure/storage-blob'
summary: Specifies Add access granted.
fullName: add
remarks: ''
isDeprecated: false
syntax:
content: 'add: boolean'
return:
description: ''
type: boolean
- name: create
uid: '@azure/storage-blob.BlobSASPermissions.create'
package: '@azure/storage-blob'
summary: Specifies Create access granted.
fullName: create
remarks: ''
isDeprecated: false
syntax:
content: 'create: boolean'
return:
description: ''
type: boolean
- name: delete
uid: '@azure/storage-blob.BlobSASPermissions.delete'
package: '@azure/storage-blob'
summary: Specifies Delete access granted.
fullName: delete
remarks: ''
isDeprecated: false
syntax:
content: 'delete: boolean'
return:
description: ''
type: boolean
- name: deleteVersion
uid: '@azure/storage-blob.BlobSASPermissions.deleteVersion'
package: '@azure/storage-blob'
summary: Specifies Delete version access granted.
fullName: deleteVersion
remarks: ''
isDeprecated: false
syntax:
content: 'deleteVersion: boolean'
return:
description: ''
type: boolean
- name: execute
uid: '@azure/storage-blob.BlobSASPermissions.execute'
package: '@azure/storage-blob'
summary: Specifies Execute access granted.
fullName: execute
remarks: ''
isDeprecated: false
syntax:
content: 'execute: boolean'
return:
description: ''
type: boolean
- name: move
uid: '@azure/storage-blob.BlobSASPermissions.move'
package: '@azure/storage-blob'
summary: Specifies Move access granted.
fullName: move
remarks: ''
isDeprecated: false
syntax:
content: 'move: boolean'
return:
description: ''
type: boolean
- name: permanentDelete
uid: '@azure/storage-blob.BlobSASPermissions.permanentDelete'
package: '@azure/storage-blob'
summary: Specifies that Permanent Delete is permitted.
fullName: permanentDelete
remarks: ''
isDeprecated: false
syntax:
content: 'permanentDelete: boolean'
return:
description: ''
type: boolean
- name: read
uid: '@azure/storage-blob.BlobSASPermissions.read'
package: '@azure/storage-blob'
summary: Specifies Read access granted.
fullName: read
remarks: ''
isDeprecated: false
syntax:
content: 'read: boolean'
return:
description: ''
type: boolean
- name: setImmutabilityPolicy
uid: '@azure/storage-blob.BlobSASPermissions.setImmutabilityPolicy'
package: '@azure/storage-blob'
summary: Specifies SetImmutabilityPolicy access granted.
fullName: setImmutabilityPolicy
remarks: ''
isDeprecated: false
syntax:
content: 'setImmutabilityPolicy: boolean'
return:
description: ''
type: boolean
- name: tag
uid: '@azure/storage-blob.BlobSASPermissions.tag'
package: '@azure/storage-blob'
summary: Specfies Tag access granted.
fullName: tag
remarks: ''
isDeprecated: false
syntax:
content: 'tag: boolean'
return:
description: ''
type: boolean
- name: write
uid: '@azure/storage-blob.BlobSASPermissions.write'
package: '@azure/storage-blob'
summary: Specifies Write access granted.
fullName: write
remarks: ''
isDeprecated: false
syntax:
content: 'write: boolean'
return:
description: ''
type: boolean
methods:
- name: from(BlobSASPermissionsLike)
uid: '@azure/storage-blob.BlobSASPermissions.from'
package: '@azure/storage-blob'
summary: >-
Creates a
[BlobSASPermissions](xref:@azure/storage-blob.BlobSASPermissions) from a
raw object which contains same keys as it
and boolean values for them.
remarks: ''
isDeprecated: false
syntax:
content: >-
static function from(permissionLike: BlobSASPermissionsLike):
BlobSASPermissions
parameters:
- id: permissionLike
type: <xref uid="@azure/storage-blob.BlobSASPermissionsLike" />
description: ''
return:
description: ''
type: <xref uid="@azure/storage-blob.BlobSASPermissions" />
- name: parse(string)
uid: '@azure/storage-blob.BlobSASPermissions.parse'
package: '@azure/storage-blob'
summary: >-
Creates a
[BlobSASPermissions](xref:@azure/storage-blob.BlobSASPermissions) 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: ''
isDeprecated: false
syntax:
content: 'static function parse(permissions: string): BlobSASPermissions'
parameters:
- id: permissions
type: string
description: ''
return:
description: ''
type: <xref uid="@azure/storage-blob.BlobSASPermissions" />
- name: toString()
uid: '@azure/storage-blob.BlobSASPermissions.toString'
package: '@azure/storage-blob'
summary: >-
Converts the given permissions to a string. Using this method will
guarantee the permissions are in an
order accepted by the service.
remarks: ''
isDeprecated: false
syntax:
content: 'function toString(): string'
return:
description: A string which represents the BlobSASPermissions
type: string