Obter propriedades do arquivo

Artigo
02/21/2024

A operação Get File Properties retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Ele não retorna o conteúdo do arquivo.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado	Disponível
SMB
NFS

Solicitação

A solicitação Get File Properties pode ser criada da seguinte maneira. Recomendamos que você use HTTPS.

Método	URI da solicitação	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 mostrados no URI de solicitação pelo seu próprio, da seguinte maneira:

Componente Demarcador	Descrição
`myaccount`	O nome da sua conta de armazenamento.
`myshare`	O nome do seu compartilhamento de arquivo.
`mydirectorypath`	Opcional. O caminho para o diretório pai.
`myfile`	O nome do arquivo.

Para obter informações sobre restrições de nomenclatura de caminho, consulte Compartilhamentos de nome e referência, diretórios, arquivos e metadados.

Parâmetros do URI

Os seguintes parâmetros adicionais podem ser especificados no URI de solicitação:

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

Cabeçalhos da solicitação

Os cabeçalhos de solicitação obrigatórios e opcionais são descritos na tabela a seguir:

Cabeçalho da solicitação	Descrição
Autorização	Obrigatórios. Especifica o esquema de autorização, o nome da conta e a assinatura. Para saber mais, confira Autorizar solicitações para o Armazenamento do Azure.
`Date` ou `x-ms-date`	Obrigatórios. Especifica o UTC (Tempo Universal Coordenado) para a solicitação. Para saber mais, confira Autorizar solicitações para o Armazenamento do Azure.
`x-ms-version`	Necessário para todas as solicitações autorizadas. Especifica a versão da operação a ser usada para esta solicitação. Para obter mais informações, consulte Controle de versão para os 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 será executada somente se a concessão do arquivo estiver ativa no momento e a ID de concessão especificada na solicitação corresponder à ID de concessão do arquivo. Se não corresponder, a operação falhará com status código 412 (Falha na pré-condição).
`x-ms-client-request-id`	Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres KiB (1 kibibyte), que é registrado nos logs de análise quando o log de Análise de Armazenamento do Azure está habilitado. É altamente recomendável que você use esse cabeçalho ao correlacionar atividades do lado do cliente com solicitações recebidas pelo servidor. Para obter mais informações, consulte Monitorar Armazenamento de Blobs do Azure.
`x-ms-file-request-intent`	Obrigatório se `Authorization` o cabeçalho especificar um token OAuth. O valor aceitável é `backup`. Esse cabeçalho especifica que o `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action` ou `Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` deve ser concedido se eles forem incluídos na política RBAC atribuída à identidade autorizada usando 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 booliano especifica se um ponto à direita presente na URL de solicitação deve ser cortado ou não. Para obter mais informações, consulte Nomenclatura e referência de compartilhamentos, diretórios, arquivos e metadados.

Corpo da solicitação

Nenhum.

Resposta

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

