BlobDownloadHeaders interface

Paquete:

@azure/storage-blob

Define encabezados para Blob_download operación.

Propiedades

acceptRanges	Indica que el servicio admite solicitudes de contenido parcial de blobs.
blobCommittedBlockCount	Número de bloques confirmados presentes en el blob. Este encabezado solo se devuelve para blobs en anexos.
blobContentMD5	Si el blob tiene un hash MD5 y si la solicitud contiene el encabezado de intervalo (Range o x-ms-range), este encabezado de respuesta se devuelve con el valor del valor MD5 de todo el blob. Este valor puede ser o no igual que el valor devuelto en el encabezado Content-MD5, con el último calculado a partir del intervalo solicitado.
blobSequenceNumber	El número de secuencia actual de un blob en páginas. Este encabezado no se devuelve para blobs en bloques o blobs en anexos.
blobType	Tipo del blob.
cacheControl	Se devuelve este encabezado si se especificó previamente para el blob.
clientRequestId	Si se envía un encabezado de identificador de solicitud de cliente en la solicitud, este encabezado estará presente en la respuesta con el mismo valor.
contentCrc64	Si la solicitud es leer un intervalo especificado y x-ms-range-get-content-crc64 se establece en true, la solicitud devuelve un crc64 para el rango, siempre y cuando el tamaño del intervalo sea menor o igual que 4 MB. Si se especifican x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 en la misma solicitud, se producirá un error 400(Solicitud incorrecta).
contentDisposition	Este encabezado devuelve el valor especificado para el encabezado "x-ms-blob-content-disposition". El campo encabezado de respuesta Content-Disposition transmite información adicional sobre cómo procesar la carga de respuesta y también se puede usar para adjuntar metadatos adicionales. Por ejemplo, si se establece en datos adjuntos, indica que el agente de usuario no debe mostrar la respuesta, sino que, en su lugar, muestra un cuadro de diálogo Guardar como con un nombre de archivo distinto del nombre de blob especificado.
contentEncoding	Este encabezado devuelve el valor especificado para el encabezado de solicitud Content-Encoding.
contentLanguage	Este encabezado devuelve el valor especificado para el encabezado de solicitud Content-Language.
contentLength	El número de bytes presentes en el cuerpo de respuesta.
contentMD5	Si el blob tiene un hash MD5 y esta operación es leer el blob completo, se devuelve este encabezado de respuesta para que el cliente pueda comprobar la integridad del contenido del mensaje.
contentRange	Indica el intervalo de bytes devuelto en caso de que el cliente solicitó un subconjunto del blob estableciendo el encabezado de solicitud "Range".
contentType	Tipo de medio del cuerpo de la respuesta. Para Descargar blob, se trata de "application/octet-stream".
copyCompletedOn	Hora de conclusión del último intento de copia de blob donde este blob era el blob de destino. Este valor puede especificar la hora de un intento de copia completado, anulado o con errores. Este encabezado no aparece si hay una copia pendiente, si este blob nunca ha sido el destino en una operación Copiar blob, o si este blob se ha modificado después de una operación de copia de blob finalizada mediante Establecer propiedades de blob, Put Blob o Put Block List.
copyId	Identificador de cadena para esta operación de copia. Use con Get Blob Properties (Obtener propiedades de blob) para comprobar el estado de esta operación de copia o pase a Abort Copy Blob (Anular el blob de copia) para anular una copia pendiente.
copyProgress	Contiene el número de bytes copiados y el total de bytes del origen en la última operación copy blob en la que este blob era el blob de destino. Puede mostrar entre 0 y bytes de longitud de contenido copiados. Este encabezado no aparece si este blob nunca ha sido el destino en una operación copiar blob, o si este blob se ha modificado después de una operación de copia de blob finalizada mediante Establecer propiedades de blob, Put Blob o Put Block List
copySource	Dirección URL de hasta 2 KB de longitud que especifica el blob o archivo de origen usado en la última operación copy blob donde este blob era el blob de destino. Este encabezado no aparece si este blob nunca ha sido el destino en una operación copiar blob, o si este blob se ha modificado después de una operación de copia de blob finalizada mediante Establecer propiedades de blob, Put Blob o Put Block List.
copyStatus	Estado de la operación de copia identificada por x-ms-copy-id.
copyStatusDescription	Solo aparece cuando x-ms-copy-status se produce un error o está pendiente. Describe la causa del último error recuperable o irrecuperable que se ha producido en la operación de copia. Este encabezado no aparece si este blob nunca ha sido el destino en una operación copiar blob, o si este blob se ha modificado después de una operación de copia de blob finalizada mediante Establecer propiedades de blob, Put Blob o Put Block List
createdOn	Devuelve la fecha y hora en que se creó el blob.
date	Valor de fecha y hora UTC generado por el servicio que indica la hora a la que se inició la respuesta
encryptionKeySha256	Hash SHA-256 de la clave de cifrado que se usa para cifrar el blob. Este encabezado solo se devuelve cuando el blob se cifró con una clave proporcionada por el cliente.
encryptionScope	Devuelve el nombre del ámbito de cifrado utilizado para cifrar el contenido del blob y los metadatos de la aplicación. Tenga en cuenta que la ausencia de este encabezado implica el uso del ámbito de cifrado de cuenta predeterminado.
errorCode	Código de error
etag	La ETag contiene un valor que se puede utilizar para realizar operaciones condicionales. Si la versión de la solicitud es 2011-08-18 o una más reciente, el valor ETag estará entre comillas.
immutabilityPolicyExpiresOn	Valor de fecha y hora UTC generado por el servicio que indica la hora a la que expirará la directiva de inmutabilidad del blob.
immutabilityPolicyMode	Indica el modo de directiva de inmutabilidad.
isCurrentVersion	El valor de este encabezado indica si la versión de este blob es una versión actual, consulte también el encabezado x-ms-version-id.
isSealed	Si este blob se ha sellado
isServerEncrypted	El valor de este encabezado se establece en true si los datos de blob y los metadatos de la aplicación se cifran completamente mediante el algoritmo especificado. De lo contrario, el valor se establece en false (cuando el blob está sin cifrar o si solo se cifran partes de los metadatos de blob o aplicación).
lastAccessed	Valor de fecha y hora UTC generado por el servicio que indica la hora en la que el blob se leyó por última vez o se escribió en
lastModified	Devuelve la fecha y hora en que se modificó por última vez el contenedor. Cualquier operación que modifique el blob, incluida una actualización de los metadatos o las propiedades del blob, cambia la hora de la última modificación del blob.
leaseDuration	Cuando se concede un blob, especifica si la concesión es de duración infinita o fija.
leaseState	Estado de concesión del blob.
leaseStatus	El estado de concesión actual del blob.
legalHold	Indica si hay una suspensión legal en el blob.
metadata
objectReplicationPolicyId	Opcional. Solo es válido cuando la replicación de objetos está habilitada para el contenedor de almacenamiento y en el blob de destino de la replicación.
objectReplicationRules	Opcional. Solo es válido cuando la replicación de objetos está habilitada para el contenedor de almacenamiento y en el blob de origen de la replicación. Al recuperar este encabezado, devolverá el encabezado con el identificador de directiva y el identificador de regla (por ejemplo, x-ms-or-policyid_ruleid) y el valor será el estado de la replicación (por ejemplo, completado, con errores).
requestId	Este encabezado identifica de forma única la solicitud que se realizó y se puede utilizar para solucionar problemas relacionados con esta.
tagCount	Número de etiquetas asociadas al blob
version	Indica la versión del servicio Blob utilizado para ejecutar la solicitud. Este encabezado se devuelve para las solicitudes realizadas en la versión 2009-09-19 y versiones posteriores.
versionId	Valor DateTime devuelto por el servicio que identifica de forma única el blob. El valor de este encabezado indica la versión del blob y se puede usar en solicitudes posteriores para acceder a esta versión del blob.

