DirectoryGetPropertiesHeaders interface

Package:

@azure/storage-file-share

Defines headers for Directory_getProperties operation.

Properties

date	A UTC date/time value generated by the service that indicates the time at which the response was initiated.
errorCode	Error Code
etag	The ETag contains a value that you can use to perform operations conditionally, in quotes.
fileAttributes	Attributes set for the directory.
fileChangeOn	Change time for the directory.
fileCreatedOn	Creation time for the directory.
fileId	The fileId of the directory.
fileLastWriteOn	Last write time for the directory.
fileParentId	The parent fileId of the directory.
filePermissionKey	Key of the permission set for the directory.
isServerEncrypted	The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false.
lastModified	Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory.
metadata	A set of name-value pairs that contain metadata for the directory.
requestId	This header uniquely identifies the request that was made and can be used for troubleshooting the request.
version	Indicates the version of the File service used to execute the request.

Property Details

date

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

date?: Date

Property Value

Date

errorCode

Error Code

errorCode?: string

Property Value

string

etag

The ETag contains a value that you can use to perform operations conditionally, in quotes.

etag?: string

Property Value

string

fileAttributes

Attributes set for the directory.

fileAttributes?: string

Property Value

string

fileChangeOn

Change time for the directory.

fileChangeOn?: Date

Property Value

Date

fileCreatedOn

Creation time for the directory.

fileCreatedOn?: Date

Property Value

Date

fileId

The fileId of the directory.

fileId?: string

Property Value

string

fileLastWriteOn

Last write time for the directory.

fileLastWriteOn?: Date

Property Value

Date

fileParentId

The parent fileId of the directory.

fileParentId?: string

Property Value

string

filePermissionKey

Key of the permission set for the directory.

filePermissionKey?: string

Property Value

string

isServerEncrypted

The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false.

isServerEncrypted?: boolean

Property Value

boolean

lastModified

Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory.

lastModified?: Date

Property Value

Date

metadata

A set of name-value pairs that contain metadata for the directory.

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

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 File service used to execute the request.

version?: string

Property Value

string