FileGetPropertiesHeaders interface
Defines headers for File_getProperties operation.
Properties
cache |
If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header. |
content |
Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. |
content |
If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header. |
content |
Returns the value that was specified for the Content-Language request header. |
content |
The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file. |
contentMD5 | If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity. |
content |
The content type specified for the file. The default content type is 'application/octet-stream' |
copy |
Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. |
copy |
String identifier for the last attempted Copy File operation where this file was the destination file. |
copy |
Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied. |
copy |
URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file. |
copy |
State of the copy operation identified by 'x-ms-copy-id'. |
copy |
Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. |
date | A UTC date/time value generated by the service that indicates the time at which the response was initiated. |
error |
Error Code |
etag | The ETag contains a value that you can use to perform operations conditionally, in quotes. |
file |
Attributes set for the file. |
file |
Change time for the file. |
file |
Creation time for the file. |
file |
The fileId of the file. |
file |
Last write time for the file. |
file |
The parent fileId of the file. |
file |
Key of the permission set for the file. |
file |
Returns the type File. Reserved for future use. |
is |
The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted). |
last |
Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time. |
lease |
When a file is leased, specifies whether the lease is of infinite or fixed duration. |
lease |
Lease state of the file. |
lease |
The current lease status of the file. |
metadata | A set of name-value pairs associated with this file as user-defined metadata. |
request |
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
cacheControl
If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header.
cacheControl?: string
Property Value
string
contentDisposition
Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response.
contentDisposition?: string
Property Value
string
contentEncoding
If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header.
contentEncoding?: string
Property Value
string
contentLanguage
Returns the value that was specified for the Content-Language request header.
contentLanguage?: string
Property Value
string
contentLength
The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file.
contentLength?: number
Property Value
number
contentMD5
If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity.
contentMD5?: Uint8Array
Property Value
Uint8Array
contentType
The content type specified for the file. The default content type is 'application/octet-stream'
contentType?: string
Property Value
string
copyCompletedOn
Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt.
copyCompletedOn?: Date
Property Value
Date
copyId
String identifier for the last attempted Copy File operation where this file was the destination file.
copyId?: string
Property Value
string
copyProgress
Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied.
copyProgress?: string
Property Value
string
copySource
URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file.
copySource?: string
Property Value
string
copyStatus
State of the copy operation identified by 'x-ms-copy-id'.
copyStatus?: CopyStatusType
Property Value
copyStatusDescription
Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.
copyStatusDescription?: string
Property Value
string
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 file.
fileAttributes?: string
Property Value
string
fileChangeOn
Change time for the file.
fileChangeOn?: Date
Property Value
Date
fileCreatedOn
Creation time for the file.
fileCreatedOn?: Date
Property Value
Date
fileId
The fileId of the file.
fileId?: string
Property Value
string
fileLastWriteOn
Last write time for the file.
fileLastWriteOn?: Date
Property Value
Date
fileParentId
The parent fileId of the file.
fileParentId?: string
Property Value
string
filePermissionKey
Key of the permission set for the file.
filePermissionKey?: string
Property Value
string
fileType
Returns the type File. Reserved for future use.
fileType?: string
Property Value
string
isServerEncrypted
The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted).
isServerEncrypted?: boolean
Property Value
boolean
lastModified
Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time.
lastModified?: Date
Property Value
Date
leaseDuration
When a file is leased, specifies whether the lease is of infinite or fixed duration.
leaseDuration?: LeaseDurationType
Property Value
leaseState
leaseStatus
metadata
A set of name-value pairs associated with this file as user-defined metadata.
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