Obter Propriedades do Ficheiro

Artigo
03/29/2023

A Get File Properties operação devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o ficheiro. Não devolve o conteúdo do ficheiro.

Disponibilidade do protocolo

Protocolo de partilha de ficheiros ativado	Disponível
SMB
NFS

Pedir

O Get File Properties pedido pode ser construído da seguinte forma. Recomendamos que utilize HTTPS.

Método	URI do pedido	Versão HTTP
`HEAD`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile`	HTTP/1.1
`HEAD`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime>`	HTTP/1.1

Substitua os componentes de caminho que são apresentados no URI do pedido pelo seu, da seguinte forma:

Componente caminho	Description
`myaccount`	O nome da sua conta de armazenamento.
`myshare`	O nome da partilha de ficheiros.
`mydirectorypath`	Opcional. O caminho para o diretório principal.
`myfile`	O nome do ficheiro.

Para obter informações sobre restrições de nomenclatura de caminhos, veja Partilhas de nomes e referências, diretórios, ficheiros e metadados.

Parâmetros URI

Os seguintes parâmetros adicionais podem ser especificados no URI do pedido:

Parâmetro	Description
`sharesnapshot`	Opcional. Versão 2017-04-17 e posterior. O `sharesnapshot` parâmetro é um valor dateTime opaco que, quando presente, especifica o instantâneo de partilha para consultar as propriedades do ficheiro.
`timeout`	Opcional. O `timeout` parâmetro é expresso em segundos. Para obter mais informações, veja Definir tempos limite para operações de Ficheiros do Azure.

Cabeçalhos do pedido

Os cabeçalhos de pedido obrigatórios e opcionais estão descritos na seguinte tabela:

Cabeçalho do pedido	Description
Autorização	Obrigatório. Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure.
`Date` ou `x-ms-date`	Obrigatório. Especifica a Hora Universal Coordenada (UTC) do pedido. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure.
`x-ms-version`	Necessário para todos os pedidos autorizados. Especifica a versão da operação a utilizar para este pedido. Para obter mais informações, veja Controlo de versões dos serviços de Armazenamento do Azure.
`x-ms-lease-id:<ID>`	Opcional. Versão 2019-02-02 e posterior. Se o cabeçalho for especificado, a operação só será efetuada se a concessão do ficheiro estiver atualmente ativa e o ID de concessão especificado no pedido corresponder ao ID de concessão do ficheiro. Se não corresponder, a operação falha com o código de estado 412 (Falha na Pré-condição).
`x-ms-client-request-id`	Opcional. Fornece um valor opaco gerado pelo cliente com um limite de carateres de 1 kibibyte (KiB), que é registado nos registos de análise quando o registo de Análise de Armazenamento do Azure está ativado. Recomendamos vivamente que utilize este cabeçalho quando estiver a correlacionar atividades do lado do cliente com pedidos recebidos pelo servidor. Para obter mais informações, veja Monitorizar Armazenamento de Blobs do Azure.
`x-ms-file-request-intent`	Necessário se o `Authorization` cabeçalho especificar um token OAuth. O valor aceitável é `backup`. Este cabeçalho especifica que o `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action` ou `Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` deve ser concedido se estiverem incluídos na política RBAC atribuída à identidade autorizada com o `Authorization` cabeçalho. Disponível para a versão 2022-11-02 e posterior.
`x-ms-allow-trailing-dot: { <Boolean> }`	Opcional. Versão 2022-11-02 e posterior. O valor booleano especifica se um ponto à direita presente no URL do pedido deve ser cortado ou não. Para obter mais informações, veja Nomenclatura e referência de partilhas, diretórios, ficheiros e metadados.

Corpo do pedido

Nenhum.

Resposta

A resposta inclui um código de estado HTTP e um conjunto de cabeçalhos de resposta.

Código de estado

Uma operação bem-sucedida devolve o código de estado 200 (OK).

Para obter mais informações sobre códigos de estado, veja Códigos de estado e de erro.

Cabeçalhos de resposta

