BlobDownloadHeaders interface

Paquet:

@azure/storage-blob

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

Propriétés

acceptRanges	Indique que le service prend en charge les demandes pour le contenu partiel d'objets blob.
blobCommittedBlockCount	Nombre de blocs validés présents dans l’objet blob. Cet en-tête est retourné uniquement pour les objets blob d’ajout.
blobContentMD5	Si l’objet blob 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 de l’objet blob 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
blobSequenceNumber	Le numéro de séquence actuel d'un objet blob de pages. Cet en-tête n’est pas retourné pour les objets blob de blocs ou les objets blob d’ajout
blobType	Type de l’objet blob.
cacheControl	Cet en-tête est retourné s'il a été précédemment spécifié pour l'objet blob.
clientRequestId	Si un en-tête d’ID de demande client est envoyé dans la demande, cet en-tête est présent dans la réponse avec la même valeur.
contentCrc64	Si la demande est de lire une plage spécifiée et que x-ms-range-get-content-crc64 a la valeur true, la requête renvoie un crc64 pour la plage, tant que la taille de la plage est inférieure ou égale à 4 Mo. Si x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 est spécifié dans la même requête, il échoue avec 400 (demande incorrecte).
contentDisposition	Cet en-tête retourne la valeur qui a été spécifiée pour l’en-tête « x-ms-blob-content-disposition ». Le champ d’en-tête de réponse Content-Disposition fournit des informations supplémentaires sur la façon de traiter la charge utile de réponse, et peut également être utilisé pour joindre des métadonnées supplémentaires. Par exemple, si elle est définie sur pièce jointe, cela indique que l’agent utilisateur ne doit pas afficher la réponse, mais à la place afficher une boîte de dialogue Enregistrer sous avec un nom de fichier autre que le nom d’objet blob spécifié.
contentEncoding	Cet en-tête retourne la valeur qui a été spécifiée pour l’en-tête de requête Content-Encoding
contentLanguage	Cet en-tête 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 que cette opération consiste à lire l’objet blob complet, cet en-tête de réponse est retourné afin que le client puisse case activée pour l’intégrité du contenu du message.
contentRange	Indique la plage d’octets retournée dans le cas où le client a demandé un sous-ensemble de l’objet blob en définissant l’en-tête de requête « Plage ».
contentType	Type de média du corps de la réponse. Pour Télécharger l’objet blob, il s’agit de « application/octet-stream »
copyCompletedOn	Heure de conclusion de la dernière tentative d’opération Copier l’objet blob où cet objet blob était l’objet blob 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é. Cet en-tête n’apparaît pas si une copie est en attente, si cet objet blob n’a jamais été la destination d’une opération De copie d’objet blob, ou si cet objet blob a été modifié après une opération de copie d’objet blob terminée à l’aide de Définir les propriétés de l’objet blob, de placer un objet blob ou de placer une liste de blocs.
copyId	Identificateur de chaîne pour cette opération de copie. Utilisez avec Obtenir les propriétés de l’objet blob pour case activée la status de cette opération de copie, ou passez à Abandonner la copie d’objet blob pour abandonner une copie en attente.
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 l’objet blob où cet objet blob était l’objet blob de destination. Peut afficher entre 0 et les octets de longueur de contenu copiés. Cet en-tête n’apparaît pas si cet objet blob n’a jamais été la destination d’une opération copier l’objet blob, ou si cet objet blob a été modifié après une opération de copie d’objet blob terminée à l’aide de Définir les propriétés de l’objet blob, Put Blob ou Put Block List
copySource	URL d’une longueur maximale de 2 Ko qui spécifie l’objet blob ou le fichier source utilisé dans la dernière tentative d’opération Copier l’objet blob où cet objet blob était l’objet blob de destination. Cet en-tête n’apparaît pas si cet objet blob n’a jamais été la destination d’une opération de copie d’objet blob, ou si cet objet blob a été modifié après une opération de copie d’objet blob terminée à l’aide de Définir les propriétés d’objet blob, Put Blob ou Put Block List.
copyStatus	État de l’opération de copie identifiée par x-ms-copy-id.
copyStatusDescription	Apparaît uniquement lorsque x-ms-copy-status est en échec ou en attente. Décrit la cause du dernier échec de l'opération de copie irrécupérable ou non. Cet en-tête n’apparaît pas si cet objet blob n’a jamais été la destination d’une opération copier l’objet blob, ou si cet objet blob a été modifié après une opération de copie d’objet blob terminée à l’aide de Définir les propriétés de l’objet blob, Put Blob ou Put Block List
createdOn	Retourne la date et l’heure de création de l’objet blob.
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
encryptionKeySha256	Hachage SHA-256 de la clé de chiffrement utilisée pour chiffrer l’objet blob. Cet en-tête est retourné uniquement lorsque l’objet blob a été chiffré avec une clé fournie par le client.
encryptionScope	Retourne le nom de l’étendue de chiffrement utilisée pour chiffrer le contenu de l’objet blob et les métadonnées d’application. Notez que l’absence de cet en-tête implique l’utilisation de l’étendue de chiffrement de compte par défaut.
errorCode	Code d'erreur
etag	L'ETag contient une valeur que vous pouvez utiliser pour exécuter des opérations conditionnellement. Si la version de la demande est 18/08/2011 ou plus récente, la valeur de l'ETag sera entre guillemets.
immutabilityPolicyExpiresOn	Valeur de date/heure UTC générée par le service qui indique l’heure à laquelle la stratégie d’immuabilité des objets blob expire.
immutabilityPolicyMode	Indique le mode de stratégie d’immuabilité.
isCurrentVersion	La valeur de cet en-tête indique si la version de cet objet blob est une version actuelle. Consultez également l’en-tête x-ms-version-id.
isSealed	Si cet objet blob a été scellé
isServerEncrypted	La valeur de cet en-tête est définie sur true si les données d’objet blob 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 l’objet blob n’est pas chiffré ou si seules certaines parties des métadonnées de l’objet blob/de l’application sont chiffrées).
lastAccessed	Valeur de date/heure UTC générée par le service qui indique l’heure à laquelle l’objet blob a été lu pour la dernière fois ou écrit dans
lastModified	Renvoie la date et l'heure de la dernière modification du conteneur. Toute opération qui modifie l'objet blob, notamment une mise à jour des métadonnées ou des propriétés de l'objet blob, modifie l'heure de la dernière modification de l'objet blob.
leaseDuration	Quand un objet blob est loué, spécifie si le bail est d'une durée illimitée ou fixe.
leaseState	État du bail de l'objet blob.
leaseStatus	L'état de bail actuel de l'objet blob.
legalHold	Indique si une conservation légale est présente sur l’objet blob.
metadata
objectReplicationPolicyId	facultatif. Valide uniquement lorsque la réplication d’objet est activée pour le conteneur de stockage et sur l’objet blob de destination de la réplication.
objectReplicationRules	facultatif. Valide uniquement lorsque la réplication d’objets est activée pour le conteneur de stockage et sur l’objet blob source de la réplication. Lors de la récupération de cet en-tête, il retourne l’en-tête avec l’ID de stratégie et l’ID de règle (par exemple, x-ms-or-policyid_ruleid), et la valeur est la status de la réplication (par exemple, terminée, ayant échoué).
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.
tagCount	Nombre de balises associées à l’objet blob
version	Indique la version du service BLOB utilisée pour exécuter la demande. Cet en-tête est renvoyé pour les demandes effectuées avec la version du 19/09/2009 et ultérieure.
versionId	Valeur DateTime retournée par le service qui identifie de manière unique l’objet blob. La valeur de cet en-tête indique la version de l’objet blob et peut être utilisée dans les demandes suivantes pour accéder à cette version de l’objet blob.

