BlobGetPropertiesHeaders interface

Pacote:

@azure/storage-blob

Define cabeçalhos para Blob_getProperties operação.

Propriedades

acceptRanges	Indica se o serviço oferece suporte a solicitações de conteúdo de blob parcial.
accessTier	A camada de blob de páginas em uma conta de armazenamento premium ou camada de blob de blocos em contas LRS de armazenamento de blobs. Para obter uma lista de camadas de blob de páginas premium permitidas, consulte https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. Para contas LRS de armazenamento de blobs, os valores válidos são Hot/Cool/Archive.
accessTierChangedOn	A hora em que a camada foi alterada no objeto . Isso só será retornado se a camada no blob de blocos tiver sido definida.
accessTierInferred	Somente para blobs de páginas em uma conta de armazenamento Premium. Se a camada de acesso não estiver definida explicitamente no blob, a camada será inferida com base em seu comprimento de conteúdo e esse cabeçalho será retornado com valor verdadeiro.
archiveStatus	Para contas LRS de armazenamento de blobs, os valores válidos são reidratar-pending-to-hot/rehydrate-pending-to-cool. Se o blob estiver sendo reidratado e não estiver concluído, esse cabeçalho será retornado indicando que a reidratação está pendente e também informa a camada de destino.
blobCommittedBlockCount	O número de blocos confirmados presentes no blob. Esse cabeçalho é retornado somente para blobs de acréscimo.
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 do cliente for enviado na solicitação, esse cabeçalho estará presente na resposta com o mesmo valor.
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 agente do usuário não deve exibir a resposta, mas, em vez disso, mostra 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 tamanho do blob em bytes. Para um blob de páginas, esse cabeçalho retorna o valor do cabeçalho x-ms-blob-content-length armazenado com o blob.
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.
contentType	O tipo de conteúdo especificado para o blob. O tipo de conteúdo padrão é 'application/octet-stream'
copyCompletedOn	Hora de conclusão da última tentativa de operação 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 será exibido 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 do 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 verificar 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 copiar blob em que esse blob era o blob de destino. 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.
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
destinationSnapshot	Incluído se o blob for blob de cópia incremental ou instantâneo de cópia incremental, se x-ms-copy-status for bem-sucedido. Hora do instantâneo do último instantâneo de cópia incremental bem-sucedido para esse blob.
encryptionKeySha256	O hash SHA-256 da chave de criptografia usada para criptografar os metadados. Esse cabeçalho só é retornado quando os metadados foram criptografados 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 no 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.
expiresOn	A hora em que esse blob expirará.
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 x-ms-version-id header.
isIncrementalCopy	Incluído se o blob for um blob de cópia incremental.
isSealed	Se esse blob tiver sido lacrado
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 for descriptografado 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 blob 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ído, com falha).
rehydratePriority	Se um objeto estiver no estado pendente de reidração, esse cabeçalho será retornado com prioridade de reidratar.
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

accessTier

A camada de blob de páginas em uma conta de armazenamento premium ou camada de blob de blocos em contas LRS de armazenamento de blobs. Para obter uma lista de camadas de blob de páginas premium permitidas, consulte https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. Para contas LRS de armazenamento de blobs, os valores válidos são Hot/Cool/Archive.

accessTier?: string

Valor da propriedade

string

accessTierChangedOn

A hora em que a camada foi alterada no objeto . Isso só será retornado se a camada no blob de blocos tiver sido definida.

accessTierChangedOn?: Date

Valor da propriedade

Date

accessTierInferred

Somente para blobs de páginas em uma conta de armazenamento Premium. Se a camada de acesso não estiver definida explicitamente no blob, a camada será inferida com base em seu comprimento de conteúdo e esse cabeçalho será retornado com valor verdadeiro.

accessTierInferred?: boolean

Valor da propriedade

boolean

archiveStatus

Para contas LRS de armazenamento de blobs, os valores válidos são reidratar-pending-to-hot/rehydrate-pending-to-cool. Se o blob estiver sendo reidratado e não estiver concluído, esse cabeçalho será retornado indicando que a reidratação está pendente e também informa a camada de destino.

archiveStatus?: 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

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 do cliente for enviado na solicitação, esse cabeçalho estará presente na resposta com o mesmo valor.

clientRequestId?: string

Valor da propriedade

string

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 agente do usuário não deve exibir a resposta, mas, em vez disso, mostra 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 tamanho do blob em bytes. Para um blob de páginas, esse cabeçalho retorna o valor do cabeçalho x-ms-blob-content-length armazenado com o blob.

contentLength?: number

Valor da 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 da propriedade

Uint8Array

contentType

O tipo de conteúdo especificado para o blob. O tipo de conteúdo padrão é 'application/octet-stream'

contentType?: string

Valor da propriedade

string

copyCompletedOn

Hora de conclusão da última tentativa de operação 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 será exibido 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 do 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 verificar 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 copiar blob em que esse blob era o blob de destino. 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?: 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

destinationSnapshot

Incluído se o blob for blob de cópia incremental ou instantâneo de cópia incremental, se x-ms-copy-status for bem-sucedido. Hora do instantâneo do último instantâneo de cópia incremental bem-sucedido para esse blob.

destinationSnapshot?: string

Valor da propriedade

string

encryptionKeySha256

O hash SHA-256 da chave de criptografia usada para criptografar os metadados. Esse cabeçalho só é retornado quando os metadados foram criptografados 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 no 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

expiresOn

A hora em que esse blob expirará.

expiresOn?: Date

Valor da propriedade

Date

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 x-ms-version-id header.

isCurrentVersion?: boolean

Valor da propriedade

boolean

isIncrementalCopy

Incluído se o blob for um blob de cópia incremental.

isIncrementalCopy?: boolean

Valor da propriedade

boolean

isSealed

Se esse blob tiver sido lacrado

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 for descriptografado 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 blob 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ído, com falha).

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

Valor da propriedade

{[propertyName: string]: string}

rehydratePriority

Se um objeto estiver no estado pendente de reidração, esse cabeçalho será retornado com prioridade de reidratar.

rehydratePriority?: RehydratePriority

Valor da propriedade

RehydratePriority

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