FileDownloadOptionalParams interface

Package:

@azure/storage-file-share

Optional parameters.

Extends

OperationOptions

Properties

allowTrailingDot	If true, the trailing dot will not be trimmed from the target URI.
fileRequestIntent	Valid value is backup
leaseAccessConditions	Parameter group
range	Return file data only from the specified byte range.
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.
timeoutInSeconds	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	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

Parameter group

leaseAccessConditions?: LeaseAccessConditions

Property Value

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

AbortSignalLike

Inherited From coreClient.OperationOptions.abortSignal

onResponse

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?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From coreClient.OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From coreClient.OperationOptions.tracingOptions