Détails de la propriété

acceptRanges

Indique que le service prend en charge les demandes pour le contenu partiel d'objets blob.

acceptRanges?: string

Valeur de propriété

string

blobCommittedBlockCount

Nombre de blocs validés présents dans l’objet blob. Cet en-tête est retourné uniquement pour les objets blob d’ajout.

blobCommittedBlockCount?: number

Valeur de propriété

number

blobContentMD5

Si l’objet blob 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 de l’objet blob 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

blobContentMD5?: Uint8Array

Valeur de propriété

Uint8Array

blobSequenceNumber

Le numéro de séquence actuel d'un objet blob de pages. Cet en-tête n’est pas retourné pour les objets blob de blocs ou les objets blob d’ajout

blobSequenceNumber?: number

Valeur de propriété

number

blobType

Type de l’objet blob.

blobType?: BlobType

Valeur de propriété

BlobType

cacheControl

Cet en-tête est retourné s'il a été précédemment spécifié pour l'objet blob.

cacheControl?: string

Valeur de propriété

string

clientRequestId

Si un en-tête d’ID de demande client est envoyé dans la demande, cet en-tête est présent dans la réponse avec la même valeur.

clientRequestId?: string

Valeur de propriété

string

contentCrc64

Si la demande est de lire une plage spécifiée et que x-ms-range-get-content-crc64 a la valeur true, la requête renvoie un crc64 pour la plage, tant que la taille de la plage est inférieure ou égale à 4 Mo. Si x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 est spécifié dans la même requête, il échoue avec 400 (demande incorrecte).

