FileGetRangeListOptions interface

Package:

@azure/storage-file-share

Options to configure the getRangeList operation.

Extends

CommonOptions

Properties

abortSignal	An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
includeRenames	This header is allowed only when prevShareSnapshot parameter is set. Determines whether the changed ranges for a file that has been renamed or moved between the target snapshot (or the live file) and the previous snapshot should be listed. If the value is true, the valid changed ranges for the file will be returned. If the value is false, the operation will result in a failure with 409 (Conflict) response. The default value is false.
leaseAccessConditions	Lease access conditions.
range	Optional. Specifies the range of bytes over which to list ranges, inclusively.

Inherited Properties

tracingOptions

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

includeRenames

This header is allowed only when prevShareSnapshot parameter is set. Determines whether the changed ranges for a file that has been renamed or moved between the target snapshot (or the live file) and the previous snapshot should be listed. If the value is true, the valid changed ranges for the file will be returned. If the value is false, the operation will result in a failure with 409 (Conflict) response. The default value is false.

includeRenames?: boolean

Property Value

boolean

leaseAccessConditions

Lease access conditions.

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

range

Optional. Specifies the range of bytes over which to list ranges, inclusively.

range?: Range_2

Property Value

Range

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions