FileGetPropertiesHeaders interface

Paket:

@azure/storage-file-share

Definiert Header für File_getProperties Vorgang.

Eigenschaften

cacheControl	Wenn der Cache-Control-Anforderungsheader zuvor für die Datei festgelegt wurde, wird der Cache-Control Wert in diesem Header zurückgegeben.
contentDisposition	Gibt den Wert zurück, der für den Header "x-ms-content-disposition" angegeben wurde, und gibt an, wie die Antwort verarbeitet werden soll.
contentEncoding	Wenn der Content-Encoding-Anforderungsheader zuvor für die Datei festgelegt wurde, wird der Content-Encoding-Wert in diesem Header zurückgegeben.
contentLanguage	Gibt den Wert zurück, der für den Content-Language-Anforderungsheader angegeben wurde.
contentLength	Dies ist die Größe der Datei in Byte. Dieser Header gibt den Wert des Headers "x-ms-content-length" zurück, der mit der Datei gespeichert wird.
contentMD5	Wenn der Content-MD5-Header für die Datei festgelegt wurde, wird der Content-MD5-Antwortheader zurückgegeben, damit der Client die Integrität des Nachrichteninhalts überprüfen kann.
contentType	Der für die Datei angegebene Inhaltstyp. Der Standardinhaltstyp ist "application/octet-stream".
copyCompletedOn	Abschlusszeit des letzten versuchten Kopierdateivorgangs, bei dem diese Datei die Zieldatei war. Dieser Wert kann die Zeit eines abgeschlossenen, abgebrochenen oder fehlgeschlagenen Kopierversuchs angeben.
copyId	Zeichenfolgenbezeichner für den letzten versuchten Kopierdateivorgang, bei dem diese Datei die Zieldatei war.
copyProgress	Enthält die Anzahl der kopierten Bytes und die Gesamtbytes in der Quelle im letzten versuchten Kopierdateivorgang, bei dem diese Datei die Zieldatei war. Kann zwischen 0 und Kopierte Bytes mit Inhaltslänge anzeigen.
copySource	URL mit einer Länge von bis zu 2 KB, die die Quelldatei angibt, die beim letzten versuchten Kopiervorgang verwendet wurde, bei dem diese Datei die Zieldatei war.
copyStatus	Status des Kopiervorgangs, der durch "x-ms-copy-id" identifiziert wird.
copyStatusDescription	Wird nur angezeigt, wenn x-ms-copy-status fehlgeschlagen oder ausstehend ist. Beschreibt die Ursache eines schwerwiegenden oder nicht schwerwiegenden Fehlers beim Kopiervorgang.
date	Ein vom Dienst generierter Datums-/Uhrzeitwert in UTC, der angibt, wann die Antwort initiiert wurde.
errorCode	Fehlercode
etag	Das ETag enthält einen Wert, den Sie zum bedingten Ausführen von Vorgängen in Anführungszeichen verwenden können.
fileAttributes	Attribute, die für die Datei festgelegt sind.
fileChangeOn	Ändern der Zeit für die Datei.
fileCreatedOn	Erstellungszeit für die Datei.
fileId	Die fileId der Datei.
fileLastWriteOn	Zeitpunkt des letzten Schreibvorgangs für die Datei.
fileParentId	Die übergeordnete FileId der Datei.
filePermissionKey	Schlüssel des Berechtigungssatzes für die Datei.
fileType	Gibt den Typ File zurück. Für die zukünftige Verwendung reserviert.
isServerEncrypted	Der Wert dieses Headers wird auf true festgelegt, wenn die Dateidaten und Anwendungsmetadaten vollständig mit dem angegebenen Algorithmus verschlüsselt werden. Andernfalls wird der Wert auf false festgelegt (wenn die Datei unverschlüsselt ist oder nur Teile der Datei-/Anwendungsmetadaten verschlüsselt sind).
lastModified	Gibt das Datum und die Uhrzeit der letzten Änderung der Datei zurück. Das Datumsformat entspricht RFC 1123. Jeder Vorgang, der die Datei oder deren Eigenschaften ändert, aktualisiert den Zeitpunkt der letzten Änderung.
leaseDuration	Wenn eine Datei geleast wird, gibt an, ob die Lease eine unbegrenzte oder eine feste Dauer hat.
leaseState	Leasestatus der Datei.
leaseStatus	Der aktuelle Leasestatus der Datei.
metadata	Ein Satz von Name-Wert-Paaren, die dieser Datei als benutzerdefinierte Metadaten zugeordnet sind.
requestId	Dieser Header identifiziert die erfolgte Anforderung eindeutig und kann für die Problembehandlung der Anforderung verwendet werden.
version	Gibt die Version des Dateidiensts an, der zum Ausführen der Abfrage verwendet wird.

Details zur Eigenschaft

cacheControl

Wenn der Cache-Control-Anforderungsheader zuvor für die Datei festgelegt wurde, wird der Cache-Control Wert in diesem Header zurückgegeben.

cacheControl?: string

Eigenschaftswert

string

contentDisposition

Gibt den Wert zurück, der für den Header "x-ms-content-disposition" angegeben wurde, und gibt an, wie die Antwort verarbeitet werden soll.

contentDisposition?: string

Eigenschaftswert

string

contentEncoding

Wenn der Content-Encoding-Anforderungsheader zuvor für die Datei festgelegt wurde, wird der Content-Encoding-Wert in diesem Header zurückgegeben.

contentEncoding?: string

Eigenschaftswert

string

contentLanguage

Gibt den Wert zurück, der für den Content-Language-Anforderungsheader angegeben wurde.

contentLanguage?: string