contentCrc64?: Uint8Array

Valeur de propriété

Uint8Array

contentDisposition

Cet en-tête retourne la valeur qui a été spécifiée pour l’en-tête « x-ms-blob-content-disposition ». Le champ d’en-tête de réponse Content-Disposition fournit des informations supplémentaires sur la façon de traiter la charge utile de réponse, et peut également être utilisé pour joindre des métadonnées supplémentaires. Par exemple, si elle est définie sur pièce jointe, cela indique que l’agent utilisateur ne doit pas afficher la réponse, mais à la place afficher une boîte de dialogue Enregistrer sous avec un nom de fichier autre que le nom d’objet blob spécifié.

contentDisposition?: string

Valeur de propriété

string

contentEncoding

Cet en-tête 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

Cet en-tête 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 que cette opération consiste à lire l’objet blob complet, cet en-tête de réponse est retourné afin que le client puisse case activée pour l’intégrité du contenu du message.

contentMD5?: Uint8Array

Valeur de propriété

Uint8Array

contentRange

Indique la plage d’octets retournée dans le cas où le client a demandé un sous-ensemble de l’objet blob en définissant l’en-tête de requête « Plage ».

contentRange?: string

Valeur de propriété

string

contentType

Type de média du corps de la réponse. Pour Télécharger l’objet blob, il s’agit de « application/octet-stream »

contentType?: string

Valeur de propriété

string

copyCompletedOn

Heure de conclusion de la dernière tentative d’opération Copier l’objet blob où cet objet blob était l’objet blob 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é. Cet en-tête n’apparaît pas si une copie est en attente, si cet objet blob n’a jamais été la destination d’une opération De copie d’objet blob, ou si cet objet blob a été modifié après une opération de copie d’objet blob terminée à l’aide de Définir les propriétés de l’objet blob, de placer un objet blob ou de placer une liste de blocs.

copyCompletedOn?: Date

Valeur de propriété

Date

copyId

Identificateur de chaîne pour cette opération de copie. Utilisez avec Obtenir les propriétés de l’objet blob pour case activée la status de cette opération de copie, ou passez à Abandonner la copie d’objet blob pour abandonner une copie en attente.

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 l’objet blob où cet objet blob était l’objet blob de destination. Peut afficher entre 0 et les octets de longueur de contenu copiés. Cet en-tête n’apparaît pas si cet objet blob n’a jamais été la destination d’une opération copier l’objet blob, ou si cet objet blob a été modifié après une opération de copie d’objet blob terminée à l’aide de Définir les propriétés de l’objet blob, Put Blob ou Put Block List

copyProgress?: string

Valeur de propriété

string

copySource

URL d’une longueur maximale de 2 Ko qui spécifie l’objet blob ou le fichier source utilisé dans la dernière tentative d’opération Copier l’objet blob où cet objet blob était l’objet blob de destination. Cet en-tête n’apparaît pas si cet objet blob n’a jamais été la destination d’une opération de copie d’objet blob, ou si cet objet blob a été modifié après une opération de copie d’objet blob terminée à l’aide de Définir les propriétés d’objet blob, Put Blob ou Put Block List.

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 lorsque x-ms-copy-status est en échec ou en attente. Décrit la cause du dernier échec de l'opération de copie irrécupérable ou non. Cet en-tête n’apparaît pas si cet objet blob n’a jamais été la destination d’une opération copier l’objet blob, ou si cet objet blob a été modifié après une opération de copie d’objet blob terminée à l’aide de Définir les propriétés de l’objet blob, Put Blob ou Put Block List

copyStatusDescription?: string

Valeur de propriété

string

createdOn

Retourne la date et l’heure de création de l’objet blob.

createdOn?: Date

Valeur de propriété

Date

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

encryptionKeySha256