A resposta para esta operação inclui os seguintes cabeçalhos. A resposta também pode incluir cabeçalhos HTTP padrão adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta	Descrição
`Last-Modified`	Devolve a data e hora em que o ficheiro foi modificado pela última vez. O formato de data segue RFC 1123. Para obter mais informações, veja Representar valores de data/hora em cabeçalhos. Qualquer operação que modificou o ficheiro ou as respetivas propriedades atualiza a hora da última modificação.
`x-ms-meta-name:value`	Um conjunto de pares nome-valor que estão associados a este ficheiro como metadados definidos pelo utilizador.
`x-ms-type: <File>`	Devolve o tipo `File`. Reservado para utilização futura.
`Content-Length`	O tamanho do ficheiro em bytes. Este cabeçalho devolve o valor do `x-ms-content-length` cabeçalho armazenado com o ficheiro.
`Content-Type`	O tipo de conteúdo especificado para o ficheiro. Se não for especificado nenhum tipo de conteúdo, o tipo de conteúdo predefinido é `application/octet-stream`.
`ETag`	O ETag contém um valor que pode utilizar para realizar operações condicionalmente. O valor está entre aspas.
`Content-MD5`	Se o `Content-MD5` cabeçalho tiver sido definido para o ficheiro, o `Content-MD5` cabeçalho de resposta é devolvido para que o cliente possa verificar a integridade do conteúdo da mensagem.
`Content-Encoding`	Se o cabeçalho do `Content-Encoding` pedido tiver sido definido anteriormente para o ficheiro, o `Content-Encoding` valor é devolvido neste cabeçalho.
`Content-Language`	Se o cabeçalho do `Content-Language` pedido tiver sido definido anteriormente para o ficheiro, o `Content-Language` valor é devolvido neste cabeçalho.
`Cache-Control`	Se o cabeçalho do `Cache-Control` pedido tiver sido definido anteriormente para o ficheiro, o `Cache-Control` valor é devolvido neste cabeçalho.
`Content-Disposition`	Devolve o valor que foi especificado para o `x-ms-content-disposition` cabeçalho e especifica como processar a resposta. O `Content-Disposition` campo de cabeçalho de resposta transmite informações adicionais sobre como processar o payload de resposta e pode utilizá-lo para anexar metadados adicionais. Por exemplo, se estiver definido como `attachment`, `Content-Disposition` indica que o utilizador-agente não deve apresentar a resposta, mas deve apresentar uma janela Guardar Como.
`x-ms-request-id`	Identifica exclusivamente o pedido que foi feito e pode ser utilizado para resolver o pedido. Para obter mais informações, veja Resolver problemas de operações da API.
`x-ms-version`	Indica a versão do serviço que foi utilizada para executar o pedido.
`Date`	Um valor de data/hora UTC gerado pelo serviço, que indica a hora em que a resposta foi iniciada.
`x-ms-copy-completion-time:<datetime>`	Versão 2015-02-21 e posterior. A 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. Este cabeçalho não é apresentado se uma cópia estiver pendente, se este ficheiro nunca tiver sido o destino numa operação Copiar Ficheiro ou se este ficheiro tiver sido modificado após uma operação de Copiar Ficheiro concluída utilizando Definir Propriedades de Ficheiro ou Criar Ficheiro.
`x-ms-copy-status-description: <error string>`	Versão 2015-02-21 e posterior. Aparece apenas quando `x-ms-copy-status`falha ouestá pendente. Descreve a causa da falha fatal ou não fatal da operação de cópia. Este cabeçalho não é apresentado se uma cópia estiver pendente, se este ficheiro nunca tiver sido o destino numa operação Copiar Ficheiro ou se este ficheiro tiver sido modificado após uma operação de Copiar Ficheiro concluída utilizando Definir Propriedades de Ficheiro ou Criar Ficheiro.
`x-ms-copy-id: <id>`	Versão 2015-02-21 e posterior. O identificador de cadeia para a última operação de tentativa de Copiar Ficheiro em que este ficheiro era o ficheiro de destino. Este cabeçalho não é apresentado se este ficheiro nunca tiver sido o destino numa operação Copiar Ficheiro ou se este ficheiro tiver sido modificado após uma operação de Copiar Ficheiro concluída utilizando Definir Propriedades de Ficheiro ou Criar Ficheiro.
`x-ms-copy-progress: <bytes copied/bytes total>`	Versão 2015-02-21 e posterior. 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 o número de `Content-Length` bytes copiados. Este cabeçalho não é apresentado se este ficheiro nunca tiver sido o destino numa operação Copiar Ficheiro ou se este ficheiro tiver sido modificado após uma operação de Copiar Ficheiro concluída utilizando Definir Propriedades de Ficheiro ou Criar Ficheiro.
`x-ms-copy-source: url`	Versão 2015-02-21 e posterior. Um URL com até 2 carateres KB que especifica o ficheiro de origem que foi utilizado na última operação de Tentativa de Copiar Ficheiro em que este ficheiro era o ficheiro de destino. Este cabeçalho não é apresentado se este ficheiro nunca tiver sido o destino numa operação Copiar Ficheiro ou se este ficheiro tiver sido modificado após uma operação de Copiar Ficheiro concluída utilizando Definir Propriedades de Ficheiro ou Criar Ficheiro.
`x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed>`	Versão 2015-02-21 e posterior. O estado da operação de cópia identificada por `x-ms-copy-id`, com estes valores: - êxito: Cópia concluída com êxito. - pendente: A cópia está em curso. Verifique `x-ms-copy-status-description` se erros intermitentes e não fatais impedem o progresso da cópia, mas não causam falhas. - abortado: A cópia foi terminada por Abortar Ficheiro de Cópia. - falha: Falha na cópia. Veja `x-ms-copy-status-description` os detalhes da falha. Este cabeçalho não é apresentado se este ficheiro nunca tiver sido o destino numa operação Copiar Ficheiro ou se este ficheiro tiver sido modificado após uma operação de Copiar Ficheiro concluída utilizando Definir Propriedades de Ficheiro ou Criar Ficheiro.
`x-ms-server-encrypted: true/false`	Versão 2017-04-17 e posterior. O valor deste cabeçalho está definido como `true` se os dados de ficheiro e os metadados da aplicação estiverem completamente encriptados com o algoritmo especificado. O valor está definido como `false` se o ficheiro não estiver encriptado ou se apenas partes do ficheiro ou metadados da aplicação estiverem encriptadas.
`x-ms-file-permission-key`	Versão 2019-02-02 e posterior. A chave da permissão do ficheiro.
`x-ms-file-attributes`	Versão 2019-02-02 e posterior. Os atributos do sistema de ficheiros do ficheiro. Para obter mais informações, veja a lista de atributos disponíveis.
`x-ms-file-creation-time`	Versão 2019-02-02 e posterior. O valor de data/hora UTC que representa a propriedade de hora de criação de um ficheiro.
`x-ms-file-last-write-time`	Versão 2019-02-02 e posterior. O valor de data/hora UTC que representa a última propriedade de hora de escrita do ficheiro.
`x-ms-file-change-time`	Versão 2019-02-02 e posterior. O valor de data/hora UTC que representa a propriedade de hora de alteração do ficheiro.
`x-ms-file-file-id`	Versão 2019-02-02 e posterior. O ID de ficheiro do ficheiro.
`x-ms-file-parent-id`	Versão 2019-02-02 e posterior. O ID do ficheiro principal do ficheiro.
`x-ms-lease-duration:infinite`	Versão 2019-02-02 e posterior. Quando um ficheiro é arrendado, especifica que a concessão é de duração infinita.
`x-ms-lease-state:<available;leased;broken>`	Versão 2019-02-02 e posterior. Quando um ficheiro é arrendado, especifica o estado de concessão do ficheiro.
`x-ms-lease-status:<locked;unlocked>`	Versão 2019-02-02 e posterior. Quando um ficheiro é arrendado, especifica o estado de concessão do ficheiro.
`x-ms-client-request-id`	Pode ser utilizado para resolver problemas de pedidos e respostas correspondentes. O valor deste cabeçalho é igual ao valor do `x-ms-client-request-id` cabeçalho se estiver presente no pedido e o valor não contiver mais de 1024 carateres ASCII visíveis. Se o `x-ms-client-request-id` cabeçalho não estiver presente no pedido, não está presente na resposta.

Corpo da resposta