ShareGetPropertiesOptionalParams interface

Package:

@azure/storage-file

Optional Parameters.

Extends

RequestOptionsBase

Properties

sharesnapshot	The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
timeoutParameter	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.
customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

sharesnapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.

sharesnapshot?: string

Property Value

string

timeoutParameter

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

timeoutParameter?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

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

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout