BlobDownloadHeaders interface

Pacote:

@azure/storage-blob

Define cabeçalhos para Blob_download operação.

Propriedades

acceptRanges	Indica que 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 cabeçalho de intervalo (Range ou x-ms-range), esse cabeçalho de resposta será retornado com o valor de MD5 de todo o blob. Esse valor pode ou não ser igual ao valor retornado no cabeçalho Content-MD5, com o último calculado a partir do intervalo solicitado
blobSequenceNumber	O número de sequência atual para um blob de página. Este cabeçalho não é retornado para blobs de bloco ou blobs de acréscimo
blobType	O tipo do blob.
cacheControl	Esse cabeçalho será retornado se tiver sido especificado anteriormente para o blob.
clientRequestId	Se um cabeçalho de id de solicitação do 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 estiver 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 forem especificados na mesma solicitação, ele falhará com 400(Bad Request).
contentDisposition	Esse cabeçalho retorna o valor especificado para o cabeçalho 'x-ms-blob-content-disposition'. O campo de cabeçalho de resposta Content-Disposition transmite informações adicionais sobre como processar a carga útil de resposta e também pode ser usado para anexar metadados adicionais. Por exemplo, se definido como anexo, indica que o agente do usuário não deve exibir a resposta, mas mostrar uma caixa de diálogo Salvar como com um nome de arquivo diferente do nome de blob especificado.
contentEncoding	Esse cabeçalho retorna o valor especificado para o cabeçalho da solicitação Content-Encoding
contentLanguage	Esse cabeçalho retorna o valor especificado para o cabeçalho da 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 para ler o blob completo, esse cabeçalho de resposta será retornado para que o cliente possa verificar a integridade do conteúdo da mensagem.
contentRange	Indica o intervalo de bytes retornados no caso de o cliente solicitar um subconjunto do blob definindo o cabeçalho da solicitação 'Intervalo'.
contentType	O tipo de mídia do corpo da resposta. Para Download Blob este é 'application/octet-stream'
copyCompletedOn	Hora de conclusão da última tentativa de operação de Blob de cópia em que esse blob era o blob de destino. Esse valor pode especificar a hora de uma tentativa de cópia concluída, abortada ou 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 de Blob de Cópia ou se esse blob tiver sido modificado após uma operação de Blob de Cópia concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Bloqueios.
copyId	Identificador de cadeia de caracteres para esta operação de cópia. Use com Obter Propriedades de Blob para verificar o status dessa operação de cópia ou passe para Abortar Blob de Cópia para abortar 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 de Blob de Cópia 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 aparecerá se esse blob nunca tiver sido o destino em uma operação de Blob de Cópia ou se esse blob tiver sido modificado após uma operação de Blob de Cópia concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Bloqueios
copySource	URL de até 2 KB de comprimento que especifica o blob ou arquivo de origem usado na última tentativa de operação de Blob de Cópia 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 Blob de Cópia ou se esse blob tiver sido modificado após uma operação de Blob de Cópia concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Bloqueios.
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 da operação de cópia fatal ou não fatal. Esse cabeçalho não aparecerá se esse blob nunca tiver sido o destino em uma operação de Blob de Cópia ou se esse blob tiver sido modificado após uma operação de Blob de Cópia concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Bloqueios
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 de erro
etag	O ETag contém um valor que você pode usar para executar operações condicionalmente. Se a versão do pedido for 2011-08-18 ou mais recente, o valor ETag estará entre aspas.
immutabilityPolicyExpiresOn	Valor de data/hora UTC gerado pelo serviço que indica a hora em que a política de imutabilidade de blob expirará.
immutabilityPolicyMode	Indica o modo de política de imutabilidade.
isCurrentVersion	O valor deste cabeçalho indica se a versão deste blob é uma versão atual, consulte também o cabeçalho x-ms-version-id.
isSealed	Se este 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 estiver criptografado ou se apenas partes dos metadados 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 modifique o blob, incluindo uma atualização dos metadados ou propriedades do blob, altera a hora da última modificação do blob.
leaseDuration	Quando um blob é alugado, especifica se a concessão é de duração infinita ou fixa.
leaseState	Estado de concessão do blob.
leaseStatus	O status de 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 Objetos estiver 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 Objetos estiver 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, falha).
requestId	Esse cabeçalho identifica exclusivamente a solicitação que foi feita e pode ser usado para solucionar a solicitação.
tagCount	O número de tags associadas ao blob
version	Indica a versão do serviço de Blob usada para executar a solicitação. Este cabeçalho é retornado para solicitações feitas contra a versão 2009-09-19 e superior.
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 de Propriedade

acceptRanges

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

acceptRanges?: string

Valor de 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 de Propriedade

number

blobContentMD5

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

blobContentMD5?: Uint8Array

Valor de Propriedade

Uint8Array

blobSequenceNumber

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

blobSequenceNumber?: number

Valor de Propriedade

number

blobType

O tipo do blob.

blobType?: BlobType

