LeaseOperationResponseHeaders interface

Package:

@azure/storage-file-share

The details of the response for a specific lease operation.

Properties

date	UTC date/time value generated by the service that indicates the time at which the response was initiated
errorCode
etag	The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.
lastModified	Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file.
leaseId	Uniquely identifies a file's lease, won't be set when returned by releaseLease.
leaseTimeInSeconds	Approximate time remaining in the lease period, in seconds. Only availabe for breakLease for share lease.
requestId	This header uniquely identifies the request that was made and can be used for troubleshooting the request.
version	Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Property Details

date

UTC date/time value generated by the service that indicates the time at which the response was initiated

date?: Date

Property Value

Date

errorCode

errorCode?: string

Property Value

string

etag

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

etag?: string

Property Value

string

lastModified

Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file.

lastModified?: Date

Property Value

Date

leaseId

Uniquely identifies a file's lease, won't be set when returned by releaseLease.

leaseId?: string

Property Value

string

leaseTimeInSeconds

Approximate time remaining in the lease period, in seconds. Only availabe for breakLease for share lease.

leaseTimeInSeconds?: number

Property Value

number

requestId

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

requestId?: string

Property Value

string

version

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

version?: string

Property Value

string