Listar Diretórios e Ficheiros

A List Directories and Files operação devolve uma lista de ficheiros ou diretórios na partilha ou diretório especificado. Lista os conteúdos apenas para um único nível da hierarquia de diretórios.

Disponibilidade do protocolo

Protocolo de partilha de ficheiros ativado	Disponível
SMB
NFS

Pedir

Pode construir o pedido da List Directories and Files seguinte forma. É recomendado HTTPS.

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

Para obter detalhes sobre as restrições de nomenclatura de caminhos, veja Nomenclatura e referência de partilhas, diretórios, ficheiros e metadados.

Parâmetros URI

Pode especificar os seguintes parâmetros adicionais no URI.

Cabeçalhos do pedido

A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.

Corpo do pedido

Nenhum.

Resposta

A resposta inclui um código de estado HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta no formato XML.

Código de estado

Uma operação bem-sucedida devolve o código de estado 200 (OK). Para obter 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.

Corpo da resposta

O formato da resposta XML é o seguinte.

Tenha em atenção que os Markerelementos , ShareSnapshote MaxResults só estão presentes se os especificar no URI do pedido. O NextMarker elemento só tem um valor se os resultados da lista não estiverem concluídos.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.file.core.windows.net/" ShareName="myshare" ShareSnapshot="date-time" DirectoryPath="directory-path">  
  <Marker>string-value</Marker>
  <Prefix>string-value</Prefix>
  <MaxResults>int-value</MaxResults>
  <DirectoryId>directory-id</DirectoryId>
  <Entries>
    <File>
      <FileId>file-id</FileId>
      <Name>file-name</Name>  
      <Properties>  
        <Content-Length>size-in-bytes</Content-Length>
        <CreationTime>datetime</CreationTime>
        <LastAccessTime>datetime</LastAccessTime>
        <LastWriteTime>datetime</LastWriteTime>
        <ChangeTime>datetime</ChangeTime>
        <Last-Modified>datetime</Last-Modified>
        <Etag>etag</Etag>
      </Properties>
      <Attributes>Archive | Hidden | Offline | ReadOnly</Attributes>
      <PermissionKey>4066528134148476695*1</PermissionKey>
    </File>  
    <Directory>
      <FileId>file-id</FileId>
      <Name>directory-name</Name>  
      <Properties>
        <CreationTime>datetime</CreationTime>
        <LastAccessTime>datetime</LastAccessTime>
        <LastWriteTime>datetime</LastWriteTime>
        <ChangeTime>datetime</ChangeTime>
        <Last-Modified>datetime</Last-Modified>
        <Etag>etag</Etag>
      </Properties>
      <Attributes>Archive | Hidden | Offline | ReadOnly</Attributes>
      <PermissionKey>4066528134148476695*1</PermissionKey>
    </Directory>  
  </Entries>  
  <NextMarker />  
</EnumerationResults>  

Tenha em atenção que o Content-Length elemento é devolvido na listagem. No entanto, este valor pode não estar atualizado, porque um cliente SMB pode ter modificado o ficheiro localmente. O valor de Content-Length pode não refletir esse facto até que a alça seja fechada ou o bloqueio de operações seja quebrado. Para obter valores de propriedade atuais, utilize x-ms-file-extended-info: trueou chame Obter Propriedades do Ficheiro.

Nas versões 2020-04-08, 2020-06-12 e 2020-08-04, FileId é devolvido para ficheiros e diretórios se o cabeçalho x-ms-file-extended-info for verdadeiro. Na versão 2020-10-02 e posterior, FileId é sempre devolvido para ficheiros e diretórios.

Na versão 2020-04-08, include={timestamps} devolve as seguintes propriedades de carimbo de data/hora: CreationTime, LastAccessTimee LastWriteTime. Na versão 2020-06-12 e posterior, include={timestamps} devolve as seguintes propriedades de carimbo de data/hora: CreationTime, LastAccessTime, LastWriteTime, ChangeTimee Last-Modified.

Na versão 2020-10-02 e posterior, DirectoryId é devolvido na resposta. Especifica o FileId do diretório no qual a API está a ser chamada.

Nas versões 2021-12-02 e mais recentes, List Directory and Files o codificará por percentagem (por RFC 2396) todos os FileNamevalores de elementos , DirectoryNameou PrefixDirectoryPath que contêm carateres inválidos em XML (especificamente, U+FFFE ou U+FFFF). Se codificado, o Nameelemento ou PrefixEnumerationResults incluirá um Encoded=true atributo. Tenha em atenção que isto só ocorrerá para os valores dos Name elementos que contêm os carateres inválidos em XML e não para os restantes Name elementos na resposta.

Formato datetime e versão da API para campos de carimbo de data/hora

Autorização

Apenas o proprietário da conta pode chamar esta operação.

Observações

O valor devolvido no Content-Length elemento corresponde ao valor do cabeçalho do x-ms-content-length ficheiro.

Tenha em atenção que cada Directory elemento devolvido conta para o resultado máximo, tal como cada File elemento. Os ficheiros e diretórios são listados entrelaçados, por ordem lexicamente ordenada no corpo da resposta.

A listagem está limitada a um único nível da hierarquia de diretórios. Para listar vários níveis, pode fazer várias chamadas de forma iterativa. Utilize o Directory valor devolvido de um resultado numa chamada subsequente para List Directories and Files.

Ver também

Operações em diretórios