Partager via

FileDownloadHeaders interface

  • Référence
Paquet:
@azure/storage-file-share

Définit des en-têtes pour File_download opération.

Propriétés

acceptRanges

Indique que le service prend en charge les demandes de contenu partiel de fichier.
cacheControl

Retourné s’il a été spécifié précédemment pour le fichier.
contentDisposition

Retourne la valeur qui a été spécifiée pour l’en-tête « x-ms-content-disposition » et spécifie comment traiter la réponse.
contentEncoding

Retourne la valeur qui a été spécifiée pour l’en-tête de requête Content-Encoding.
contentLanguage

Retourne la valeur qui a été spécifiée pour l’en-tête de requête Content-Language.
contentLength

Le nombre d'octets présents dans le corps de la réponse.
contentMD5

Si l'objet blob a un hachage MD5 et si la demande est de lire entièrement l'objet blob, cet en-tête de réponse est renvoyé afin que le client puisse vérifier l'intégrité du contenu du message. Si la demande est de lire une plage spécifiée et que la valeur « x-ms-range-get-content-md5 » est définie sur true, la requête retourne un hachage MD5 pour la plage, tant que la taille de la plage est inférieure ou égale à 4 Mo. Si aucun de ces ensembles de conditions n’est vrai, aucune valeur n’est retournée pour l’en-tête « Content-MD5 ».
contentRange

Indique la plage d’octets retournée si le client a demandé un sous-ensemble du fichier en définissant l’en-tête de requête Range.
contentType

Type de contenu spécifié pour le fichier. Le type de contenu par défaut est « application/octet-stream »
copyCompletedOn

Heure de conclusion de la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination. Cette valeur peut spécifier l'heure d'une tentative de copie qui s'est terminée, qui a été annulée ou qui a échoué.
copyId

Identificateur de chaîne pour la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination.
copyProgress

Contient le nombre d’octets copiés et le nombre total d’octets dans la source lors de la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination. Peut afficher entre 0 et les octets de longueur de contenu copiés.
copySource

URL d’une longueur maximale de 2 Ko qui spécifie le fichier source utilisé dans la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination.
copyStatus

État de l’opération de copie identifiée par « x-ms-copy-id ».
copyStatusDescription

Apparaît uniquement en cas d’échec ou d’attente de x-ms-copy-status. Décrit la cause d'un échec de l'opération de copie irrécupérable ou non.
date

Une valeur de date/heure UTC générée par le service qui indique le moment auquel la réponse a été initiée.
errorCode

Code d'erreur
etag

L’ETag contient une valeur que vous pouvez utiliser pour effectuer des opérations de manière conditionnelle, entre guillemets.
fileAttributes

Attributs définis pour le fichier.
fileChangeOn

Modifier l’heure du fichier.
fileContentMD5

Si le fichier a un hachage MD5 et si la requête contient un en-tête de plage (Range ou x-ms-range), cet en-tête de réponse est retourné avec la valeur de la valeur MD5 du fichier entier. Cette valeur peut être égale ou non à la valeur retournée dans l’en-tête Content-MD5, cette dernière étant calculée à partir de la plage demandée.
fileCreatedOn

Heure de création du fichier.
fileId

FileId du fichier.
fileLastWriteOn

Heure de la dernière écriture du fichier.
fileParentId

FileId parent du fichier.
filePermissionKey

Clé du jeu d’autorisations pour le fichier.
isServerEncrypted

La valeur de cet en-tête est définie sur true si les données de fichier et les métadonnées d’application sont entièrement chiffrées à l’aide de l’algorithme spécifié. Sinon, la valeur est définie sur false (lorsque le fichier n’est pas chiffré, ou si seules certaines parties des métadonnées du fichier/de l’application sont chiffrées).
lastModified

Renvoie la date et l'heure de dernière modification du fichier. Toute opération qui modifie le fichier ou ses propriétés met à jour l’heure de la dernière modification.
leaseDuration

Lorsqu’un fichier est loué, spécifie si le bail est d’une durée infinie ou fixe.
leaseState

État du bail du fichier.
leaseStatus

État actuel du bail du fichier.
metadata

Ensemble de paires nom-valeur associées à ce fichier en tant que métadonnées définies par l'utilisateur.
requestId

Cet en-tête identifie de façon unique la demande qui a été effectuée et peut être utilisé pour résoudre les problèmes de la demande.
version

Indique la version du service de Fichier utilisée pour exécuter la demande.

Détails de la propriété

acceptRanges

Indique que le service prend en charge les demandes de contenu partiel de fichier.

acceptRanges?: string

Valeur de propriété

string

cacheControl

Retourné s’il a été spécifié précédemment pour le fichier.

cacheControl?: string

Valeur de propriété

string

contentDisposition

Retourne la valeur qui a été spécifiée pour l’en-tête « x-ms-content-disposition » et spécifie comment traiter la réponse.

contentDisposition?: string

Valeur de propriété

string

contentEncoding

Retourne la valeur qui a été spécifiée pour l’en-tête de requête Content-Encoding.

contentEncoding?: string

Valeur de propriété

string

contentLanguage

Retourne la valeur qui a été spécifiée pour l’en-tête de requête Content-Language.

contentLanguage?: string

Valeur de propriété

string

contentLength

Le nombre d'octets présents dans le corps de la réponse.

contentLength?: number