Hachage SHA-256 de la clé de chiffrement utilisée pour chiffrer l’objet blob. Cet en-tête est retourné uniquement lorsque l’objet blob a été chiffré avec une clé fournie par le client.

encryptionKeySha256?: string

Valeur de propriété

string

encryptionScope

Retourne le nom de l’étendue de chiffrement utilisée pour chiffrer le contenu de l’objet blob et les métadonnées d’application. Notez que l’absence de cet en-tête implique l’utilisation de l’étendue de chiffrement de compte par défaut.

encryptionScope?: string

Valeur de propriété

string

errorCode

Code d'erreur

errorCode?: string

Valeur de propriété

string

etag

L'ETag contient une valeur que vous pouvez utiliser pour exécuter des opérations conditionnellement. Si la version de la demande est 18/08/2011 ou plus récente, la valeur de l'ETag sera entre guillemets.

etag?: string

Valeur de propriété

string

immutabilityPolicyExpiresOn

Valeur de date/heure UTC générée par le service qui indique l’heure à laquelle la stratégie d’immuabilité des objets blob expire.

immutabilityPolicyExpiresOn?: Date

Valeur de propriété

Date

immutabilityPolicyMode

Indique le mode de stratégie d’immuabilité.

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Valeur de propriété

BlobImmutabilityPolicyMode

isCurrentVersion

La valeur de cet en-tête indique si la version de cet objet blob est une version actuelle. Consultez également l’en-tête x-ms-version-id.

isCurrentVersion?: boolean

Valeur de propriété

boolean

isSealed

Si cet objet blob a été scellé

isSealed?: boolean

Valeur de propriété

boolean

isServerEncrypted

La valeur de cet en-tête est définie sur true si les données d’objet blob 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 l’objet blob n’est pas chiffré ou si seules certaines parties des métadonnées de l’objet blob/de l’application sont chiffrées).

isServerEncrypted?: boolean

Valeur de propriété

boolean

lastAccessed

Valeur de date/heure UTC générée par le service qui indique l’heure à laquelle l’objet blob a été lu pour la dernière fois ou écrit dans

lastAccessed?: Date

Valeur de propriété

Date

lastModified

Renvoie la date et l'heure de la dernière modification du conteneur. Toute opération qui modifie l'objet blob, notamment une mise à jour des métadonnées ou des propriétés de l'objet blob, modifie l'heure de la dernière modification de l'objet blob.

lastModified?: Date

Valeur de propriété

Date

leaseDuration

Quand un objet blob est loué, spécifie si le bail est d'une durée illimitée ou fixe.

leaseDuration?: LeaseDurationType

Valeur de propriété

LeaseDurationType

leaseState

État du bail de l'objet blob.

leaseState?: LeaseStateType

Valeur de propriété

LeaseStateType

leaseStatus

L'état de bail actuel de l'objet blob.

leaseStatus?: LeaseStatusType

Valeur de propriété

LeaseStatusType

legalHold

Indique si une conservation légale est présente sur l’objet blob.

legalHold?: boolean

Valeur de propriété

boolean

metadata

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

Valeur de propriété

{[propertyName: string]: string}

objectReplicationPolicyId

facultatif. Valide uniquement lorsque la réplication d’objet est activée pour le conteneur de stockage et sur l’objet blob de destination de la réplication.

objectReplicationPolicyId?: string

Valeur de propriété

string

objectReplicationRules

facultatif. Valide uniquement lorsque la réplication d’objets est activée pour le conteneur de stockage et sur l’objet blob source de la réplication. Lors de la récupération de cet en-tête, il retourne l’en-tête avec l’ID de stratégie et l’ID de règle (par exemple, x-ms-or-policyid_ruleid), et la valeur est la status de la réplication (par exemple, terminée, ayant échoué).

objectReplicationRules?: {[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

tagCount

Nombre de balises associées à l’objet blob

tagCount?: number

Valeur de propriété

number

version

Indique la version du service BLOB utilisée pour exécuter la demande. Cet en-tête est renvoyé pour les demandes effectuées avec la version du 19/09/2009 et ultérieure.

version?: string

Valeur de propriété

string

versionId

Valeur DateTime retournée par le service qui identifie de manière unique l’objet blob. La valeur de cet en-tête indique la version de l’objet blob et peut être utilisée dans les demandes suivantes pour accéder à cette version de l’objet blob.

versionId?: string

Valeur de propriété

string