-
Notifications
You must be signed in to change notification settings - Fork 180
/
FileDownloadHeaders.yml
468 lines (468 loc) · 15 KB
/
FileDownloadHeaders.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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
### YamlMime:TSType
name: FileDownloadHeaders
uid: '@azure/storage-file-share.FileDownloadHeaders'
package: '@azure/storage-file-share'
summary: Defines headers for File_download operation.
fullName: FileDownloadHeaders
remarks: ''
isDeprecated: false
type: interface
properties:
- name: acceptRanges
uid: '@azure/storage-file-share.FileDownloadHeaders.acceptRanges'
package: '@azure/storage-file-share'
summary: Indicates that the service supports requests for partial file content.
fullName: acceptRanges
remarks: ''
isDeprecated: false
syntax:
content: 'acceptRanges?: string'
return:
description: ''
type: string
- name: cacheControl
uid: '@azure/storage-file-share.FileDownloadHeaders.cacheControl'
package: '@azure/storage-file-share'
summary: Returned if it was previously specified for the file.
fullName: cacheControl
remarks: ''
isDeprecated: false
syntax:
content: 'cacheControl?: string'
return:
description: ''
type: string
- name: contentDisposition
uid: '@azure/storage-file-share.FileDownloadHeaders.contentDisposition'
package: '@azure/storage-file-share'
summary: >-
Returns the value that was specified for the 'x-ms-content-disposition'
header and specifies how to process the response.
fullName: contentDisposition
remarks: ''
isDeprecated: false
syntax:
content: 'contentDisposition?: string'
return:
description: ''
type: string
- name: contentEncoding
uid: '@azure/storage-file-share.FileDownloadHeaders.contentEncoding'
package: '@azure/storage-file-share'
summary: >-
Returns the value that was specified for the Content-Encoding request
header.
fullName: contentEncoding
remarks: ''
isDeprecated: false
syntax:
content: 'contentEncoding?: string'
return:
description: ''
type: string
- name: contentLanguage
uid: '@azure/storage-file-share.FileDownloadHeaders.contentLanguage'
package: '@azure/storage-file-share'
summary: >-
Returns the value that was specified for the Content-Language request
header.
fullName: contentLanguage
remarks: ''
isDeprecated: false
syntax:
content: 'contentLanguage?: string'
return:
description: ''
type: string
- name: contentLength
uid: '@azure/storage-file-share.FileDownloadHeaders.contentLength'
package: '@azure/storage-file-share'
summary: The number of bytes present in the response body.
fullName: contentLength
remarks: ''
isDeprecated: false
syntax:
content: 'contentLength?: number'
return:
description: ''
type: number
- name: contentMD5
uid: '@azure/storage-file-share.FileDownloadHeaders.contentMD5'
package: '@azure/storage-file-share'
summary: >-
If the file has an MD5 hash and the request is to read the full file, this
response header is returned so that the client can check for message
content integrity. If the request is to read a specified range and the
'x-ms-range-get-content-md5' is set to true, then the request returns an
MD5 hash for the range, as long as the range size is less than or equal to
4 MB. If neither of these sets of conditions is true, then no value is
returned for the 'Content-MD5' header.
fullName: contentMD5
remarks: ''
isDeprecated: false
syntax:
content: 'contentMD5?: Uint8Array'
return:
description: ''
type: Uint8Array
- name: contentRange
uid: '@azure/storage-file-share.FileDownloadHeaders.contentRange'
package: '@azure/storage-file-share'
summary: >-
Indicates the range of bytes returned if the client requested a subset of
the file by setting the Range request header.
fullName: contentRange
remarks: ''
isDeprecated: false
syntax:
content: 'contentRange?: string'
return:
description: ''
type: string
- name: contentType
uid: '@azure/storage-file-share.FileDownloadHeaders.contentType'
package: '@azure/storage-file-share'
summary: >-
The content type specified for the file. The default content type is
'application/octet-stream'
fullName: contentType
remarks: ''
isDeprecated: false
syntax:
content: 'contentType?: string'
return:
description: ''
type: string
- name: copyCompletedOn
uid: '@azure/storage-file-share.FileDownloadHeaders.copyCompletedOn'
package: '@azure/storage-file-share'
summary: >-
Conclusion time of the last attempted Copy File operation where this file
was the destination file. This value can specify the time of a completed,
aborted, or failed copy attempt.
fullName: copyCompletedOn
remarks: ''
isDeprecated: false
syntax:
content: 'copyCompletedOn?: Date'
return:
description: ''
type: Date
- name: copyId
uid: '@azure/storage-file-share.FileDownloadHeaders.copyId'
package: '@azure/storage-file-share'
summary: >-
String identifier for the last attempted Copy File operation where this
file was the destination file.
fullName: copyId
remarks: ''
isDeprecated: false
syntax:
content: 'copyId?: string'
return:
description: ''
type: string
- name: copyProgress
uid: '@azure/storage-file-share.FileDownloadHeaders.copyProgress'
package: '@azure/storage-file-share'
summary: >-
Contains the number of bytes copied and the total bytes in the source in
the last attempted Copy File operation where this file was the destination
file. Can show between 0 and Content-Length bytes copied.
fullName: copyProgress
remarks: ''
isDeprecated: false
syntax:
content: 'copyProgress?: string'
return:
description: ''
type: string
- name: copySource
uid: '@azure/storage-file-share.FileDownloadHeaders.copySource'
package: '@azure/storage-file-share'
summary: >-
URL up to 2KB in length that specifies the source file used in the last
attempted Copy File operation where this file was the destination file.
fullName: copySource
remarks: ''
isDeprecated: false
syntax:
content: 'copySource?: string'
return:
description: ''
type: string
- name: copyStatus
uid: '@azure/storage-file-share.FileDownloadHeaders.copyStatus'
package: '@azure/storage-file-share'
summary: State of the copy operation identified by 'x-ms-copy-id'.
fullName: copyStatus
remarks: ''
isDeprecated: false
syntax:
content: 'copyStatus?: CopyStatusType'
return:
description: ''
type: <xref uid="@azure/storage-file-share.CopyStatusType" />
- name: copyStatusDescription
uid: '@azure/storage-file-share.FileDownloadHeaders.copyStatusDescription'
package: '@azure/storage-file-share'
summary: >-
Only appears when x-ms-copy-status is failed or pending. Describes cause
of fatal or non-fatal copy operation failure.
fullName: copyStatusDescription
remarks: ''
isDeprecated: false
syntax:
content: 'copyStatusDescription?: string'
return:
description: ''
type: string
- name: date
uid: '@azure/storage-file-share.FileDownloadHeaders.date'
package: '@azure/storage-file-share'
summary: >-
A UTC date/time value generated by the service that indicates the time at
which the response was initiated.
fullName: date
remarks: ''
isDeprecated: false
syntax:
content: 'date?: Date'
return:
description: ''
type: Date
- name: errorCode
uid: '@azure/storage-file-share.FileDownloadHeaders.errorCode'
package: '@azure/storage-file-share'
summary: Error Code
fullName: errorCode
remarks: ''
isDeprecated: false
syntax:
content: 'errorCode?: string'
return:
description: ''
type: string
- name: etag
uid: '@azure/storage-file-share.FileDownloadHeaders.etag'
package: '@azure/storage-file-share'
summary: >-
The ETag contains a value that you can use to perform operations
conditionally, in quotes.
fullName: etag
remarks: ''
isDeprecated: false
syntax:
content: 'etag?: string'
return:
description: ''
type: string
- name: fileAttributes
uid: '@azure/storage-file-share.FileDownloadHeaders.fileAttributes'
package: '@azure/storage-file-share'
summary: Attributes set for the file.
fullName: fileAttributes
remarks: ''
isDeprecated: false
syntax:
content: 'fileAttributes?: string'
return:
description: ''
type: string
- name: fileChangeOn
uid: '@azure/storage-file-share.FileDownloadHeaders.fileChangeOn'
package: '@azure/storage-file-share'
summary: Change time for the file.
fullName: fileChangeOn
remarks: ''
isDeprecated: false
syntax:
content: 'fileChangeOn?: Date'
return:
description: ''
type: Date
- name: fileContentMD5
uid: '@azure/storage-file-share.FileDownloadHeaders.fileContentMD5'
package: '@azure/storage-file-share'
summary: >-
If the file has a MD5 hash, and if request contains range header (Range or
x-ms-range), this response header is returned with the value of the whole
file's MD5 value. This value may or may not be equal to the value returned
in Content-MD5 header, with the latter calculated from the requested
range.
fullName: fileContentMD5
remarks: ''
isDeprecated: false
syntax:
content: 'fileContentMD5?: Uint8Array'
return:
description: ''
type: Uint8Array
- name: fileCreatedOn
uid: '@azure/storage-file-share.FileDownloadHeaders.fileCreatedOn'
package: '@azure/storage-file-share'
summary: Creation time for the file.
fullName: fileCreatedOn
remarks: ''
isDeprecated: false
syntax:
content: 'fileCreatedOn?: Date'
return:
description: ''
type: Date
- name: fileId
uid: '@azure/storage-file-share.FileDownloadHeaders.fileId'
package: '@azure/storage-file-share'
summary: The fileId of the file.
fullName: fileId
remarks: ''
isDeprecated: false
syntax:
content: 'fileId?: string'
return:
description: ''
type: string
- name: fileLastWriteOn
uid: '@azure/storage-file-share.FileDownloadHeaders.fileLastWriteOn'
package: '@azure/storage-file-share'
summary: Last write time for the file.
fullName: fileLastWriteOn
remarks: ''
isDeprecated: false
syntax:
content: 'fileLastWriteOn?: Date'
return:
description: ''
type: Date
- name: fileParentId
uid: '@azure/storage-file-share.FileDownloadHeaders.fileParentId'
package: '@azure/storage-file-share'
summary: The parent fileId of the file.
fullName: fileParentId
remarks: ''
isDeprecated: false
syntax:
content: 'fileParentId?: string'
return:
description: ''
type: string
- name: filePermissionKey
uid: '@azure/storage-file-share.FileDownloadHeaders.filePermissionKey'
package: '@azure/storage-file-share'
summary: Key of the permission set for the file.
fullName: filePermissionKey
remarks: ''
isDeprecated: false
syntax:
content: 'filePermissionKey?: string'
return:
description: ''
type: string
- name: isServerEncrypted
uid: '@azure/storage-file-share.FileDownloadHeaders.isServerEncrypted'
package: '@azure/storage-file-share'
summary: >-
The value of this header is set to true if the file data and application
metadata are completely encrypted using the specified algorithm.
Otherwise, the value is set to false (when the file is unencrypted, or if
only parts of the file/application metadata are encrypted).
fullName: isServerEncrypted
remarks: ''
isDeprecated: false
syntax:
content: 'isServerEncrypted?: boolean'
return:
description: ''
type: boolean
- name: lastModified
uid: '@azure/storage-file-share.FileDownloadHeaders.lastModified'
package: '@azure/storage-file-share'
summary: >-
Returns the date and time the file was last modified. Any operation that
modifies the file or its properties updates the last modified time.
fullName: lastModified
remarks: ''
isDeprecated: false
syntax:
content: 'lastModified?: Date'
return:
description: ''
type: Date
- name: leaseDuration
uid: '@azure/storage-file-share.FileDownloadHeaders.leaseDuration'
package: '@azure/storage-file-share'
summary: >-
When a file is leased, specifies whether the lease is of infinite or fixed
duration.
fullName: leaseDuration
remarks: ''
isDeprecated: false
syntax:
content: 'leaseDuration?: LeaseDurationType'
return:
description: ''
type: <xref uid="@azure/storage-file-share.LeaseDurationType" />
- name: leaseState
uid: '@azure/storage-file-share.FileDownloadHeaders.leaseState'
package: '@azure/storage-file-share'
summary: Lease state of the file.
fullName: leaseState
remarks: ''
isDeprecated: false
syntax:
content: 'leaseState?: LeaseStateType'
return:
description: ''
type: <xref uid="@azure/storage-file-share.LeaseStateType" />
- name: leaseStatus
uid: '@azure/storage-file-share.FileDownloadHeaders.leaseStatus'
package: '@azure/storage-file-share'
summary: The current lease status of the file.
fullName: leaseStatus
remarks: ''
isDeprecated: false
syntax:
content: 'leaseStatus?: LeaseStatusType'
return:
description: ''
type: <xref uid="@azure/storage-file-share.LeaseStatusType" />
- name: metadata
uid: '@azure/storage-file-share.FileDownloadHeaders.metadata'
package: '@azure/storage-file-share'
summary: >-
A set of name-value pairs associated with this file as user-defined
metadata.
fullName: metadata
remarks: ''
isDeprecated: false
syntax:
content: 'metadata?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
- name: requestId
uid: '@azure/storage-file-share.FileDownloadHeaders.requestId'
package: '@azure/storage-file-share'
summary: >-
This header uniquely identifies the request that was made and can be used
for troubleshooting the request.
fullName: requestId
remarks: ''
isDeprecated: false
syntax:
content: 'requestId?: string'
return:
description: ''
type: string
- name: version
uid: '@azure/storage-file-share.FileDownloadHeaders.version'
package: '@azure/storage-file-share'
summary: Indicates the version of the File service used to execute the request.
fullName: version
remarks: ''
isDeprecated: false
syntax:
content: 'version?: string'
return:
description: ''
type: string