Eigenschaftswert

string

contentLength

Dies ist die Größe der Datei in Byte. Dieser Header gibt den Wert des Headers "x-ms-content-length" zurück, der mit der Datei gespeichert wird.

contentLength?: number

Eigenschaftswert

number

contentMD5

Wenn der Content-MD5-Header für die Datei festgelegt wurde, wird der Content-MD5-Antwortheader zurückgegeben, damit der Client die Integrität des Nachrichteninhalts überprüfen kann.

contentMD5?: Uint8Array

Eigenschaftswert

Uint8Array

contentType

Der für die Datei angegebene Inhaltstyp. Der Standardinhaltstyp ist "application/octet-stream".

contentType?: string

Eigenschaftswert

string

copyCompletedOn

Abschlusszeit des letzten versuchten Kopierdateivorgangs, bei dem diese Datei die Zieldatei war. Dieser Wert kann die Zeit eines abgeschlossenen, abgebrochenen oder fehlgeschlagenen Kopierversuchs angeben.

copyCompletedOn?: Date

Eigenschaftswert

Date

copyId

Zeichenfolgenbezeichner für den letzten versuchten Kopierdateivorgang, bei dem diese Datei die Zieldatei war.

copyId?: string

Eigenschaftswert

string

copyProgress

Enthält die Anzahl der kopierten Bytes und die Gesamtbytes in der Quelle im letzten versuchten Kopierdateivorgang, bei dem diese Datei die Zieldatei war. Kann zwischen 0 und Kopierte Bytes mit Inhaltslänge anzeigen.

copyProgress?: string

Eigenschaftswert

string

copySource

URL mit einer Länge von bis zu 2 KB, die die Quelldatei angibt, die beim letzten versuchten Kopiervorgang verwendet wurde, bei dem diese Datei die Zieldatei war.

copySource?: string

Eigenschaftswert

string

copyStatus

Status des Kopiervorgangs, der durch "x-ms-copy-id" identifiziert wird.

copyStatus?: CopyStatusType

Eigenschaftswert

CopyStatusType

copyStatusDescription

Wird nur angezeigt, wenn x-ms-copy-status fehlgeschlagen oder ausstehend ist. Beschreibt die Ursache eines schwerwiegenden oder nicht schwerwiegenden Fehlers beim Kopiervorgang.

copyStatusDescription?: string

Eigenschaftswert

string

date

Ein vom Dienst generierter Datums-/Uhrzeitwert in UTC, der angibt, wann die Antwort initiiert wurde.

date?: Date

Eigenschaftswert

Date

errorCode

Fehlercode

errorCode?: string

Eigenschaftswert

string

etag

Das ETag enthält einen Wert, den Sie zum bedingten Ausführen von Vorgängen in Anführungszeichen verwenden können.

etag?: string

Eigenschaftswert

string

fileAttributes

Attribute, die für die Datei festgelegt sind.

fileAttributes?: string

Eigenschaftswert

string

fileChangeOn

Ändern der Zeit für die Datei.

fileChangeOn?: Date

Eigenschaftswert

Date

fileCreatedOn

Erstellungszeit für die Datei.

fileCreatedOn?: Date

Eigenschaftswert

Date

fileId

Die fileId der Datei.

fileId?: string

Eigenschaftswert

string

fileLastWriteOn

Zeitpunkt des letzten Schreibvorgangs für die Datei.

fileLastWriteOn?: Date

Eigenschaftswert

Date

fileParentId

Die übergeordnete FileId der Datei.

fileParentId?: string

Eigenschaftswert

string

filePermissionKey

Schlüssel des Berechtigungssatzes für die Datei.

filePermissionKey?: string

Eigenschaftswert

string

fileType

Gibt den Typ File zurück. Für die zukünftige Verwendung reserviert.

fileType?: string

Eigenschaftswert

string

isServerEncrypted

Der Wert dieses Headers wird auf true festgelegt, wenn die Dateidaten und Anwendungsmetadaten vollständig mit dem angegebenen Algorithmus verschlüsselt werden. Andernfalls wird der Wert auf false festgelegt (wenn die Datei unverschlüsselt ist oder nur Teile der Datei-/Anwendungsmetadaten verschlüsselt sind).

isServerEncrypted?: boolean

Eigenschaftswert

boolean

lastModified

Gibt das Datum und die Uhrzeit der letzten Änderung der Datei zurück. Das Datumsformat entspricht RFC 1123. Jeder Vorgang, der die Datei oder deren Eigenschaften ändert, aktualisiert den Zeitpunkt der letzten Änderung.

lastModified?: Date

Eigenschaftswert

Date

leaseDuration

Wenn eine Datei geleast wird, gibt an, ob die Lease eine unbegrenzte oder eine feste Dauer hat.

leaseDuration?: LeaseDurationType

Eigenschaftswert

LeaseDurationType

leaseState

Leasestatus der Datei.

leaseState?: LeaseStateType

Eigenschaftswert

LeaseStateType

leaseStatus

Der aktuelle Leasestatus der Datei.

leaseStatus?: LeaseStatusType

Eigenschaftswert

LeaseStatusType

metadata

Ein Satz von Name-Wert-Paaren, die dieser Datei als benutzerdefinierte Metadaten zugeordnet sind.

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

Eigenschaftswert

{[propertyName: string]: string}

requestId

Dieser Header identifiziert die erfolgte Anforderung eindeutig und kann für die Problembehandlung der Anforderung verwendet werden.

requestId?: string

Eigenschaftswert

string

version

Gibt die Version des Dateidiensts an, der zum Ausführen der Abfrage verwendet wird.

version?: string

Eigenschaftswert

string