-
Notifications
You must be signed in to change notification settings - Fork 180
/
SASQueryParametersOptions.yml
280 lines (267 loc) · 8.74 KB
/
SASQueryParametersOptions.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
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
### YamlMime:TSType
name: SASQueryParametersOptions
uid: '@azure/storage-blob.SASQueryParametersOptions'
package: '@azure/storage-blob'
summary: >-
Options to construct
[SASQueryParameters](xref:@azure/storage-blob.SASQueryParameters).
fullName: SASQueryParametersOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: cacheControl
uid: '@azure/storage-blob.SASQueryParametersOptions.cacheControl'
package: '@azure/storage-blob'
summary: Value for cache-control header in Blob/File Service SAS.
fullName: cacheControl
remarks: ''
isDeprecated: false
syntax:
content: 'cacheControl?: string'
return:
description: ''
type: string
- name: contentDisposition
uid: '@azure/storage-blob.SASQueryParametersOptions.contentDisposition'
package: '@azure/storage-blob'
summary: Value for content-disposition header in Blob/File Service SAS.
fullName: contentDisposition
remarks: ''
isDeprecated: false
syntax:
content: 'contentDisposition?: string'
return:
description: ''
type: string
- name: contentEncoding
uid: '@azure/storage-blob.SASQueryParametersOptions.contentEncoding'
package: '@azure/storage-blob'
summary: Value for content-encoding header in Blob/File Service SAS.
fullName: contentEncoding
remarks: ''
isDeprecated: false
syntax:
content: 'contentEncoding?: string'
return:
description: ''
type: string
- name: contentLanguage
uid: '@azure/storage-blob.SASQueryParametersOptions.contentLanguage'
package: '@azure/storage-blob'
summary: Value for content-length header in Blob/File Service SAS.
fullName: contentLanguage
remarks: ''
isDeprecated: false
syntax:
content: 'contentLanguage?: string'
return:
description: ''
type: string
- name: contentType
uid: '@azure/storage-blob.SASQueryParametersOptions.contentType'
package: '@azure/storage-blob'
summary: Value for content-type header in Blob/File Service SAS.
fullName: contentType
remarks: ''
isDeprecated: false
syntax:
content: 'contentType?: string'
return:
description: ''
type: string
- name: correlationId
uid: '@azure/storage-blob.SASQueryParametersOptions.correlationId'
package: '@azure/storage-blob'
summary: >-
A GUID value that will be logged in the storage diagnostic logs and can be
used to correlate SAS generation with storage resource access.
This is only used for User Delegation SAS.
fullName: correlationId
remarks: ''
isDeprecated: false
syntax:
content: 'correlationId?: string'
return:
description: ''
type: string
- name: encryptionScope
uid: '@azure/storage-blob.SASQueryParametersOptions.encryptionScope'
package: '@azure/storage-blob'
summary: >-
Optional. Encryption scope to use when sending requests authorized with
this SAS URI.
fullName: encryptionScope
remarks: ''
isDeprecated: false
syntax:
content: 'encryptionScope?: string'
return:
description: ''
type: string
- name: expiresOn
uid: '@azure/storage-blob.SASQueryParametersOptions.expiresOn'
package: '@azure/storage-blob'
summary: >-
Optional only when identifier is provided. The expiry time for this SAS
token.
fullName: expiresOn
remarks: ''
isDeprecated: false
syntax:
content: 'expiresOn?: Date'
return:
description: ''
type: Date
- name: identifier
uid: '@azure/storage-blob.SASQueryParametersOptions.identifier'
package: '@azure/storage-blob'
summary: >-
Optional. The signed identifier (only for
[BlobSASSignatureValues](xref:@azure/storage-blob.BlobSASSignatureValues)).
See
https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
fullName: identifier
remarks: ''
isDeprecated: false
syntax:
content: 'identifier?: string'
return:
description: ''
type: string
- name: ipRange
uid: '@azure/storage-blob.SASQueryParametersOptions.ipRange'
package: '@azure/storage-blob'
summary: Optional. IP ranges allowed in this SAS.
fullName: ipRange
remarks: ''
isDeprecated: false
syntax:
content: 'ipRange?: SasIPRange'
return:
description: ''
type: <xref uid="@azure/storage-blob.SasIPRange" />
- name: permissions
uid: '@azure/storage-blob.SASQueryParametersOptions.permissions'
package: '@azure/storage-blob'
summary: >-
Optional only when identifier is provided.
Please refer to
[AccountSASPermissions](xref:@azure/storage-blob.AccountSASPermissions),
[BlobSASPermissions](xref:@azure/storage-blob.BlobSASPermissions), or
[ContainerSASPermissions](xref:@azure/storage-blob.ContainerSASPermissions)
for
more details.
fullName: permissions
remarks: ''
isDeprecated: false
syntax:
content: 'permissions?: string'
return:
description: ''
type: string
- name: preauthorizedAgentObjectId
uid: '@azure/storage-blob.SASQueryParametersOptions.preauthorizedAgentObjectId'
package: '@azure/storage-blob'
summary: >-
Authorized AAD Object ID in GUID format. The AAD Object ID of a user
authorized by the owner of the User Delegation Key
to perform the action granted by the SAS. The Azure Storage service will
ensure that the owner of the user delegation key
has the required permissions before granting access but no additional
permission check for the user specified in
this value will be performed. This cannot be used in conjuction with
<xref:signedUnauthorizedUserObjectId>.
This is only used for User Delegation SAS.
fullName: preauthorizedAgentObjectId
remarks: ''
isDeprecated: false
syntax:
content: 'preauthorizedAgentObjectId?: string'
return:
description: ''
type: string
- name: protocol
uid: '@azure/storage-blob.SASQueryParametersOptions.protocol'
package: '@azure/storage-blob'
summary: Optional. The allowed HTTP protocol(s).
fullName: protocol
remarks: ''
isDeprecated: false
syntax:
content: 'protocol?: SASProtocol'
return:
description: ''
type: <xref uid="@azure/storage-blob.SASProtocol" />
- name: resource
uid: '@azure/storage-blob.SASQueryParametersOptions.resource'
package: '@azure/storage-blob'
summary: >-
Optional. Specifies which resources are accessible via the SAS (only for
[BlobSASSignatureValues](xref:@azure/storage-blob.BlobSASSignatureValues)).
See
https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
fullName: resource
remarks: ''
isDeprecated: false
syntax:
content: 'resource?: string'
return:
description: ''
type: string
- name: resourceTypes
uid: '@azure/storage-blob.SASQueryParametersOptions.resourceTypes'
package: '@azure/storage-blob'
summary: >-
Optional. The storage resource types being accessed (only for Account
SAS). Please refer to
[AccountSASResourceTypes](xref:@azure/storage-blob.AccountSASResourceTypes)
for more details.
fullName: resourceTypes
remarks: ''
isDeprecated: false
syntax:
content: 'resourceTypes?: string'
return:
description: ''
type: string
- name: services
uid: '@azure/storage-blob.SASQueryParametersOptions.services'
package: '@azure/storage-blob'
summary: >-
Optional. The storage services being accessed (only for Account SAS).
Please refer to
[AccountSASServices](xref:@azure/storage-blob.AccountSASServices)
for more details.
fullName: services
remarks: ''
isDeprecated: false
syntax:
content: 'services?: string'
return:
description: ''
type: string
- name: startsOn
uid: '@azure/storage-blob.SASQueryParametersOptions.startsOn'
package: '@azure/storage-blob'
summary: Optional. The start time for this SAS token.
fullName: startsOn
remarks: ''
isDeprecated: false
syntax:
content: 'startsOn?: Date'
return:
description: ''
type: Date
- name: userDelegationKey
uid: '@azure/storage-blob.SASQueryParametersOptions.userDelegationKey'
package: '@azure/storage-blob'
summary: User delegation key properties.
fullName: userDelegationKey
remarks: ''
isDeprecated: false
syntax:
content: 'userDelegationKey?: UserDelegationKey'
return:
description: ''
type: <xref uid="@azure/storage-blob.UserDelegationKey" />