FileAppendOptions interface

Package:

@azure/storage-file-datalake

An interface for options common to every remote operation.

Extends

CommonOptions

Properties

abortSignal
conditions
customerProvidedKey	Customer Provided Key Info.
flush	If file should be flushed automatically after the append
leaseAction	Optional. If "acquire" it will acquire the lease. If "auto-renew" it will renew the lease. If "release" it will release the lease only on flush. If "acquire-release" it will acquire & complete the operation & release the lease once operation is done.
leaseDurationInSeconds	The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.
onProgress
proposedLeaseId	Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.
transactionalContentMD5

Inherited Properties

tracingOptions

Options to configure spans created when tracing is enabled.

Property Details

abortSignal

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

conditions

conditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

flush

If file should be flushed automatically after the append

flush?: boolean

Property Value

boolean

leaseAction

Optional. If "acquire" it will acquire the lease. If "auto-renew" it will renew the lease. If "release" it will release the lease only on flush. If "acquire-release" it will acquire & complete the operation & release the lease once operation is done.

leaseAction?: LeaseAction

Property Value

LeaseAction

leaseDurationInSeconds

The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.

leaseDurationInSeconds?: number

Property Value

number

onProgress

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

proposedLeaseId

Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.

proposedLeaseId?: string

Property Value

string

transactionalContentMD5

transactionalContentMD5?: Uint8Array

Property Value

Uint8Array

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions