BlobDownloadHeaders interface

Pacote:

@azure/storage-blob

Define cabeçalhos para Blob_download operação.

Propriedades

acceptRanges	Indica se o serviço oferece suporte a solicitações de conteúdo de blob parcial.
blobCommittedBlockCount	O número de blocos confirmados presentes no blob. Esse cabeçalho é retornado somente para blobs de acréscimo.
blobContentMD5	Se o blob tiver um hash MD5 e se a solicitação contiver o cabeçalho de intervalo (Intervalo ou x-ms-range), esse cabeçalho de resposta será retornado com o valor do valor MD5 do blob inteiro. Esse valor pode ou não ser igual ao valor retornado no cabeçalho Content-MD5, com o último calculado do intervalo solicitado
blobSequenceNumber	O número de sequência atual de um blob de páginas. Esse cabeçalho não é retornado para blobs de blocos ou blobs de acréscimo
blobType	O tipo do blob.
cacheControl	Esse cabeçalho será retornado, caso tenha sido especificado antes para o blob.
clientRequestId	Se um cabeçalho de ID de solicitação de cliente for enviado na solicitação, esse cabeçalho estará presente na resposta com o mesmo valor.
contentCrc64	Se a solicitação for para ler um intervalo especificado e o x-ms-range-get-content-crc64 for definido como true, a solicitação retornará um crc64 para o intervalo, desde que o tamanho do intervalo seja menor ou igual a 4 MB. Se x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 for especificado na mesma solicitação, ele falhará com 400(Solicitação Incorreta).
contentDisposition	Esse cabeçalho retorna o valor especificado para o cabeçalho 'x-ms-blob-content-disposition'. O campo cabeçalho de resposta Content-Disposition transmite informações adicionais sobre como processar o conteúdo da resposta e também pode ser usado para anexar metadados adicionais. Por exemplo, se definido como anexo, indica que o usuário-agente não deve exibir a resposta, mas, em vez disso, mostrar uma caixa de diálogo Salvar como com um nome de arquivo diferente do nome do blob especificado.
contentEncoding	Esse cabeçalho retorna o valor especificado para o cabeçalho de solicitação Content-Encoding
contentLanguage	Esse cabeçalho retorna o valor especificado para o cabeçalho de solicitação Content-Language.
contentLength	O número de bytes presentes no corpo da resposta.
contentMD5	Se o blob tiver um hash MD5 e essa operação for ler o blob completo, esse cabeçalho de resposta será retornado para que o cliente possa marcar para integridade do conteúdo da mensagem.
contentRange	Indica o intervalo de bytes retornado no caso de o cliente solicitar um subconjunto do blob definindo o cabeçalho de solicitação 'Range'.
contentType	O tipo de mídia do corpo da resposta. Para Baixar Blob, isso é 'application/octet-stream'
copyCompletedOn	Hora de conclusão da última tentativa de operação de Copiar Blob em que esse blob era o blob de destino. Esse valor pode especificar a hora de uma tentativa de cópia concluída, cancelada o com falha. Esse cabeçalho não aparecerá se uma cópia estiver pendente, se esse blob nunca tiver sido o destino em uma operação Copiar Blob ou se esse blob tiver sido modificado após uma operação de Copiar Blob concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Blocos.
copyId	Identificador de cadeia de caracteres para essa operação de cópia. Use com Obter Propriedades de Blob para marcar o status desta operação de cópia ou passe para Anular Copiar Blob para anular uma cópia pendente.
copyProgress	Contém o número de bytes copiados e o total de bytes na origem na última tentativa de operação copiar blob em que esse blob era o blob de destino. Pode mostrar entre 0 e bytes de comprimento de conteúdo copiados. Esse cabeçalho não será exibido se esse blob nunca tiver sido o destino em uma operação copiar blob ou se esse blob tiver sido modificado após uma operação de Copiar Blob concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Blocos
copySource	URL de até 2 KB de comprimento que especifica o blob ou arquivo de origem usado na última tentativa de operação de Copiar Blob em que esse blob era o blob de destino. Esse cabeçalho não aparecerá se esse blob nunca tiver sido o destino em uma operação de Copiar Blob ou se esse blob tiver sido modificado após uma operação de Copiar Blob concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Blocos.
copyStatus	Estado da operação de cópia identificada por x-ms-copy-id.
copyStatusDescription	Só aparece quando x-ms-copy-status está com falha ou pendente. Descreve a causa da última falha fatal ou não fatal da operação de cópia. Esse cabeçalho não será exibido se esse blob nunca tiver sido o destino em uma operação copiar blob ou se esse blob tiver sido modificado após uma operação de Copiar Blob concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Blocos
createdOn	Retorna a data e a hora em que o blob foi criado.
date	Valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada
encryptionKeySha256	O hash SHA-256 da chave de criptografia usada para criptografar o blob. Esse cabeçalho só é retornado quando o blob foi criptografado com uma chave fornecida pelo cliente.
encryptionScope	Retorna o nome do escopo de criptografia usado para criptografar o conteúdo do blob e os metadados do aplicativo. Observe que a ausência desse cabeçalho implica o uso do escopo de criptografia de conta padrão.
errorCode	Código do Erro
etag	A ETag contém um valor que você pode usar para executar operações de forma condicional. Se a versão da solicitação for a 2011-08-18 ou mais recente, o valor de ETag será exibido entre aspas.
immutabilityPolicyExpiresOn	Valor de data/hora UTC gerado pelo serviço que indica a hora em que a política de imutabilidade do blob expirará.
immutabilityPolicyMode	Indica o modo de política de imutabilidade.
isCurrentVersion	O valor desse cabeçalho indica se a versão desse blob é uma versão atual, consulte também cabeçalho x-ms-version-id.
isSealed	Se esse blob tiver sido selado
isServerEncrypted	O valor desse cabeçalho será definido como true se os dados de blob e os metadados do aplicativo forem completamente criptografados usando o algoritmo especificado. Caso contrário, o valor será definido como false (quando o blob não for criptografado ou se apenas partes dos metadados de blob/aplicativo forem criptografadas).
lastAccessed	Valor de data/hora UTC gerado pelo serviço que indica a hora em que o blob foi lido ou gravado pela última vez
lastModified	Retorna a data e a hora em que o contêiner foi modificado pela última vez. Qualquer operação que modificar o blob, incluindo uma atualização dos metadados ou das propriedades do blob, alterará a hora da última modificação do blob.
leaseDuration	Quando um blob é concedido, especifica se a concessão tem duração infinita ou fixa.
leaseState	Estado da concessão do blob.
leaseStatus	O status da concessão atual do blob.
legalHold	Indica se uma retenção legal está presente no blob.
metadata
objectReplicationPolicyId	Opcional. Válido somente quando a Replicação de Objeto está habilitada para o contêiner de armazenamento e no blob de destino da replicação.
objectReplicationRules	Opcional. Válido somente quando a Replicação de Objeto está habilitada para o contêiner de armazenamento e no blob de origem da replicação. Ao recuperar esse cabeçalho, ele retornará o cabeçalho com a ID da política e a ID da regra (por exemplo, x-ms-or-policyid_ruleid) e o valor será o status da replicação (por exemplo, concluída, com falha).
requestId	Esse cabeçalho identifica a solicitação que foi feita de forma exclusiva e pode ser usado para solucionar problemas na solicitação.
tagCount	O número de marcas associadas ao blob
version	Indica a versão do serviço Blob usado para executar a solicitação. Esse cabeçalho é retornado para solicitações feitas na versão 2009-09-19 e mais recentes.
versionId	Um valor DateTime retornado pelo serviço que identifica exclusivamente o blob. O valor desse cabeçalho indica a versão do blob e pode ser usado em solicitações subsequentes para acessar essa versão do blob.

Detalhes da propriedade

acceptRanges

Indica se o serviço oferece suporte a solicitações de conteúdo de blob parcial.

acceptRanges?: string

Valor da propriedade

string

blobCommittedBlockCount

O número de blocos confirmados presentes no blob. Esse cabeçalho é retornado somente para blobs de acréscimo.

blobCommittedBlockCount?: number

Valor da propriedade

number

blobContentMD5

Se o blob tiver um hash MD5 e se a solicitação contiver o cabeçalho de intervalo (Intervalo ou x-ms-range), esse cabeçalho de resposta será retornado com o valor do valor MD5 do blob inteiro. Esse valor pode ou não ser igual ao valor retornado no cabeçalho Content-MD5, com o último calculado do intervalo solicitado

blobContentMD5?: Uint8Array

Valor da propriedade

Uint8Array

blobSequenceNumber

O número de sequência atual de um blob de páginas. Esse cabeçalho não é retornado para blobs de blocos ou blobs de acréscimo

blobSequenceNumber?: number

Valor da propriedade

number

blobType

O tipo do blob.

blobType?: BlobType

Valor da propriedade

BlobType

cacheControl

Esse cabeçalho será retornado, caso tenha sido especificado antes para o blob.

cacheControl?: string

Valor da propriedade

string

clientRequestId

Se um cabeçalho de ID de solicitação de cliente for enviado na solicitação, esse cabeçalho estará presente na resposta com o mesmo valor.

clientRequestId?: string

Valor da propriedade

string

contentCrc64

Se a solicitação for para ler um intervalo especificado e o x-ms-range-get-content-crc64 for definido como true, a solicitação retornará um crc64 para o intervalo, desde que o tamanho do intervalo seja menor ou igual a 4 MB. Se x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 for especificado na mesma solicitação, ele falhará com 400(Solicitação Incorreta).

contentCrc64?: Uint8Array

Valor da propriedade

Uint8Array

contentDisposition

Esse cabeçalho retorna o valor especificado para o cabeçalho 'x-ms-blob-content-disposition'. O campo cabeçalho de resposta Content-Disposition transmite informações adicionais sobre como processar o conteúdo da resposta e também pode ser usado para anexar metadados adicionais. Por exemplo, se definido como anexo, indica que o usuário-agente não deve exibir a resposta, mas, em vez disso, mostrar uma caixa de diálogo Salvar como com um nome de arquivo diferente do nome do blob especificado.

contentDisposition?: string

Valor da propriedade

string

contentEncoding

Esse cabeçalho retorna o valor especificado para o cabeçalho de solicitação Content-Encoding

contentEncoding?: string

Valor da propriedade

string

contentLanguage

Esse cabeçalho retorna o valor especificado para o cabeçalho de solicitação Content-Language.

contentLanguage?: string

Valor da propriedade

string

contentLength

O número de bytes presentes no corpo da resposta.

contentLength?: number

Valor da propriedade

number

contentMD5

Se o blob tiver um hash MD5 e essa operação for ler o blob completo, esse cabeçalho de resposta será retornado para que o cliente possa marcar para integridade do conteúdo da mensagem.

contentMD5?: Uint8Array

Valor da propriedade

Uint8Array

contentRange

Indica o intervalo de bytes retornado no caso de o cliente solicitar um subconjunto do blob definindo o cabeçalho de solicitação 'Range'.

contentRange?: string

Valor da propriedade

string

contentType

O tipo de mídia do corpo da resposta. Para Baixar Blob, isso é 'application/octet-stream'

contentType?: string

Valor da propriedade

string

copyCompletedOn

Hora de conclusão da última tentativa de operação de Copiar Blob em que esse blob era o blob de destino. Esse valor pode especificar a hora de uma tentativa de cópia concluída, cancelada o com falha. Esse cabeçalho não aparecerá se uma cópia estiver pendente, se esse blob nunca tiver sido o destino em uma operação Copiar Blob ou se esse blob tiver sido modificado após uma operação de Copiar Blob concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Blocos.

copyCompletedOn?: Date

Valor da propriedade

Date

copyId

Identificador de cadeia de caracteres para essa operação de cópia. Use com Obter Propriedades de Blob para marcar o status desta operação de cópia ou passe para Anular Copiar Blob para anular uma cópia pendente.

copyId?: string

Valor da propriedade

string

copyProgress

Contém o número de bytes copiados e o total de bytes na origem na última tentativa de operação copiar blob em que esse blob era o blob de destino. Pode mostrar entre 0 e bytes de comprimento de conteúdo copiados. Esse cabeçalho não será exibido se esse blob nunca tiver sido o destino em uma operação copiar blob ou se esse blob tiver sido modificado após uma operação de Copiar Blob concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Blocos

copyProgress?: string

Valor da propriedade

string

copySource

URL de até 2 KB de comprimento que especifica o blob ou arquivo de origem usado na última tentativa de operação de Copiar Blob em que esse blob era o blob de destino. Esse cabeçalho não aparecerá se esse blob nunca tiver sido o destino em uma operação de Copiar Blob ou se esse blob tiver sido modificado após uma operação de Copiar Blob concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Blocos.

copySource?: string

Valor da propriedade

string

copyStatus

Estado da operação de cópia identificada por x-ms-copy-id.

copyStatus?: CopyStatusType

Valor da propriedade

CopyStatusType

copyStatusDescription

Só aparece quando x-ms-copy-status está com falha ou pendente. Descreve a causa da última falha fatal ou não fatal da operação de cópia. Esse cabeçalho não será exibido se esse blob nunca tiver sido o destino em uma operação copiar blob ou se esse blob tiver sido modificado após uma operação de Copiar Blob concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Blocos

copyStatusDescription?: string

Valor da propriedade

string

createdOn

Retorna a data e a hora em que o blob foi criado.

