Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContainerAcquireLeaseOptionalParams

Package version

Optional Parameters.

Hierarchy

Indexable

[key: string]: any

Optional Parameters.

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

The signal which can be used to abort requests.

Optional customHeaders

customHeaders: undefined | object
property

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

Optional duration

duration: undefined | number

Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change.

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Additional parameters for the operation

Optional onDownloadProgress

onDownloadProgress: undefined | function

Callback which fires upon download progress.

Optional onUploadProgress

onUploadProgress: undefined | function

Callback which fires upon upload progress.

Optional proposedLeaseId

proposedLeaseId: undefined | string

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.

Optional requestId

requestId: undefined | string

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.

Optional spanOptions

spanOptions: SpanOptions

Options used to create a span when tracing is enabled.

Optional timeout

timeout: undefined | number

The number of milliseconds a request can take before automatically being terminated.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Generated using TypeDoc