Partilhar via

Obter ficheiro

A operação Get File lê ou baixa um arquivo do sistema, incluindo seus metadados e propriedades. Esta operação é suportada na versão 2025-05-05 e posterior para Partilhas de Ficheiros com o protocolo NFS ativado.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado Disponível
PME Sim
NFS Sim

Solicitar

A solicitação Get File é construída da seguinte forma. Recomendamos que você use HTTPS.

Método Solicitar URI Versão HTTP
OBTER https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile HTTP/1.1

Substitua os componentes de caminho mostrados no URI de solicitação pelo seu, da seguinte maneira:

Componente Caminho Descrição
myaccount O nome da sua conta de armazenamento.
myshare O nome do seu compartilhamento de arquivos.
mydirectorypath Opcional. O caminho para o diretório.
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 de URI

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

Parâmetro Descrição
timeout Opcional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Definir tempos limite para operações do Azure Files.

Cabeçalhos de solicitação

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

Cabeçalhos de solicitação comuns

Cabeçalho da solicitação Descrição
Authorization Necessário. Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
Date ou x-ms-date Necessário. Especifica o Tempo Universal Coordenado (UTC) para a solicitação. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
x-ms-version Obrigatório para todos os pedidos autorizados. Especifica a versão da operação a ser usada para essa solicitação. Esta operação é suportada na versão 2025-05-05 e posterior para Partilhas de Ficheiros com o protocolo NFS ativado.

Para obter mais informações, consulte controle de versão para os serviços de Armazenamento do Azure.
Range Opcional. Retorna dados de arquivo somente do intervalo de bytes especificado.
x-ms-range Opcional. Retorna dados de arquivo somente do intervalo de bytes especificado. Se Range e x-ms-range forem especificados, o serviço usará o valor de x-ms-range. Se nenhum dos dois for especificado, todo o conteúdo do arquivo será retornado. Consulte Especificar o cabeçalho do intervalo para o de operações do Azure Files para obter mais informações.
x-ms-range-get-content-md5: true Opcional. Quando esse cabeçalho é definido como true e é especificado junto com o cabeçalho Range, o serviço retorna o hash MD5 para o intervalo, desde que o intervalo seja menor ou igual a 4 mebibytes (MiB) de tamanho.

Se esse cabeçalho for especificado sem o cabeçalho Range, o serviço retornará o código de status 400 (Solicitação incorreta).

Se esse cabeçalho estiver definido como true quando o intervalo exceder 4 MiB de tamanho, o serviço retornará o código de status 400 (Solicitação incorreta).
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. Caso contrário, a operação falhará com o código de status 412 (Falha na pré-condição).

Esse cabeçalho será ignorado se o arquivo estiver localizado em um compartilhamento de arquivos com o protocolo NFS habilitado, que não oferece suporte a concessões de arquivos.
x-ms-client-request-id Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres de 1 kibibyte (KiB) que é registrado nos logs quando o log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar atividades do lado do cliente com solicitações que o servidor recebe. Para obter mais informações, consulte Monitorar arquivos do Azure.
x-ms-file-request-intent Obrigatório se Authorization cabeçalho especificar um token OAuth. O valor aceitável é backup. Este cabeçalho especifica que os Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action ou Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action devem ser concedidos se forem incluídos na política RBAC atribuída à identidade autorizada usando o cabeçalho Authorization. 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 na url da solicitação deve ser cortado ou não.

Esse cabeçalho será ignorado se o destino estiver localizado em um compartilhamento de arquivos com o protocolo NFS habilitado, que oferece suporte a pontos à direita por padrão.

Para obter mais informações, consulte Nomeando e referenciando compartilhamentos, diretórios, arquivos e metadados.

Cabeçalhos de solicitação somente SMB

Nenhuma.

Cabeçalhos de solicitação somente NFS

Nenhuma.

Corpo do pedido

Nenhuma.

Resposta

A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e o corpo da resposta, que contém o conteúdo do arquivo.

Código de status

Uma operação bem-sucedida retorna o código de status 200 (OK). Para obter 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 nas tabelas a seguir. 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çalhos de resposta comuns

Cabeçalho da resposta Descrição
Last-Modified Retorna a data e a hora em que o arquivo foi modificado pela última vez. O formato de data segue o 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.
Content-Length O número de bytes presentes no corpo da resposta.
Content-Type O tipo de conteúdo especificado para o arquivo. O tipo de conteúdo padrão é application/octet-stream.
Content-Range O intervalo de bytes retornado se o cliente solicitou um subconjunto do arquivo definindo o cabeçalho da solicitação Range.
ETag Contém um valor que você pode usar para executar operações condicionalmente. O valor está entre aspas.
Content-MD5 Se o arquivo tiver um hash MD5 e a solicitação for para ler o arquivo completo, esse cabeçalho de resposta será retornado para que o cliente possa verificar a integridade do conteúdo da mensagem.

Se a solicitação for para ler um intervalo especificado e o x-ms-range-get-content-md5 estiver definido como true, a solicitação retornará um hash MD5 para o intervalo, desde que o tamanho do intervalo seja menor ou igual a 4 MiB.

Se nenhum desses conjuntos de condições for true, nenhum valor será retornado para o cabeçalho Content-MD5.

Se x-ms-range-get-content-md5 for especificado sem o cabeçalho do intervalo, o serviço retornará o código de status 400 (Solicitação incorreta).

Se x-ms-range-get-content-md5 estiver definido como true quando o intervalo exceder 4 MiB, o serviço retornará o código de status 400 (Solicitação incorreta).
Content-Encoding Retorna o valor especificado para o cabeçalho da solicitação Content-Encoding.
Content-Language Retorna o valor especificado para o cabeçalho da solicitação Content-Language.
Cache-Control É retornado se tiver sido especificado anteriormente para o arquivo.
Content-Disposition Retorna o valor especificado para o cabeçalho x-ms-content-disposition e especifica como processar a resposta.

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 estiver definido como attachment, Content-Disposition indica que o agente do usuário não deve exibir a resposta, mas, em vez disso, deve exibir uma janela Salvar como.
x-ms-request-id Identifica exclusivamente a solicitação que foi feita e pode ser usada para solucionar a solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API.
x-ms-version A versão de serviço que foi usada para executar a solicitação.
Accept-Ranges: bytes Indica que o serviço oferece suporte a solicitações de conteúdo parcial de arquivo.
Date Date
x-ms-copy-completion-time:<datetime> Versão 2015-02-21 e posterior. A hora de conclusão da última tentativa de Copiar Arquivo operação em que esse arquivo era o arquivo 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 arquivo nunca tiver sido o destino em uma operação Copiar Arquivo ou se esse arquivo tiver sido modificado após uma operação Copiar Arquivo concluída que usou 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 é com falha ou pendente. Descreve a causa de uma falha de operação de cópia fatal ou não fatal. Este cabeçalho não aparece 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 concluída Copiar Ficheiro que utilizou Definir Propriedades do Ficheiro ou Criar Ficheiro.
x-ms-copy-id: <id> Versão 2015-02-21 e posterior. O identificador de cadeia de caracteres para a última tentativa operação de de cópia de arquivo em que esse arquivo era o arquivo de destino. Esse cabeçalho não aparecerá se o arquivo nunca tiver sido o destino em uma operação de de cópia de arquivo ou se esse arquivo tiver sido modificado após uma operação de de cópia de concluída que usou 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 que foram copiados e o total de bytes na origem na última tentativa operação Copiar Arquivo em que esse arquivo era o arquivo de destino. Pode mostrar de 0 ao número de bytes Content-Length copiados. Este cabeçalho não aparece 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 concluída Copiar Ficheiro que utilizou Definir Propriedades do Ficheiro ou Criar Ficheiro.
x-ms-copy-source: url Versão 2015-02-21 e posterior. Uma URL de até 2 KB de comprimento que especifica o arquivo de origem que foi usado na última tentativa operação Copiar Arquivo em que esse arquivo era o arquivo de destino. Este cabeçalho não aparece se este ficheiro nunca tiver sido o destino numa operação Copy File ou se este ficheiro tiver sido modificado após uma operação Copy File concluída que utilizou set File Properties ou Create File.
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:

- pending: 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 falhas.
- success: A cópia foi concluída com êxito.
- aborted: A cópia foi encerrada por Abortar arquivo de cópia.
- failed: Falha na cópia. Consulte x-ms-copy-status-description para obter detalhes sobre falhas.

Este cabeçalho não aparece 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 Copiar Ficheiro concluída que utilizou Definir Propriedades do Ficheiro ou Criar Ficheiro.
x-ms-content-md5 A partir da versão 2016-05-31, se o arquivo tiver um hash MD5 e se a solicitação contiver um cabeçalho de intervalo (range ou x-ms-range), esse cabeçalho de resposta será retornado com o valor do valor MD5 do arquivo inteiro. Esse valor pode ou não ser igual ao valor retornado no cabeçalho Content-MD5, que é calculado a partir do intervalo solicitado.
x-ms-server-encrypted: true/false Versão 2017-04-17 e posterior. O valor desse cabeçalho é definido como true se os dados do arquivo e os metadados do aplicativo forem completamente criptografados usando o algoritmo especificado. Se o ficheiro não estiver encriptado, ou se apenas partes dos metadados do ficheiro/aplicação estiverem encriptados, o valor é definido como false.
x-ms-file-creation-time O valor de data/hora UTC que representa a propriedade de tempo de criação para o arquivo.
x-ms-file-last-write-time O valor de data/hora UTC que representa a última propriedade de tempo de gravação para o arquivo.
x-ms-file-change-time O valor de data/hora UTC que representa a propriedade change time para o arquivo.
x-ms-file-file-id O ID do arquivo do arquivo.
x-ms-file-parent-id 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 suas respostas correspondentes. O valor desse cabeçalho é igual ao valor do cabeçalho x-ms-client-request-id se ele estiver presente na solicitação e o valor não contiver mais de 1.024 caracteres ASCII visíveis. Se o cabeçalho x-ms-client-request-id não estiver presente na solicitação, ele não estará presente na resposta.

Cabeçalhos de resposta somente SMB

Cabeçalho da resposta Descrição
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.

Cabeçalhos de resposta somente NFS

Cabeçalho da resposta Descrição
x-ms-mode Versão 2025-05-05 e posterior. O modo do arquivo. Consulte permissões de arquivo POSIX (modo).
x-ms-owner Versão 2025-05-05 e posterior. O identificador de usuário (UID) do proprietário do arquivo.
x-ms-group Versão 2025-05-05 e posterior. O identificador de grupo (GID) do proprietário do arquivo.
x-ms-link-count Versão 2025-05-05 e posterior. A contagem de links do arquivo.

Corpo de resposta

O corpo da resposta contém o conteúdo do arquivo.

Resposta da amostra

Response Status:
HTTP/1.1 200 OK

Response Headers:
x-ms-type: File
x-ms-meta-m1: v1
x-ms-meta-m2: v2
Content-Length: 11
Content-Type: text/plain; charset=UTF-8
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-version: 2019-02-02
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6
x-ms-copy-source: <url>
x-ms-copy-status: success
x-ms-copy-progress: 11/11
x-ms-copy-completion-time: <date>
x-ms-lease-duration: infinite
x-ms-lease-state: leased
x-ms-lease-status: locked

Autorização

Somente o proprietário da conta pode chamar essa operação.

Atributos do sistema de arquivos

Atributo Atributo de arquivo Win32 Definição
Somente leitura FILE_ATTRIBUTE_READONLY Um arquivo que é somente leitura. Os aplicativos podem ler o arquivo, mas não podem gravá-lo ou excluí-lo.
Escondido FILE_ATTRIBUTE_HIDDEN O ficheiro está oculto. Ele não está incluído em uma listagem de diretório comum.
Sistema FILE_ATTRIBUTE_SYSTEM Um arquivo que o sistema operacional usa uma parte ou usa exclusivamente.
Nenhum FILE_ATTRIBUTE_NORMAL Um arquivo que não tem outros atributos definidos. Este atributo é válido apenas quando é usado sozinho.
Arquivo FILE_ATTRIBUTE_ARCHIVE Um arquivo que é um arquivo morto. Os aplicativos normalmente usam esse atributo para marcar arquivos para backup ou remoção.
Temporário FILE_ATTRIBUTE_TEMPORARY Um arquivo que está sendo usado para armazenamento temporário.
Offline FILE_ATTRIBUTE_OFFLINE Os dados de um ficheiro não estão disponíveis imediatamente. Este atributo do sistema de arquivos é apresentado principalmente para fornecer compatibilidade com o Windows. O Azure Files não oferece suporte a opções de armazenamento offline.
NotContentIndexed FILE_ATTRIBUTE_NOT_CONTENT_INDEXED O arquivo não deve ser indexado pelo serviço de indexação de conteúdo.
NoScrubData FILE_ATTRIBUTE_NO_SCRUB_DATA O fluxo de dados do usuário não deve ser lido pelo scanner de integridade de dados em segundo plano. Este atributo do sistema de arquivos é apresentado principalmente para fornecer compatibilidade com o Windows.