Valeur de propriété

number

contentMD5

Si l'objet blob a un hachage MD5 et si la demande est de lire entièrement l'objet blob, cet en-tête de réponse est renvoyé afin que le client puisse vérifier l'intégrité du contenu du message. Si la demande est de lire une plage spécifiée et que la valeur « x-ms-range-get-content-md5 » est définie sur true, la requête retourne un hachage MD5 pour la plage, tant que la taille de la plage est inférieure ou égale à 4 Mo. Si aucun de ces ensembles de conditions n’est vrai, aucune valeur n’est retournée pour l’en-tête « Content-MD5 ».

contentMD5?: Uint8Array

Valeur de propriété

Uint8Array

contentRange

Indique la plage d’octets retournée si le client a demandé un sous-ensemble du fichier en définissant l’en-tête de requête Range.

contentRange?: string

Valeur de propriété

string

contentType

Type de contenu spécifié pour le fichier. Le type de contenu par défaut est « application/octet-stream »

contentType?: string

Valeur de propriété

string

copyCompletedOn

Heure de conclusion de la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination. Cette valeur peut spécifier l'heure d'une tentative de copie qui s'est terminée, qui a été annulée ou qui a échoué.

copyCompletedOn?: Date

Valeur de propriété

Date

copyId

Identificateur de chaîne pour la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination.

copyId?: string

Valeur de propriété

string

copyProgress

Contient le nombre d’octets copiés et le nombre total d’octets dans la source lors de la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination. Peut afficher entre 0 et les octets de longueur de contenu copiés.

copyProgress?: string

Valeur de propriété

string

copySource

URL d’une longueur maximale de 2 Ko qui spécifie le fichier source utilisé dans la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination.

copySource?: string

Valeur de propriété

string

copyStatus

État de l’opération de copie identifiée par « x-ms-copy-id ».

copyStatus?: CopyStatusType

Valeur de propriété

CopyStatusType

copyStatusDescription

Apparaît uniquement en cas d’échec ou d’attente de x-ms-copy-status. Décrit la cause d'un échec de l'opération de copie irrécupérable ou non.

copyStatusDescription?: string

Valeur de propriété

string

date

Une valeur de date/heure UTC générée par le service qui indique le moment auquel la réponse a été initiée.

date?: Date

Valeur de propriété

Date

errorCode

Code d'erreur

errorCode?: string

Valeur de propriété

string

etag

L’ETag contient une valeur que vous pouvez utiliser pour effectuer des opérations de manière conditionnelle, entre guillemets.

etag?: string

Valeur de propriété

string

fileAttributes

Attributs définis pour le fichier.

fileAttributes?: string

Valeur de propriété

string

fileChangeOn

Modifier l’heure du fichier.

fileChangeOn?: Date

Valeur de propriété

Date

fileContentMD5

Si le fichier a un hachage MD5 et si la requête contient un en-tête de plage (Range ou x-ms-range), cet en-tête de réponse est retourné avec la valeur de la valeur MD5 du fichier entier. Cette valeur peut être égale ou non à la valeur retournée dans l’en-tête Content-MD5, cette dernière étant calculée à partir de la plage demandée.

fileContentMD5?: Uint8Array

Valeur de propriété

Uint8Array

fileCreatedOn

Heure de création du fichier.

fileCreatedOn?: Date

Valeur de propriété

Date

fileId

FileId du fichier.

fileId?: string

Valeur de propriété

string

fileLastWriteOn

Heure de la dernière écriture du fichier.

fileLastWriteOn?: Date

Valeur de propriété

Date

fileParentId

FileId parent du fichier.

fileParentId?: string

Valeur de propriété

string

filePermissionKey

Clé du jeu d’autorisations pour le fichier.

filePermissionKey?: string

Valeur de propriété

string

isServerEncrypted

La valeur de cet en-tête est définie sur true si les données de fichier et les métadonnées d’application sont entièrement chiffrées à l’aide de l’algorithme spécifié. Sinon, la valeur est définie sur false (lorsque le fichier n’est pas chiffré, ou si seules certaines parties des métadonnées du fichier/de l’application sont chiffrées).

isServerEncrypted?: boolean

Valeur de propriété

boolean

lastModified

Renvoie la date et l'heure de dernière modification du fichier. Toute opération qui modifie le fichier ou ses propriétés met à jour l’heure de la dernière modification.

lastModified?: Date

Valeur de propriété

Date

leaseDuration

Lorsqu’un fichier est loué, spécifie si le bail est d’une durée infinie ou fixe.

leaseDuration?: LeaseDurationType

Valeur de propriété

LeaseDurationType

leaseState

État du bail du fichier.

leaseState?: LeaseStateType

Valeur de propriété

LeaseStateType

leaseStatus

État actuel du bail du fichier.

leaseStatus?: LeaseStatusType

Valeur de propriété

LeaseStatusType

metadata

Ensemble de paires nom-valeur associées à ce fichier en tant que métadonnées définies par l'utilisateur.

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

Valeur de propriété

{[propertyName: string]: string}

requestId

Cet en-tête identifie de façon unique la demande qui a été effectuée et peut être utilisé pour résoudre les problèmes de la demande.

requestId?: string

Valeur de propriété

string

version

Indique la version du service de Fichier utilisée pour exécuter la demande.

version?: string

Valeur de propriété

string