Detalles de las propiedades

acceptRanges

Indica que el servicio admite solicitudes de contenido parcial de blobs.

acceptRanges?: string

Valor de propiedad

string

blobCommittedBlockCount

Número de bloques confirmados presentes en el blob. Este encabezado solo se devuelve para blobs en anexos.

blobCommittedBlockCount?: number

Valor de propiedad

number

blobContentMD5

Si el blob tiene un hash MD5 y si la solicitud contiene el encabezado de intervalo (Range o x-ms-range), este encabezado de respuesta se devuelve con el valor del valor MD5 de todo el blob. Este valor puede ser o no igual que el valor devuelto en el encabezado Content-MD5, con el último calculado a partir del intervalo solicitado.

blobContentMD5?: Uint8Array

Valor de propiedad

Uint8Array

blobSequenceNumber

El número de secuencia actual de un blob en páginas. Este encabezado no se devuelve para blobs en bloques o blobs en anexos.

blobSequenceNumber?: number

Valor de propiedad

number

blobType

Tipo del blob.

blobType?: BlobType

Valor de propiedad

BlobType

cacheControl

Se devuelve este encabezado si se especificó previamente para el blob.

cacheControl?: string

Valor de propiedad

string

clientRequestId

Si se envía un encabezado de identificador de solicitud de cliente en la solicitud, este encabezado estará presente en la respuesta con el mismo valor.