Permissões de arquivo POSIX (modo)

As permissões de arquivo POSIX podem ser especificadas numericamente em um formato octal numérico de 12 bits ou em um formato simbólico "rwx". Exemplos:

  • "0644" ou "rw-r--r--": o usuário (proprietário do arquivo) tem permissão de leitura, gravação. O grupo tem permissão de leitura. Outros têm permissão de leitura.
  • "0755" ou "rwxr-xr-x": o usuário (proprietário do arquivo) tem permissão de leitura, gravação e execução. O grupo tem permissão de leitura e execução. Outros têm permissão de leitura e execução.

Formato octal numérico

Os três números octais de ordem mais baixa representam as permissões para proprietário/usuário, grupo e outros e são indicados usando um número octal (0-7), formado usando uma combinação bit a bit de '4' (Ler), '2' (Gravar), '1' (Executar). O número octal de ordem mais alta (0-7) é usado para indicar uma combinação de permissões '4' (SetUID), '2' (SetGID), '1' (StickyBit).

Formato Permissão
0700 O usuário (proprietário do arquivo) tem permissão de leitura, gravação e execução.
0400 O usuário tem permissão de leitura.
0200 O usuário tem permissão de gravação.
0100 O usuário tem permissão de execução.
0070 O grupo tem permissão de leitura, gravação e execução.
0040 O grupo tem permissão de leitura.
0020 O grupo tem permissão de gravação.
0010 O grupo tem permissão de execução.
0007 Outros têm permissão de leitura, escrita e execução.
0004 Outros têm permissão de leitura.
0002 Outros têm permissão de escrita.
0001 Outros têm permissão de execução.
4000 Defina o ID de usuário efetivo no arquivo.
2000 Defina o ID de grupo efetivo no arquivo.
1000 Defina para indicar que o arquivo pode ser excluído ou renomeado somente pelo proprietário do arquivo, proprietário do diretório ou usuário raiz.

Formato simbólico "rwx"

As permissões para proprietário/usuário, grupo e outros são indicadas usando uma combinação de caracteres 'r' (Ler), 'w' (Gravar) e 'x' (Executar).

Formato Permissão
RWX------ O usuário (proprietário do arquivo) tem permissão de leitura, gravação e execução.
r-------- O usuário tem permissão de leitura.
-w------- O usuário tem permissão de gravação.
--x------ O usuário tem permissão de execução.
---rwx--- O grupo tem permissão de leitura, gravação e execução.
---r----- O grupo tem permissão de leitura.
----w---- O grupo tem permissão de gravação.
-----x--- O grupo tem permissão de execução.
------rwx Outros têm permissão de leitura, escrita e execução.
------r-- Outros têm permissão de leitura.
-------w- Outros têm permissão de escrita.
--------x Outros têm permissão de execução.

Comentários

Chamar Get File em um intervalo que ainda não tem conteúdo ou que foi limpo retorna 0 para esses bytes.

Se você chamar Get File sem intervalo especificado, o serviço retornará o intervalo de bytes até o valor especificado para o cabeçalho x-ms-content-length. Para quaisquer intervalos que não tenham conteúdo, o serviço retorna 0 para esses bytes.

Uma operação Get File é permitida dois minutos por MiB para ser concluída. Operações que levam mais de dois minutos por MiB em tempo médio de tempo limite.

Ver também

operações em arquivos

  • Last updated on