ContainerGetPropertiesOptionalParams interface

Package:

@azure/storage-blob

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
leaseAccessConditions	Additional parameters for the operation
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
requestId	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.
timeout	The number of milliseconds a request can take before automatically being terminated.
timeoutParameter	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

customHeaders

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

customHeaders?: undefined | [key: string]: string

Property Value

undefined | [key: string]: string

leaseAccessConditions

Additional parameters for the operation

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

requestId

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.

requestId?: undefined | string

Property Value

undefined | string

timeout

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

timeout?: undefined | number

Property Value

undefined | number

timeoutParameter

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

timeoutParameter?: undefined | number

Property Value

undefined | number