clientRequestId?: string

Valor de propiedad

string

contentCrc64

Si la solicitud es leer un intervalo especificado y x-ms-range-get-content-crc64 se establece en true, la solicitud devuelve un crc64 para el rango, siempre y cuando el tamaño del intervalo sea menor o igual que 4 MB. Si se especifican x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 en la misma solicitud, se producirá un error 400(Solicitud incorrecta).

contentCrc64?: Uint8Array

Valor de propiedad

Uint8Array

contentDisposition

Este encabezado devuelve el valor especificado para el encabezado "x-ms-blob-content-disposition". El campo encabezado de respuesta Content-Disposition transmite información adicional sobre cómo procesar la carga de respuesta y también se puede usar para adjuntar metadatos adicionales. Por ejemplo, si se establece en datos adjuntos, indica que el agente de usuario no debe mostrar la respuesta, sino que, en su lugar, muestra un cuadro de diálogo Guardar como con un nombre de archivo distinto del nombre de blob especificado.

contentDisposition?: string

Valor de propiedad

string

contentEncoding

Este encabezado devuelve el valor especificado para el encabezado de solicitud Content-Encoding.

contentEncoding?: string

Valor de propiedad

string

contentLanguage

Este encabezado devuelve el valor especificado para el encabezado de solicitud Content-Language.

contentLanguage?: string

Valor de propiedad

string

contentLength

El número de bytes presentes en el cuerpo de respuesta.

contentLength?: number

Valor de propiedad

number

contentMD5

Si el blob tiene un hash MD5 y esta operación es leer el blob completo, se devuelve este encabezado de respuesta para que el cliente pueda comprobar la integridad del contenido del mensaje.

contentMD5?: Uint8Array

Valor de propiedad

Uint8Array

contentRange

Indica el intervalo de bytes devuelto en caso de que el cliente solicitó un subconjunto del blob estableciendo el encabezado de solicitud "Range".

contentRange?: string

Valor de propiedad

string

contentType

Tipo de medio del cuerpo de la respuesta. Para Descargar blob, se trata de "application/octet-stream".

contentType?: string

Valor de propiedad

string

copyCompletedOn

Hora de conclusión del último intento de copia de blob donde este blob era el blob de destino. Este valor puede especificar la hora de un intento de copia completado, anulado o con errores. Este encabezado no aparece si hay una copia pendiente, si este blob nunca ha sido el destino en una operación Copiar blob, o si este blob se ha modificado después de una operación de copia de blob finalizada mediante Establecer propiedades de blob, Put Blob o Put Block List.

copyCompletedOn?: Date

Valor de propiedad

Date

copyId

Identificador de cadena para esta operación de copia. Use con Get Blob Properties (Obtener propiedades de blob) para comprobar el estado de esta operación de copia o pase a Abort Copy Blob (Anular el blob de copia) para anular una copia pendiente.

copyId?: string

Valor de propiedad

string

copyProgress

Contiene el número de bytes copiados y el total de bytes del origen en la última operación copy blob en la que este blob era el blob de destino. Puede mostrar entre 0 y bytes de longitud de contenido copiados. Este encabezado no aparece si este blob nunca ha sido el destino en una operación copiar blob, o si este blob se ha modificado después de una operación de copia de blob finalizada mediante Establecer propiedades de blob, Put Blob o Put Block List

copyProgress?: string

Valor de propiedad

string

copySource

Dirección URL de hasta 2 KB de longitud que especifica el blob o archivo de origen usado en la última operación copy blob donde este blob era el blob de destino. Este encabezado no aparece si este blob nunca ha sido el destino en una operación copiar blob, o si este blob se ha modificado después de una operación de copia de blob finalizada mediante Establecer propiedades de blob, Put Blob o Put Block List.

copySource?: string

Valor de propiedad

string

copyStatus

Estado de la operación de copia identificada por x-ms-copy-id.

copyStatus?: CopyStatusType

Valor de propiedad

CopyStatusType

copyStatusDescription

Solo aparece cuando x-ms-copy-status se produce un error o está pendiente. Describe la causa del último error recuperable o irrecuperable que se ha producido en la operación de copia. Este encabezado no aparece si este blob nunca ha sido el destino en una operación copiar blob, o si este blob se ha modificado después de una operación de copia de blob finalizada mediante Establecer propiedades de blob, Put Blob o Put Block List

copyStatusDescription?: string

Valor de propiedad

string

createdOn

Devuelve la fecha y hora en que se creó el blob.

createdOn?: Date

Valor de propiedad

