Partilhar via

FileGetPropertiesHeaders interface

  • Referência
Pacote:
@azure/storage-file-share

Define cabeçalhos para File_getProperties operação.

Propriedades

cacheControl

Se o cabeçalho Cache-Control pedido tiver sido definido anteriormente para o ficheiro, o valor Cache-Control é devolvido neste cabeçalho.
contentDisposition

Devolve o valor especificado para o cabeçalho "x-ms-content-disposition" e especifica como processar a resposta.
contentEncoding

Se o cabeçalho do pedido Codificação de Conteúdo tiver sido definido anteriormente para o ficheiro, o valor Codificação de Conteúdo é devolvido neste cabeçalho.
contentLanguage

Devolve o valor que foi especificado para o cabeçalho do pedido Idioma de Conteúdo.
contentLength

O tamanho do ficheiro em bytes. Este cabeçalho devolve o valor do cabeçalho "x-ms-content-length" que é armazenado com o ficheiro.
contentMD5

Se o cabeçalho Content-MD5 tiver sido definido para o ficheiro, o cabeçalho de resposta Content-MD5 é devolvido para que o cliente possa verificar a integridade do conteúdo da mensagem.
contentType

O tipo de conteúdo especificado para o ficheiro. O tipo de conteúdo predefinido é "application/octet-stream"
copyCompletedOn

Hora de conclusão da última tentativa de operação Copiar Ficheiro em que este ficheiro era o ficheiro de destino. Este valor pode especificar a hora de uma tentativa de cópia concluída, abortada ou falhada.
copyId

Identificador de cadeia para a última operação do Ficheiro de Cópia tentada em que este ficheiro era o ficheiro de destino.
copyProgress

Contém o número de bytes copiados e o total de bytes na origem na última operação de Tentativa de Copiar Ficheiro em que este ficheiro era o ficheiro de destino. Pode mostrar entre 0 e bytes de Comprimento do Conteúdo copiados.
copySource

URL com até 2KB de comprimento que especifica o ficheiro de origem utilizado na última operação de Tentativa de Copiar Ficheiro em que este ficheiro era o ficheiro de destino.
copyStatus

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

Só é apresentado quando x-ms-copy-status falha ou está pendente. Descreve a causa da falha fatal ou não fatal da operação de cópia.
date

Um valor de data/hora UTC gerado pelo serviço que indica a hora em que a resposta foi iniciada.
errorCode

Código de Erro
etag

A ETag contém um valor que pode utilizar para realizar operações condicionalmente, entre aspas.
fileAttributes

Atributos definidos para o ficheiro.
fileChangeOn

Altere a hora do ficheiro.
fileCreatedOn

Hora de criação do ficheiro.
fileId

O fileId do ficheiro.
fileLastWriteOn

Hora da última escrita do ficheiro.
fileParentId

O fileId principal do ficheiro.
filePermissionKey

Chave do conjunto de permissões do ficheiro.
fileType

Devolve o tipo Ficheiro. Reservado para utilização futura.
isServerEncrypted

O valor deste cabeçalho é definido como verdadeiro se os dados de ficheiro e os metadados da aplicação estiverem completamente encriptados com o algoritmo especificado. Caso contrário, o valor é definido como falso (quando o ficheiro não está encriptado ou se apenas partes dos metadados do ficheiro/aplicação estiverem encriptadas).
lastModified

Devolve a data e hora em que o ficheiro foi modificado pela última vez. O formato de data segue RFC 1123. Qualquer operação que modificou o ficheiro ou as respetivas propriedades atualiza a hora da última modificação.
leaseDuration

Quando um ficheiro é concedido, especifica se a concessão é de duração infinita ou fixa.
leaseState

Estado de concessão do ficheiro.
leaseStatus

O estado de concessão atual do ficheiro.
metadata

Um conjunto de pares nome-valor associados a este ficheiro como metadados definidos pelo utilizador.
requestId

Este cabeçalho identifica exclusivamente o pedido que foi feito e pode ser utilizado para resolver o pedido.
version

Indica a versão do serviço Ficheiro utilizado para executar o pedido.

Detalhes de Propriedade

cacheControl

Se o cabeçalho Cache-Control pedido tiver sido definido anteriormente para o ficheiro, o valor Cache-Control é devolvido neste cabeçalho.

cacheControl?: string

Valor de Propriedade

string

contentDisposition

Devolve o valor especificado para o cabeçalho "x-ms-content-disposition" e especifica como processar a resposta.

contentDisposition?: string

Valor de Propriedade

string

contentEncoding

Se o cabeçalho do pedido Codificação de Conteúdo tiver sido definido anteriormente para o ficheiro, o valor Codificação de Conteúdo é devolvido neste cabeçalho.

contentEncoding?: string

Valor de Propriedade