Código de status

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

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

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP 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`	Retorna a data e a hora em que o arquivo foi modificado pela última vez. O formato da data segue RFC 1123. Para obter mais informações, consulte Representar valores de data/hora em cabeçalhos. Qualquer operação que modifique o arquivo ou suas propriedades atualiza a hora da última modificação.
`x-ms-meta-name:value`	Um conjunto de pares nome-valor associados a esse arquivo como metadados definidos pelo usuário.
`x-ms-type: <File>`	Retorna o tipo `File`. Reservado para uso futuro.
`Content-Length`	O tamanho do arquivo em bytes. Esse cabeçalho retorna o valor do `x-ms-content-length` cabeçalho armazenado com o arquivo .
`Content-Type`	O tipo de conteúdo especificado para o arquivo. Se nenhum tipo de conteúdo for especificado, o tipo de conteúdo padrão será `application/octet-stream`.
`ETag`	A ETag contém um valor que você pode usar para executar operações de forma condicional. O valor é colocado entre aspas.
`Content-MD5`	Se o cabeçalho `Content-MD5` tiver sido definido para o arquivo, o cabeçalho de resposta `Content-MD5` será retornado, de modo que o cliente possa verificar a integridade do conteúdo da mensagem.
`Content-Encoding`	Se o cabeçalho de solicitação `Content-Encoding` tiver sido definido previamente para o arquivo, o valor `Content-Encoding` será retornado nesse cabeçalho.
`Content-Language`	Se o cabeçalho de solicitação `Content-Language` tiver sido definido previamente para o arquivo, o valor `Content-Language` será retornado nesse cabeçalho.
`Cache-Control`	Se o cabeçalho de solicitação `Cache-Control` tiver sido definido previamente para o arquivo, o valor `Cache-Control` será retornado nesse cabeçalho.
`Content-Disposition`	Retorna o valor que foi especificado para o cabeçalho `x-ms-content-disposition` e especifica como processar a resposta. O `Content-Disposition` campo cabeçalho de resposta transmite informações adicionais sobre como processar o conteúdo da resposta e você pode usá-lo para anexar metadados adicionais. Por exemplo, se estiver definido `attachment`como , `Content-Disposition` indica que o agente do usuário não deve exibir a resposta, mas deve exibir uma janela Salvar como.
`x-ms-request-id`	Identifica exclusivamente a solicitação que foi feita e pode ser usada para solucionar problemas da solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API.
`x-ms-version`	Indica a versão do serviço que foi usada para executar a solicitação.
`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 arquivo em que esse arquivo era o arquivo 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 arquivo nunca tiver sido o destino em uma operação Copiar Arquivo ou se esse arquivo tiver sido modificado após uma operação de Copiar Arquivo concluída usando Definir Propriedades do Arquivo ou Criar Arquivo.
`x-ms-copy-status-description: <error string>`	Versão 2015-02-21 e posterior. Aparece somente quando `x-ms-copy-status` há falha ou pendente. Ele descreve a causa da falha da operação de cópia fatal ou não fatal. Esse cabeçalho não será exibido se uma cópia estiver pendente, se esse arquivo nunca tiver sido o destino em uma operação Copiar Arquivo ou se esse arquivo tiver sido modificado após uma operação de Copiar Arquivo concluída usando Definir Propriedades do Arquivo ou Criar Arquivo.
`x-ms-copy-id: <id>`	Versão 2015-02-21 e posterior. O identificador de cadeia de caracteres para a última tentativa de operação copiar arquivo em que esse arquivo era o arquivo de destino. Esse cabeçalho não será exibido se esse arquivo nunca tiver sido o destino em uma operação Copiar Arquivo ou se esse arquivo tiver sido modificado após uma operação de Copiar Arquivo concluída usando Definir Propriedades do Arquivo ou Criar Arquivo.
`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 tentativa de operação copiar arquivo em que esse arquivo era o arquivo de destino. Pode mostrar entre 0 e o número de `Content-Length` bytes copiados. Esse cabeçalho não será exibido se esse arquivo nunca tiver sido o destino em uma operação Copiar Arquivo ou se esse arquivo tiver sido modificado após uma operação de Copiar Arquivo concluída usando Definir Propriedades do Arquivo ou Criar Arquivo.
`x-ms-copy-source: url`	Versão 2015-02-21 e posterior. Uma URL de até 2 KB de caracteres que especifica o arquivo de origem que foi usado na última tentativa de operação copiar arquivo em que esse arquivo era o arquivo de destino. Esse cabeçalho não será exibido se esse arquivo nunca tiver sido o destino em uma operação Copiar Arquivo ou se esse arquivo tiver sido modificado após uma operação de Copiar Arquivo concluída usando Definir Propriedades do Arquivo ou Criar Arquivo.
`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: - Sucesso: Cópia concluída com êxito. - Pendente: A cópia está em andamento. Verifique `x-ms-copy-status-description` se erros intermitentes e não fatais impedem o progresso da cópia, mas não causam falha. - Abortado: A cópia foi encerrada por Anular Cópia de Arquivo. - Falhou: Falha na cópia. Consulte `x-ms-copy-status-description` para obter detalhes da falha. Esse cabeçalho não será exibido se esse arquivo nunca tiver sido o destino em uma operação Copiar Arquivo ou se esse arquivo tiver sido modificado após uma operação de Copiar Arquivo concluída usando Definir Propriedades do Arquivo ou Criar Arquivo.
`x-ms-server-encrypted: true/false`	Versão 2017-04-17 e posterior. O valor desse cabeçalho será definido `true` como se os dados do arquivo e os metadados do aplicativo forem completamente criptografados usando o algoritmo especificado. O valor será definido `false` como se o arquivo estiver descriptografado ou se apenas partes dos metadados do arquivo ou do aplicativo forem criptografadas.
`x-ms-file-permission-key`	Versão 2019-02-02 e posterior. A chave da permissão do arquivo.
`x-ms-file-attributes`	Versão 2019-02-02 e posterior. Os atributos do sistema de arquivos do arquivo. Para obter mais informações, consulte 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 arquivo.
`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 gravação para o arquivo.
`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 para o arquivo.
`x-ms-file-file-id`	Versão 2019-02-02 e posterior. A ID do arquivo.
`x-ms-file-parent-id`	Versão 2019-02-02 e posterior. A ID do arquivo pai do arquivo.
`x-ms-lease-duration:infinite`	Versão 2019-02-02 e posterior. Quando um arquivo é concedido, 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 arquivo é concedido, especifica o estado de concessão do arquivo.
`x-ms-lease-status:<locked;unlocked>`	Versão 2019-02-02 e posterior. Quando um arquivo é concedido, especifica o status de concessão do arquivo.
`x-ms-client-request-id`	Pode ser usado para solucionar problemas de solicitações e respostas correspondentes. O valor desse cabeçalho será igual ao valor do `x-ms-client-request-id` cabeçalho se ele estiver presente na solicitação e o valor não contiver mais de 1.024 caracteres ASCII visíveis. Se o `x-ms-client-request-id` cabeçalho não estiver presente na solicitação, ele não estará presente na resposta.

Corpo da resposta