FileGetPropertiesHeaders interface

Paket:

@azure/storage-file-share

Definierar rubriker för File_getProperties åtgärd.

Egenskaper

cacheControl	Om Cache-Control begärandehuvudet tidigare har angetts för filen returneras värdet Cache-Control i det här huvudet.
contentDisposition	Returnerar värdet som angavs för rubriken "x-ms-content-disposition" och anger hur svaret ska bearbetas.
contentEncoding	Om rubriken för innehållskodningsbegäran tidigare har angetts för filen returneras värdet Content-Encoding i det här huvudet.
contentLanguage	Returnerar det värde som angavs för innehållsspråkets begärandehuvud.
contentLength	Filens storlek i bitar. Det här huvudet returnerar värdet för rubriken "x-ms-content-length" som lagras med filen.
contentMD5	Om Content-MD5-huvudet har angetts för filen returneras innehålls-MD5-svarshuvudet så att klienten kan söka efter integritet för meddelandeinnehåll.
contentType	Den innehållstyp som angetts för filen. Standardinnehållstypen är "application/octet-stream"
copyCompletedOn	Sluttid för det senaste försöket att kopiera filåtgärden där den här filen var målfilen. Det här värdet kan ange tidpunkten för ett slutfört, avbrutet eller misslyckat kopieringsförsök.
copyId	Strängidentifierare för den senaste kopieringsfilåtgärden där den här filen var målfilen.
copyProgress	Innehåller antalet kopierade byte och det totala antalet byte i källan i den senaste kopieringsfilåtgärden där den här filen var målfilen. Kan visa mellan 0 och innehållslängdsbyte kopierade.
copySource	URL upp till 2 KB som anger den källfil som användes i den senaste kopieringsfilen där den här filen var målfilen.
copyStatus	Tillståndet för kopieringsåtgärden som identifieras av "x-ms-copy-id".
copyStatusDescription	Visas bara när x-ms-copy-status misslyckas eller väntar. Beskriver orsaken till allvarliga eller icke-dödliga kopieringsåtgärder.
date	Ett UTC-datum/tid-värde som genererats av tjänsten som anger tidpunkten då svaret initierades.
errorCode	Felkod
etag	ETag innehåller ett värde som du kan använda för att utföra åtgärder villkorligt, inom citattecken.
fileAttributes	Attribut som angetts för filen.
fileChangeOn	Ändra tid för filen.
fileCreatedOn	Skapandetid för filen.
fileId	Filens fileId.
fileLastWriteOn	Senaste skrivtid för filen.
fileParentId	Filens överordnade fileId.
filePermissionKey	Nyckeln för behörighetsuppsättningen för filen.
fileType	Returnerar typen Fil. Reserverad för framtida användning.
isServerEncrypted	Värdet för det här huvudet är inställt på sant om fildata och programmetadata är helt krypterade med den angivna algoritmen. Annars anges värdet till falskt (när filen är okrypterad eller om endast delar av filen/programmetadata krypteras).
lastModified	Returnerar datum och tid då filen senast ändrades. Datumformatet följer RFC 1123. Alla åtgärder som ändrar filen eller dess egenskaper uppdaterar den senaste ändringstiden.
leaseDuration	När en fil hyrs anger om lånet är av oändlig eller fast varaktighet.
leaseState	Lånetillstånd för filen.
leaseStatus	Aktuell lånestatus för filen.
metadata	En uppsättning namn/värde-par som är associerade med den här filen som användardefinierade metadata.
requestId	Det här huvudet identifierar unikt den begäran som gjordes och kan användas för att felsöka begäran.
version	Anger vilken version av filtjänsten som används för att köra begäran.

Egenskapsinformation

cacheControl

Om Cache-Control begärandehuvudet tidigare har angetts för filen returneras värdet Cache-Control i det här huvudet.

cacheControl?: string

Egenskapsvärde

string

contentDisposition

Returnerar värdet som angavs för rubriken "x-ms-content-disposition" och anger hur svaret ska bearbetas.

contentDisposition?: string

Egenskapsvärde

string

contentEncoding

Om rubriken för innehållskodningsbegäran tidigare har angetts för filen returneras värdet Content-Encoding i det här huvudet.

contentEncoding?: string

Egenskapsvärde

string

contentLanguage

Returnerar det värde som angavs för innehållsspråkets begärandehuvud.

contentLanguage?: string

Egenskapsvärde

string

contentLength

Filens storlek i bitar. Det här huvudet returnerar värdet för rubriken "x-ms-content-length" som lagras med filen.

