FileGetPropertiesHeaders interface

Paquet:

@azure/storage-file-share

Définit des en-têtes pour l’opération de File_getProperties.

Propriétés

cacheControl	Si l’en-tête de requête Cache-Control a déjà été défini pour le fichier, la valeur Cache-Control est retournée dans cet en-tête.
contentDisposition	Retourne la valeur spécifiée pour l’en-tête « x-ms-content-disposition » et spécifie comment traiter la réponse.
contentEncoding	Si l’en-tête de requête Content-Encoding a déjà été défini pour le fichier, la valeur Content-Encoding est retournée dans cet en-tête.
contentLanguage	Retourne la valeur spécifiée pour l’en-tête de requête Content-Language.
contentLength	Taille du fichier en octets. Cet en-tête retourne la valeur de l’en-tête « x-ms-content-length » stocké avec le fichier.
contentMD5	Si l’en-tête Content-MD5 a été défini pour le fichier, l’en-tête de réponse Content-MD5 est retourné afin que le client puisse vérifier l’intégrité du contenu du message.
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 terminée, abandonnée ou ayant é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 dans 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 jusqu’à 2 Ko de longueur 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	S’affiche uniquement lorsque x-ms-copy-status a échoué ou en attente. Décrit la cause d’échec d’opération de copie irrécupérable ou non irrécupérable.
date	Valeur de date/heure UTC générée par le service qui indique l’heure à laquelle la réponse a été lancé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.
fileCreatedOn	Heure de création du fichier.
fileId	FileId du fichier.
fileLastWriteOn	Dernière heure d’écriture du fichier.
fileParentId	Id de fichier parent du fichier.
filePermissionKey	Clé du jeu d’autorisations pour le fichier.
fileType	Retourne le type Fichier. Réservé pour une utilisation ultérieure.
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 des parties des métadonnées de fichier/application sont chiffrées).
lastModified	Retourne la date et l’heure de la dernière modification du fichier. Le format de date suit RFC 1123. Toute opération qui modifie le fichier ou ses propriétés met à jour l’heure de 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.
posixProperties	Propriétés des fichiers NFS.
requestId	Cet en-tête identifie de manière 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 fichiers utilisé pour exécuter la requête.

Détails de la propriété

cacheControl

Si l’en-tête de requête Cache-Control a déjà été défini pour le fichier, la valeur Cache-Control est retournée dans cet en-tête.

cacheControl?: string

Valeur de propriété

string

contentDisposition

Retourne la valeur 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

Si l’en-tête de requête Content-Encoding a déjà été défini pour le fichier, la valeur Content-Encoding est retournée dans cet en-tête.

contentEncoding?: string

Valeur de propriété

string

contentLanguage

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

contentLanguage?: string

Valeur de propriété

string

contentLength

Taille du fichier en octets. Cet en-tête retourne la valeur de l’en-tête « x-ms-content-length » stocké avec le fichier.

contentLength?: number

Valeur de propriété

number

contentMD5

Si l’en-tête Content-MD5 a été défini pour le fichier, l’en-tête de réponse Content-MD5 est retourné afin que le client puisse vérifier l’intégrité du contenu du message.

contentMD5?: Uint8Array

Valeur de propriété

Uint8Array

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 terminée, abandonnée ou ayant é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 dans 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 jusqu’à 2 Ko de longueur 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

S’affiche uniquement lorsque x-ms-copy-status a échoué ou en attente. Décrit la cause d’échec d’opération de copie irrécupérable ou non irrécupérable.

copyStatusDescription?: string

Valeur de propriété

string

date

Valeur de date/heure UTC générée par le service qui indique l’heure à laquelle la réponse a été lancé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

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

Dernière heure d’écriture du fichier.

fileLastWriteOn?: Date

Valeur de propriété

Date

fileParentId

Id de fichier 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

fileType

Retourne le type Fichier. Réservé pour une utilisation ultérieure.

fileType?: 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 des parties des métadonnées de fichier/application sont chiffrées).

isServerEncrypted?: boolean

Valeur de propriété

boolean

lastModified

Retourne la date et l’heure de la dernière modification du fichier. Le format de date suit RFC 1123. Toute opération qui modifie le fichier ou ses propriétés met à jour l’heure de 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}

posixProperties

Propriétés des fichiers NFS.

posixProperties?: FilePosixProperties

Valeur de propriété

FilePosixProperties

requestId

Cet en-tête identifie de manière 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 fichiers utilisé pour exécuter la requête.

version?: string

Valeur de propriété

string