string

contentLanguage

Devolve o valor que foi especificado para o cabeçalho do pedido Idioma de Conteúdo.

contentLanguage?: string

Valor de Propriedade

string

contentLength

O tamanho do ficheiro em bytes. Este cabeçalho devolve o valor do cabeçalho "x-ms-content-length" que é armazenado com o ficheiro.

contentLength?: number

Valor de Propriedade

number

contentMD5

Se o cabeçalho Content-MD5 tiver sido definido para o ficheiro, o cabeçalho de resposta Content-MD5 é devolvido para que o cliente possa verificar a integridade do conteúdo da mensagem.

contentMD5?: Uint8Array

Valor de Propriedade

Uint8Array

contentType

O tipo de conteúdo especificado para o ficheiro. O tipo de conteúdo predefinido é "application/octet-stream"

contentType?: string

Valor de Propriedade

string

copyCompletedOn

Hora de conclusão da última tentativa de operação Copiar Ficheiro em que este ficheiro era o ficheiro de destino. Este valor pode especificar a hora de uma tentativa de cópia concluída, abortada ou falhada.

copyCompletedOn?: Date

Valor de Propriedade

Date

copyId

Identificador de cadeia para a última operação do Ficheiro de Cópia tentada em que este ficheiro era o ficheiro de destino.

copyId?: string

Valor de Propriedade

string

copyProgress

Contém o número de bytes copiados e o total de bytes na origem na última operação de Tentativa de Copiar Ficheiro em que este ficheiro era o ficheiro de destino. Pode mostrar entre 0 e bytes de Comprimento do Conteúdo copiados.

copyProgress?: string

Valor de Propriedade

string

copySource

URL com até 2KB de comprimento que especifica o ficheiro de origem utilizado na última operação de Tentativa de Copiar Ficheiro em que este ficheiro era o ficheiro de destino.

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ó é apresentado quando x-ms-copy-status falha ou está pendente. Descreve a causa da falha fatal ou não fatal da operação de cópia.

copyStatusDescription?: string

Valor de Propriedade

string

date

Um 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

errorCode

Código de Erro

errorCode?: string

Valor de Propriedade

string

etag

A ETag contém um valor que pode utilizar para realizar operações condicionalmente, entre aspas.

etag?: string

Valor de Propriedade

string

fileAttributes

Atributos definidos para o ficheiro.

fileAttributes?: string

Valor de Propriedade

string

fileChangeOn

Altere a hora do ficheiro.

fileChangeOn?: Date

Valor de Propriedade

Date

fileCreatedOn

Hora de criação do ficheiro.

fileCreatedOn?: Date

Valor de Propriedade

Date

fileId

O fileId do ficheiro.

fileId?: string

Valor de Propriedade

string

fileLastWriteOn

Hora da última escrita do ficheiro.

fileLastWriteOn?: Date

Valor de Propriedade

Date

fileParentId

O fileId principal do ficheiro.

fileParentId?: string

Valor de Propriedade

string

filePermissionKey

Chave do conjunto de permissões do ficheiro.

filePermissionKey?: string

Valor de Propriedade

string

fileType

Devolve o tipo Ficheiro. Reservado para utilização futura.

fileType?: string

Valor de Propriedade

string

isServerEncrypted

O valor deste cabeçalho é definido como verdadeiro se os dados de ficheiro e os metadados da aplicação estiverem completamente encriptados com o algoritmo especificado. Caso contrário, o valor é definido como falso (quando o ficheiro não está encriptado ou se apenas partes dos metadados do ficheiro/aplicação estiverem encriptadas).

isServerEncrypted?: boolean

Valor de Propriedade

boolean

lastModified

Devolve a data e hora em que o ficheiro foi modificado pela última vez. O formato de data segue RFC 1123. Qualquer operação que modificou o ficheiro ou as respetivas propriedades atualiza a hora da última modificação.

lastModified?: Date

Valor de Propriedade

Date

leaseDuration

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

leaseDuration?: LeaseDurationType

Valor de Propriedade

LeaseDurationType

leaseState

Estado de concessão do ficheiro.

leaseState?: LeaseStateType

Valor de Propriedade

LeaseStateType

leaseStatus

O estado de concessão atual do ficheiro.

leaseStatus?: LeaseStatusType

Valor de Propriedade

LeaseStatusType

metadata

Um conjunto de pares nome-valor associados a este ficheiro como metadados definidos pelo utilizador.

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

Valor de Propriedade

{[propertyName: string]: string}

requestId

Este cabeçalho identifica exclusivamente o pedido que foi feito e pode ser utilizado para resolver o pedido.

requestId?: string

Valor de Propriedade

string

version

Indica a versão do serviço Ficheiro utilizado para executar o pedido.

version?: string

Valor de Propriedade

string