FileDownloadHeaders interface

Paket:

@azure/storage-file-share

Definiert Header für File_download Vorgang.

Eigenschaften

acceptRanges	Gibt an, dass der Dienst Anforderungen für partielle Dateiinhalte unterstützt.
cacheControl	Wird zurückgegeben, wenn es zuvor für die Datei angegeben wurde.
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	Gibt den Wert zurück, der für den Anforderungsheader "Content-Encoding" angegeben wurde.
contentLanguage	Gibt den Wert zurück, der für den Content-Language-Anforderungsheader angegeben wurde.
contentLength	Die Anzahl der im Antworttext vorhandenen Bytes.
contentMD5	Wenn die Datei über einen MD5-Hash verfügt und bei der Anforderung die vollständige Datei gelesen werden soll, wird dieser Antwortheader zurückgegeben, sodass der Client die Integrität des Nachrichteninhalts überprüfen kann. Wenn die Anforderung einen angegebenen Bereich lesen soll und "x-ms-range-get-content-md5" auf true festgelegt ist, gibt die Anforderung einen MD5-Hash für den Bereich zurück, solange die Bereichsgröße kleiner als oder gleich 4 MB ist. Wenn keine dieser Bedingungen richtig ist, wird kein Wert für den Header "Content-MD5" zurückgegeben.
contentRange	Gibt den Bereich der Bytes an, die zurückgegeben werden, wenn der Client eine Teilmenge der Datei angefordert hat, indem er den Bereichsanforderungsheader festlegt.
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 verwenden können, um Vorgänge bedingt in Anführungszeichen auszuführen.
fileAttributes	Attribute, die für die Datei festgelegt sind.
fileChangeOn	Ändern Sie die Zeit für die Datei.
fileContentMD5	Wenn die Datei über einen MD5-Hash verfügt und die Anforderung bereichsheader (Range oder x-ms-range) enthält, wird dieser Antwortheader mit dem Wert des MD5-Werts der gesamten Datei zurückgegeben. Dieser Wert kann gleich dem wert sein, der im Content-MD5-Header zurückgegeben wird, wobei letzterer aus dem angeforderten Bereich berechnet wird.
fileCreatedOn	Erstellungszeit für die Datei.
fileId	Die fileId der Datei.
fileLastWriteOn	Letzte Schreibzeit für die Datei.
fileParentId	Die übergeordnete Datei-ID der Datei.
filePermissionKey	Schlüssel des Berechtigungssatzes für die Datei.
isServerEncrypted	Der Wert dieses Headers wird auf true festgelegt, wenn die Dateidaten und Anwendungsmetadaten mit dem angegebenen Algorithmus vollständig verschlüsselt werden. Andernfalls wird der Wert auf false festgelegt (wenn die Datei unverschlüsselt ist oder wenn nur Teile der Datei-/Anwendungsmetadaten verschlüsselt sind).
lastModified	Gibt das Datum und die Uhrzeit der letzten Änderung der Datei zurück. Jeder Vorgang, der die Datei oder ihre 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

acceptRanges

Gibt an, dass der Dienst Anforderungen für partielle Dateiinhalte unterstützt.

acceptRanges?: string

Eigenschaftswert

string

cacheControl

Wird zurückgegeben, wenn es zuvor für die Datei angegeben wurde.

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

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

contentEncoding?: string

Eigenschaftswert

string

contentLanguage

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

contentLanguage?: string

Eigenschaftswert

string

contentLength

Die Anzahl der im Antworttext vorhandenen Bytes.

contentLength?: number

Eigenschaftswert

number

contentMD5

Wenn die Datei über einen MD5-Hash verfügt und bei der Anforderung die vollständige Datei gelesen werden soll, wird dieser Antwortheader zurückgegeben, sodass der Client die Integrität des Nachrichteninhalts überprüfen kann. Wenn die Anforderung einen angegebenen Bereich lesen soll und "x-ms-range-get-content-md5" auf true festgelegt ist, gibt die Anforderung einen MD5-Hash für den Bereich zurück, solange die Bereichsgröße kleiner als oder gleich 4 MB ist. Wenn keine dieser Bedingungen richtig ist, wird kein Wert für den Header "Content-MD5" zurückgegeben.

contentMD5?: Uint8Array

Eigenschaftswert

Uint8Array

contentRange

Gibt den Bereich der Bytes an, die zurückgegeben werden, wenn der Client eine Teilmenge der Datei angefordert hat, indem er den Bereichsanforderungsheader festlegt.

contentRange?: string

Eigenschaftswert

string

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 verwenden können, um Vorgänge bedingt in Anführungszeichen auszuführen.

etag?: string

Eigenschaftswert

string

fileAttributes

Attribute, die für die Datei festgelegt sind.

fileAttributes?: string

Eigenschaftswert

string

fileChangeOn

Ändern Sie die Zeit für die Datei.

fileChangeOn?: Date

Eigenschaftswert

Date

fileContentMD5

Wenn die Datei über einen MD5-Hash verfügt und die Anforderung bereichsheader (Range oder x-ms-range) enthält, wird dieser Antwortheader mit dem Wert des MD5-Werts der gesamten Datei zurückgegeben. Dieser Wert kann gleich dem wert sein, der im Content-MD5-Header zurückgegeben wird, wobei letzterer aus dem angeforderten Bereich berechnet wird.

fileContentMD5?: Uint8Array

Eigenschaftswert

Uint8Array

fileCreatedOn

Erstellungszeit für die Datei.

fileCreatedOn?: Date

Eigenschaftswert

Date

fileId

Die fileId der Datei.

fileId?: string

Eigenschaftswert

string

fileLastWriteOn

Letzte Schreibzeit für die Datei.

fileLastWriteOn?: Date

Eigenschaftswert

Date

fileParentId

Die übergeordnete Datei-ID der Datei.

fileParentId?: string

Eigenschaftswert

string

filePermissionKey

Schlüssel des Berechtigungssatzes für die Datei.

filePermissionKey?: string

Eigenschaftswert

string

isServerEncrypted

Der Wert dieses Headers wird auf true festgelegt, wenn die Dateidaten und Anwendungsmetadaten mit dem angegebenen Algorithmus vollständig verschlüsselt werden. Andernfalls wird der Wert auf false festgelegt (wenn die Datei unverschlüsselt ist oder wenn 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. Jeder Vorgang, der die Datei oder ihre 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