contentLength?: number

Egenskapsvärde

number

contentMD5

Om Content-MD5-huvudet har angetts för filen returneras innehålls-MD5-svarshuvudet så att klienten kan söka efter integritet för meddelandeinnehåll.

contentMD5?: Uint8Array

Egenskapsvärde

Uint8Array

contentType

Den innehållstyp som angetts för filen. Standardinnehållstypen är "application/octet-stream"

contentType?: string

Egenskapsvärde

string

copyCompletedOn

Sluttid för det senaste försöket att kopiera filåtgärden där den här filen var målfilen. Det här värdet kan ange tidpunkten för ett slutfört, avbrutet eller misslyckat kopieringsförsök.

copyCompletedOn?: Date

Egenskapsvärde

Date

copyId

Strängidentifierare för den senaste kopieringsfilåtgärden där den här filen var målfilen.

copyId?: string

Egenskapsvärde

string

copyProgress

Innehåller antalet kopierade byte och det totala antalet byte i källan i den senaste kopieringsfilåtgärden där den här filen var målfilen. Kan visa mellan 0 och innehållslängdsbyte kopierade.

copyProgress?: string

Egenskapsvärde

string

copySource

URL upp till 2 KB som anger den källfil som användes i den senaste kopieringsfilen där den här filen var målfilen.

copySource?: string

Egenskapsvärde

string

copyStatus

Tillståndet för kopieringsåtgärden som identifieras av "x-ms-copy-id".

copyStatus?: CopyStatusType

Egenskapsvärde

CopyStatusType

copyStatusDescription

Visas bara när x-ms-copy-status misslyckas eller väntar. Beskriver orsaken till allvarliga eller icke-dödliga kopieringsåtgärder.

copyStatusDescription?: string

Egenskapsvärde

string

date

Ett UTC-datum/tid-värde som genererats av tjänsten som anger tidpunkten då svaret initierades.

date?: Date

Egenskapsvärde

Date

errorCode

Felkod

errorCode?: string

Egenskapsvärde

string

etag

ETag innehåller ett värde som du kan använda för att utföra åtgärder villkorligt, inom citattecken.

etag?: string

Egenskapsvärde

string

fileAttributes

Attribut som angetts för filen.

fileAttributes?: string

Egenskapsvärde

string

fileChangeOn

Ändra tid för filen.

fileChangeOn?: Date

Egenskapsvärde

Date

fileCreatedOn

Skapandetid för filen.

fileCreatedOn?: Date

Egenskapsvärde

Date

fileId

Filens fileId.

fileId?: string

Egenskapsvärde

string

fileLastWriteOn

Senaste skrivtid för filen.

fileLastWriteOn?: Date

Egenskapsvärde

Date

fileParentId

Filens överordnade fileId.

fileParentId?: string

Egenskapsvärde

string

filePermissionKey

Nyckeln för behörighetsuppsättningen för filen.

filePermissionKey?: string

Egenskapsvärde

string

fileType

Returnerar typen Fil. Reserverad för framtida användning.

fileType?: string

Egenskapsvärde

string

isServerEncrypted

Värdet för det här huvudet är inställt på sant om fildata och programmetadata är helt krypterade med den angivna algoritmen. Annars anges värdet till falskt (när filen är okrypterad eller om endast delar av filen/programmetadata krypteras).

isServerEncrypted?: boolean

Egenskapsvärde

boolean

lastModified

Returnerar datum och tid då filen senast ändrades. Datumformatet följer RFC 1123. Alla åtgärder som ändrar filen eller dess egenskaper uppdaterar den senaste ändringstiden.

lastModified?: Date

Egenskapsvärde

Date

leaseDuration

När en fil hyrs anger om lånet är av oändlig eller fast varaktighet.

leaseDuration?: LeaseDurationType

Egenskapsvärde

LeaseDurationType

leaseState

Lånetillstånd för filen.

leaseState?: LeaseStateType

Egenskapsvärde

LeaseStateType

leaseStatus

Aktuell lånestatus för filen.

leaseStatus?: LeaseStatusType

Egenskapsvärde

LeaseStatusType

metadata

En uppsättning namn/värde-par som är associerade med den här filen som användardefinierade metadata.

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

Egenskapsvärde

{[propertyName: string]: string}

requestId

Det här huvudet identifierar unikt den begäran som gjordes och kan användas för att felsöka begäran.

requestId?: string

Egenskapsvärde

string

version

Anger vilken version av filtjänsten som används för att köra begäran.

version?: string

Egenskapsvärde

string