Date

date

Valor de fecha y hora UTC generado por el servicio que indica la hora a la que se inició la respuesta

date?: Date

Valor de propiedad

Date

encryptionKeySha256

Hash SHA-256 de la clave de cifrado que se usa para cifrar el blob. Este encabezado solo se devuelve cuando el blob se cifró con una clave proporcionada por el cliente.

encryptionKeySha256?: string

Valor de propiedad

string

encryptionScope

Devuelve el nombre del ámbito de cifrado utilizado para cifrar el contenido del blob y los metadatos de la aplicación. Tenga en cuenta que la ausencia de este encabezado implica el uso del ámbito de cifrado de cuenta predeterminado.

encryptionScope?: string

Valor de propiedad

string

errorCode

Código de error

errorCode?: string

Valor de propiedad

string

etag

La ETag contiene un valor que se puede utilizar para realizar operaciones condicionales. Si la versión de la solicitud es 2011-08-18 o una más reciente, el valor ETag estará entre comillas.

etag?: string

Valor de propiedad

string

immutabilityPolicyExpiresOn

Valor de fecha y hora UTC generado por el servicio que indica la hora a la que expirará la directiva de inmutabilidad del blob.

immutabilityPolicyExpiresOn?: Date

Valor de propiedad

Date

immutabilityPolicyMode

Indica el modo de directiva de inmutabilidad.

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Valor de propiedad

BlobImmutabilityPolicyMode

isCurrentVersion

El valor de este encabezado indica si la versión de este blob es una versión actual, consulte también el encabezado x-ms-version-id.

isCurrentVersion?: boolean

Valor de propiedad

boolean

isSealed

Si este blob se ha sellado

isSealed?: boolean

Valor de propiedad

boolean

isServerEncrypted

El valor de este encabezado se establece en true si los datos de blob y los metadatos de la aplicación se cifran completamente mediante el algoritmo especificado. De lo contrario, el valor se establece en false (cuando el blob está sin cifrar o si solo se cifran partes de los metadatos de blob o aplicación).

isServerEncrypted?: boolean

Valor de propiedad

boolean

lastAccessed

Valor de fecha y hora UTC generado por el servicio que indica la hora en la que el blob se leyó por última vez o se escribió en

lastAccessed?: Date

Valor de propiedad

Date

lastModified

Devuelve la fecha y hora en que se modificó por última vez el contenedor. Cualquier operación que modifique el blob, incluida una actualización de los metadatos o las propiedades del blob, cambia la hora de la última modificación del blob.

lastModified?: Date

Valor de propiedad

Date

leaseDuration

Cuando se concede un blob, especifica si la concesión es de duración infinita o fija.

leaseDuration?: LeaseDurationType

Valor de propiedad

LeaseDurationType

leaseState

Estado de concesión del blob.

leaseState?: LeaseStateType

Valor de propiedad

LeaseStateType

leaseStatus

El estado de concesión actual del blob.

leaseStatus?: LeaseStatusType

Valor de propiedad

LeaseStatusType

legalHold

Indica si hay una suspensión legal en el blob.

legalHold?: boolean

Valor de propiedad

boolean

metadata

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

Valor de propiedad

{[propertyName: string]: string}

objectReplicationPolicyId

Opcional. Solo es válido cuando la replicación de objetos está habilitada para el contenedor de almacenamiento y en el blob de destino de la replicación.

objectReplicationPolicyId?: string

Valor de propiedad

string

objectReplicationRules

Opcional. Solo es válido cuando la replicación de objetos está habilitada para el contenedor de almacenamiento y en el blob de origen de la replicación. Al recuperar este encabezado, devolverá el encabezado con el identificador de directiva y el identificador de regla (por ejemplo, x-ms-or-policyid_ruleid) y el valor será el estado de la replicación (por ejemplo, completado, con errores).

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

Valor de propiedad

{[propertyName: string]: string}

requestId

Este encabezado identifica de forma única la solicitud que se realizó y se puede utilizar para solucionar problemas relacionados con esta.

requestId?: string

Valor de propiedad

string

tagCount

Número de etiquetas asociadas al blob

tagCount?: number

Valor de propiedad

number

version

Indica la versión del servicio Blob utilizado para ejecutar la solicitud. Este encabezado se devuelve para las solicitudes realizadas en la versión 2009-09-19 y versiones posteriores.

version?: string

Valor de propiedad

string

versionId

Valor DateTime devuelto por el servicio que identifica de forma única el blob. El valor de este encabezado indica la versión del blob y se puede usar en solicitudes posteriores para acceder a esta versión del blob.

versionId?: string

Valor de propiedad

string