/
BlobDownloadOptionalParams.yml
202 lines (202 loc) · 6.55 KB
/
BlobDownloadOptionalParams.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
### YamlMime:TSType
name: BlobDownloadOptionalParams
uid: '@azure/storage-blob.BlobDownloadOptionalParams'
package: '@azure/storage-blob'
summary: Optional parameters.
fullName: BlobDownloadOptionalParams
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: abortSignal
uid: '@azure/storage-blob.BlobDownloadOptionalParams.abortSignal'
package: '@azure/storage-blob'
summary: The signal which can be used to abort requests.
fullName: abortSignal
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
type: AbortSignalLike
description: ''
- name: cpkInfo
uid: '@azure/storage-blob.BlobDownloadOptionalParams.cpkInfo'
package: '@azure/storage-blob'
summary: Parameter group
fullName: cpkInfo
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'cpkInfo?: CpkInfo'
return:
type: <xref uid="@azure/storage-blob.CpkInfo" />
description: ''
- name: leaseAccessConditions
uid: '@azure/storage-blob.BlobDownloadOptionalParams.leaseAccessConditions'
package: '@azure/storage-blob'
summary: Parameter group
fullName: leaseAccessConditions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'leaseAccessConditions?: LeaseAccessConditions'
return:
type: <xref uid="@azure/storage-blob.LeaseAccessConditions" />
description: ''
- name: modifiedAccessConditions
uid: '@azure/storage-blob.BlobDownloadOptionalParams.modifiedAccessConditions'
package: '@azure/storage-blob'
summary: Parameter group
fullName: modifiedAccessConditions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'modifiedAccessConditions?: ModifiedAccessConditionsModel'
return:
type: <xref uid="@azure/storage-blob.ModifiedAccessConditionsModel" />
description: ''
- name: range
uid: '@azure/storage-blob.BlobDownloadOptionalParams.range'
package: '@azure/storage-blob'
summary: Return only the bytes of the blob in the specified range.
fullName: range
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'range?: string'
return:
type: string
description: ''
- name: rangeGetContentCRC64
uid: '@azure/storage-blob.BlobDownloadOptionalParams.rangeGetContentCRC64'
package: '@azure/storage-blob'
summary: >-
When set to true and specified together with the Range, the service
returns the CRC64 hash for the range, as long as the range is less than or
equal to 4 MB in size.
fullName: rangeGetContentCRC64
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'rangeGetContentCRC64?: boolean'
return:
type: boolean
description: ''
- name: rangeGetContentMD5
uid: '@azure/storage-blob.BlobDownloadOptionalParams.rangeGetContentMD5'
package: '@azure/storage-blob'
summary: >-
When set to true and specified together with the Range, the service
returns the MD5 hash for the range, as long as the range is less than or
equal to 4 MB in size.
fullName: rangeGetContentMD5
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'rangeGetContentMD5?: boolean'
return:
type: boolean
description: ''
- name: requestId
uid: '@azure/storage-blob.BlobDownloadOptionalParams.requestId'
package: '@azure/storage-blob'
summary: >-
Provides a client-generated, opaque value with a 1 KB character limit that
is recorded in the analytics logs when storage analytics logging is
enabled.
fullName: requestId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'requestId?: string'
return:
type: string
description: ''
- name: requestOptions
uid: '@azure/storage-blob.BlobDownloadOptionalParams.requestOptions'
package: '@azure/storage-blob'
summary: Options used when creating and sending HTTP requests for this operation.
fullName: requestOptions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'requestOptions?: OperationRequestOptions'
return:
type: OperationRequestOptions
description: ''
- name: snapshot
uid: '@azure/storage-blob.BlobDownloadOptionalParams.snapshot'
package: '@azure/storage-blob'
summary: >-
The snapshot parameter is an opaque DateTime value that, when present,
specifies the blob snapshot to retrieve. For more information on working
with blob snapshots, see <a
href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating
a Snapshot of a Blob.</a>
fullName: snapshot
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'snapshot?: string'
return:
type: string
description: ''
- name: timeoutInSeconds
uid: '@azure/storage-blob.BlobDownloadOptionalParams.timeoutInSeconds'
package: '@azure/storage-blob'
summary: >-
The timeout parameter is expressed in seconds. For more information, see
<a
href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting
Timeouts for Blob Service Operations.</a>
fullName: timeoutInSeconds
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'timeoutInSeconds?: number'
return:
type: number
description: ''
- name: tracingOptions
uid: '@azure/storage-blob.BlobDownloadOptionalParams.tracingOptions'
package: '@azure/storage-blob'
summary: Options used when tracing is enabled.
fullName: tracingOptions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
type: OperationTracingOptions
description: ''
- name: versionId
uid: '@azure/storage-blob.BlobDownloadOptionalParams.versionId'
package: '@azure/storage-blob'
summary: >-
The version id parameter is an opaque DateTime value that, when present,
specifies the version of the blob to operate on. It's for service version
2019-10-10 and newer.
fullName: versionId
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'versionId?: string'
return:
type: string
description: ''
extends: OperationOptions