FileDownloadOptionalParams interface
Optional parameters.
- Extends
Properties
allow |
If true, the trailing dot will not be trimmed from the target URI. |
file |
Valid value is backup |
lease |
Parameter group |
range | Return file data only from the specified byte range. |
range |
When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. |
timeout |
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
request |
Options used when creating and sending HTTP requests for this operation. |
tracing |
Options used when tracing is enabled. |
Property Details
allowTrailingDot
If true, the trailing dot will not be trimmed from the target URI.
allowTrailingDot?: boolean
Property Value
boolean
fileRequestIntent
Valid value is backup
fileRequestIntent?: string
Property Value
string
leaseAccessConditions
range
Return file data only from the specified byte range.
range?: string
Property Value
string
rangeGetContentMD5
When this header is set to true and specified together with the Range header, 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?: boolean
Property Value
boolean
timeoutInSeconds
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.
timeoutInSeconds?: number
Property Value
number
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From coreHttp.OperationOptions.abortSignal
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From coreHttp.OperationOptions.requestOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From coreHttp.OperationOptions.tracingOptions