Valor de Propriedade

BlobType

cacheControl

Esse cabeçalho será retornado se tiver sido especificado anteriormente para o blob.

cacheControl?: string

Valor de Propriedade

string

clientRequestId

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

clientRequestId?: string

Valor de Propriedade

string

contentCrc64

Se a solicitação for para ler um intervalo especificado e o x-ms-range-get-content-crc64 estiver 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 forem especificados na mesma solicitação, ele falhará com 400(Bad Request).

contentCrc64?: Uint8Array

Valor de Propriedade

Uint8Array

contentDisposition

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

contentDisposition?: string

Valor de Propriedade

string

contentEncoding

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

contentEncoding?: string

Valor de Propriedade

string

contentLanguage

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

contentLanguage?: string

Valor de Propriedade

string

contentLength

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

contentLength?: number

Valor de Propriedade

number

contentMD5

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

contentMD5?: Uint8Array

Valor de Propriedade

Uint8Array

contentRange

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

contentRange?: string

Valor de Propriedade

string

contentType

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

contentType?: string

Valor de Propriedade

string

copyCompletedOn

Hora de conclusão da última tentativa de operação de Blob de cópia em que esse blob era o blob de destino. Esse valor pode especificar a hora de uma tentativa de cópia concluída, abortada ou 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 de Blob de Cópia ou se esse blob tiver sido modificado após uma operação de Blob de Cópia concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Bloqueios.

copyCompletedOn?: Date

Valor de Propriedade

Date

copyId

Identificador de cadeia de caracteres para esta operação de cópia. Use com Obter Propriedades de Blob para verificar o status dessa operação de cópia ou passe para Abortar Blob de Cópia para abortar uma cópia pendente.

copyId?: string

Valor de Propriedade

string

copyProgress

Contém o número de bytes copiados e o total de bytes na origem na última tentativa de operação de Blob de Cópia 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 aparecerá se esse blob nunca tiver sido o destino em uma operação de Blob de Cópia ou se esse blob tiver sido modificado após uma operação de Blob de Cópia concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Bloqueios

copyProgress?: string

Valor de 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 Blob de Cópia 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 Blob de Cópia ou se esse blob tiver sido modificado após uma operação de Blob de Cópia concluída usando Definir Propriedades de Blob, Colocar Blob ou Colocar Lista de Bloqueios.

copySource?: string

Valor de Propriedade

string

copyStatus

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

copyStatus?: CopyStatusType

Valor de Propriedade

CopyStatusType

copyStatusDescription

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

copyStatusDescription?: string

Valor de Propriedade

string

date

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

date?: Date

Valor de 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 de 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 de Propriedade

string

errorCode

Código de erro

errorCode?: string

Valor de Propriedade

string

etag

O ETag contém um valor que você pode usar para executar operações condicionalmente. Se a versão do pedido for 2011-08-18 ou mais recente, o valor ETag estará entre aspas.

etag?: string

Valor de Propriedade

string

immutabilityPolicyExpiresOn

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

immutabilityPolicyExpiresOn?: Date

Valor de Propriedade

Date

immutabilityPolicyMode

Indica o modo de política de imutabilidade.

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Valor de Propriedade

BlobImmutabilityPolicyMode

isCurrentVersion

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

isCurrentVersion?: boolean

Valor de Propriedade

boolean

isSealed

Se este blob tiver sido selado

isSealed?: boolean

Valor de 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 estiver criptografado ou se apenas partes dos metadados blob/aplicativo forem criptografadas).

isServerEncrypted?: boolean

Valor de 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 de Propriedade

Date

lastModified

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

lastModified?: Date

Valor de Propriedade

Date

leaseDuration

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

leaseDuration?: LeaseDurationType

Valor de Propriedade

LeaseDurationType

leaseState

Estado de concessão do blob.

leaseState?: LeaseStateType

Valor de Propriedade

LeaseStateType

leaseStatus

O status de concessão atual do blob.

leaseStatus?: LeaseStatusType

Valor de Propriedade

LeaseStatusType

legalHold

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

legalHold?: boolean

Valor de Propriedade

boolean

metadata

metadata?: [key: string]: string

Valor de Propriedade

[key: string]: string

objectReplicationPolicyId

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

objectReplicationPolicyId?: string

Valor de Propriedade

string

objectReplicationRules

Opcional. Válido somente quando a Replicação de Objetos estiver 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, falha).

objectReplicationRules?: [key: string]: string

Valor de Propriedade

[key: string]: string

requestId

Esse cabeçalho identifica exclusivamente a solicitação que foi feita e pode ser usado para solucionar a solicitação.

requestId?: string

Valor de Propriedade

string

tagCount

O número de tags associadas ao blob

tagCount?: number

Valor de Propriedade

number

version

Indica a versão do serviço de Blob usada para executar a solicitação. Este cabeçalho é retornado para solicitações feitas contra a versão 2009-09-19 e superior.

version?: string

Valor de 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 de Propriedade

string