createdOn?: Date

Valor da propriedade

Date

date

Valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada

date?: Date

Valor da propriedade

Date

encryptionKeySha256

O hash SHA-256 da chave de criptografia usada para criptografar o blob. Esse cabeçalho só é retornado quando o blob foi criptografado com uma chave fornecida pelo cliente.

encryptionKeySha256?: string

Valor da propriedade

string

encryptionScope

Retorna o nome do escopo de criptografia usado para criptografar o conteúdo do blob e os metadados do aplicativo. Observe que a ausência desse cabeçalho implica o uso do escopo de criptografia de conta padrão.

encryptionScope?: string

Valor da propriedade

string

errorCode

Código do Erro

errorCode?: string

Valor da propriedade

string

etag

A ETag contém um valor que você pode usar para executar operações de forma condicional. Se a versão da solicitação for a 2011-08-18 ou mais recente, o valor de ETag será exibido entre aspas.

etag?: string

Valor da propriedade

string

immutabilityPolicyExpiresOn

Valor de data/hora UTC gerado pelo serviço que indica a hora em que a política de imutabilidade do blob expirará.

immutabilityPolicyExpiresOn?: Date

Valor da propriedade

Date

immutabilityPolicyMode

Indica o modo de política de imutabilidade.

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Valor da propriedade

BlobImmutabilityPolicyMode

isCurrentVersion

O valor desse cabeçalho indica se a versão desse blob é uma versão atual, consulte também cabeçalho x-ms-version-id.

isCurrentVersion?: boolean

Valor da propriedade

boolean

isSealed

Se esse blob tiver sido selado

isSealed?: boolean

Valor da propriedade

boolean

isServerEncrypted

O valor desse cabeçalho será definido como true se os dados de blob e os metadados do aplicativo forem completamente criptografados usando o algoritmo especificado. Caso contrário, o valor será definido como false (quando o blob não for criptografado ou se apenas partes dos metadados de blob/aplicativo forem criptografadas).

isServerEncrypted?: boolean

Valor da propriedade

boolean

lastAccessed

Valor de data/hora UTC gerado pelo serviço que indica a hora em que o blob foi lido ou gravado pela última vez

lastAccessed?: Date

Valor da propriedade

Date

lastModified

Retorna a data e a hora em que o contêiner foi modificado pela última vez. Qualquer operação que modificar o blob, incluindo uma atualização dos metadados ou das propriedades do blob, alterará a hora da última modificação do blob.

lastModified?: Date

Valor da propriedade

Date

leaseDuration

Quando um blob é concedido, especifica se a concessão tem duração infinita ou fixa.

leaseDuration?: LeaseDurationType

Valor da propriedade

LeaseDurationType

leaseState

Estado da concessão do blob.

leaseState?: LeaseStateType

Valor da propriedade

LeaseStateType

leaseStatus

O status da concessão atual do blob.

leaseStatus?: LeaseStatusType

Valor da propriedade

LeaseStatusType

legalHold

Indica se uma retenção legal está presente no blob.

legalHold?: boolean

Valor da propriedade

boolean

metadata

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

Valor da propriedade

{[propertyName: string]: string}

objectReplicationPolicyId

Opcional. Válido somente quando a Replicação de Objeto está habilitada para o contêiner de armazenamento e no blob de destino da replicação.

objectReplicationPolicyId?: string

Valor da propriedade

string

objectReplicationRules

Opcional. Válido somente quando a Replicação de Objeto está habilitada para o contêiner de armazenamento e no blob de origem da replicação. Ao recuperar esse cabeçalho, ele retornará o cabeçalho com a ID da política e a ID da regra (por exemplo, x-ms-or-policyid_ruleid) e o valor será o status da replicação (por exemplo, concluída, com falha).

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

Valor da propriedade

{[propertyName: string]: string}

requestId

Esse cabeçalho identifica a solicitação que foi feita de forma exclusiva e pode ser usado para solucionar problemas na solicitação.

requestId?: string

Valor da propriedade

string

tagCount

O número de marcas associadas ao blob

tagCount?: number

Valor da propriedade

number

version

Indica a versão do serviço Blob usado para executar a solicitação. Esse cabeçalho é retornado para solicitações feitas na versão 2009-09-19 e mais recentes.

version?: string

Valor da propriedade

string

versionId

Um valor DateTime retornado pelo serviço que identifica exclusivamente o blob. O valor desse cabeçalho indica a versão do blob e pode ser usado em solicitações subsequentes para acessar essa versão do blob.

versionId?: string

Valor da propriedade

string