BlobDownloadOptionalParams interface
Optional parameters.
- Extends
| cpk |
Parameter group |
| lease |
Parameter group |
| modified |
Parameter group |
| range | Return only the bytes of the blob in the specified range. |
| range |
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. |
| range |
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. |
| request |
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. |
| snapshot | 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 Creating a Snapshot of a Blob. |
| timeout |
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations. |
| version |
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. |
| abort |
The signal which can be used to abort requests. |
| on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
| request |
Options used when creating and sending HTTP requests for this operation. |
| serializer |
Options to override serialization/de-serialization behavior. |
| tracing |
Options used when tracing is enabled. |
Parameter group
leaseAccessConditions?: LeaseAccessConditionsProperty Value
Parameter group
modifiedAccessConditions?: ModifiedAccessConditionsModelProperty Value
Return only the bytes of the blob in the specified range.
range?: stringProperty Value
string
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.
rangeGetContentCRC64?: booleanProperty Value
boolean
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.
rangeGetContentMD5?: booleanProperty Value
boolean
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.
requestId?: stringProperty Value
string
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 Creating a Snapshot of a Blob.
snapshot?: stringProperty Value
string
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
timeoutInSeconds?: numberProperty Value
number
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.
versionId?: stringProperty Value
string
The signal which can be used to abort requests.
abortSignal?: AbortSignalLikeProperty Value
Inherited From coreClient.OperationOptions.abortSignal
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallbackProperty Value
Inherited From coreClient.OperationOptions.onResponse
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptionsProperty Value
Inherited From coreClient.OperationOptions.requestOptions
Options to override serialization/de-serialization behavior.
serializerOptions?: SerializerOptionsProperty Value
Inherited From coreClient.OperationOptions.serializerOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
Inherited From coreClient.OperationOptions.tracingOptions