Výpis adresářů a souborů

Článek
02/21/2025

Operace List Directories and Files vrátí seznam souborů nebo adresářů v zadané sdílené složce nebo adresáři. Vypíše obsah pouze pro jednu úroveň hierarchie adresářů. Tato operace je podporována ve verzi 2025-05-05 a novější pro sdílené složky s povoleným protokolem NFS.

Dostupnost protokolu

Povolený protokol sdílené složky	K dispozici
SMB
NFS

Prosba

Požadavek List Directories and Files je vytvořen následujícím způsobem. Doporučujeme používat PROTOKOL HTTPS.

Metoda	Identifikátor URI požadavku	Verze HTTP
DOSTAT	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&comp=list`	HTTP/1.1
DOSTAT	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&sharesnapshot=<DateTime>&comp=list`	HTTP/1.1

Součásti cesty zobrazené v identifikátoru URI požadavku nahraďte vlastními, a to následujícím způsobem:

Komponenta Path	Popis
`myaccount`	Název vašeho účtu úložiště.
`myshare`	Název sdílené složky.
`mydirectorypath`	Cesta k adresáři.

Podrobnosti o omezeních pojmenování cest najdete v tématu Pojmenování a odkazování na sdílené složky, adresáře, soubory a metadata.

Parametry identifikátoru URI

Pro identifikátor URI můžete zadat následující další parametry.

Běžné parametry identifikátoru URI

Parametr	Popis
`prefix`	Volitelný. Verze 2016-05-31 a novější. Filtruje výsledky tak, aby vracely pouze soubory a adresáře, které mají názvy začínající zadanou předponou.
`sharesnapshot`	Volitelný. Verze 2017-04-17 a novější Parametr snímku sdílené složky je neprůzná `DateTime` hodnota, která při výskytu určuje snímek sdílené složky, který se má dotazovat na seznam souborů a adresářů.
`marker`	Volitelný. Řetězcová hodnota, která identifikuje část seznamu, která se má vrátit pomocí další operace seznamu. Operace vrátí hodnotu značky v textu odpovědi, pokud vrácený seznam nebyl dokončen. Hodnotu značky pak můžete použít v následném volání a požádat o další sadu položek seznamu. Hodnota značky je pro klienta neprůhelní.
`maxresults`	Volitelný. Určuje maximální počet souborů nebo adresářů, které se mají vrátit. Pokud požadavek nezadá `maxresults`nebo určuje hodnotu větší než 5 000, server vrátí až 5 000 položek. Nastavení `maxresults` na hodnotu menší nebo rovno nule způsobí chybu s kódem odpovědi 400 (Chybný požadavek).
`timeout`	Volitelný. Parametr `timeout` se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace azure Files.

Parametry identifikátoru URI pouze protokolu SMB

Parametr Popis

Parametr	Popis
`include={Timestamps, ETag, Attributes, PermissionKey}`	Volitelně je k dispozici od verze 2020-04-08. Určuje jednu nebo více vlastností, které se mají zahrnout do odpovědi: `Timestamps` `ETag` `Attributes` (atributy souborů Win32) `PermissionKey` Pokud chcete pro identifikátor URI zadat více než jednu z těchto možností, je nutné každou možnost oddělit čárkou zakódovanou adresou URL (`%82`). Při zadání tohoto parametru se implicitně předpokládá, že hlavička `x-ms-file-extended-info` má hodnotu true.

include={Timestamps, ETag, Attributes, PermissionKey}

Volitelně je k dispozici od verze 2020-04-08. Určuje jednu nebo více vlastností, které se mají zahrnout do odpovědi:

Timestamps
ETag
Attributes (atributy souborů Win32)
PermissionKey

Pokud chcete pro identifikátor URI zadat více než jednu z těchto možností, je nutné každou možnost oddělit čárkou zakódovanou adresou URL (%82).

Při zadání tohoto parametru se implicitně předpokládá, že hlavička x-ms-file-extended-info má hodnotu true.

Pouze parametry identifikátoru URI systému souborů NFS

Žádný.

Hlavičky požadavku

Povinná a volitelná hlavička požadavku jsou popsána v následujících tabulkách:

Běžné hlavičky požadavků

Hlavička požadavku	Popis
`Authorization`	Požadovaný. Určuje schéma autorizace, název účtu a podpis. Další informace najdete v tématu Autorizace požadavků na službu Azure Storage.
`Date` nebo `x-ms-date`	Požadovaný. Určuje standard UTC (Coordinated Universal Time) pro požadavek. Další informace najdete v tématu Autorizace požadavků na službu Azure Storage.
`x-ms-version`	Vyžaduje se pro všechny autorizované žádosti. Určuje verzi operace, která se má pro tento požadavek použít. Tato operace je podporována ve verzi 2025-05-05 a novější pro sdílené složky s povoleným protokolem NFS. Další informace najdete v tématu Správa verzí pro služby Azure Storage.
`x-ms-client-request-id`	Volitelný. Poskytuje hodnotu vygenerovanou klientem, neprůshlenou hodnotou s limitem znaků 1 kibibajtů (KiB), který je zaznamenán v protokolech při konfiguraci protokolování. Důrazně doporučujeme použít tuto hlavičku ke korelaci aktivit na straně klienta s požadavky, které server přijímá. Další informace najdete v tématu Monitorování služby Azure Files.
`x-ms-file-request-intent`	Vyžaduje se, pokud hlavička `Authorization` určuje token OAuth. Přijatelná hodnota je `backup`. Tato hlavička určuje, že se mají udělit `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action` nebo `Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action`, pokud jsou zahrnuty do zásad RBAC přiřazené k identitě, která je autorizovaná pomocí hlavičky `Authorization`. K dispozici pro verzi 2022-11-02 a novější.
`x-ms-allow-trailing-dot: { <Boolean> }`	Volitelný. Verze 2022-11-02 a novější. Logická hodnota určuje, jestli by se měla oříznout koncová tečka v adrese URL požadavku, nebo ne. Tato hlavička se ignoruje, pokud se cíl nachází ve sdílené složce s povoleným protokolem NFS, který ve výchozím nastavení podporuje koncové tečky. Další informace najdete v tématu Pojmenování a odkazování na sdílené složky, adresáře, soubory a metadata.

Hlavičky požadavků jenom smb

Hlavička požadavku	Popis
`x-ms-file-extended-info: {true}`	Volitelný. Verze 2020-04-08 a novější. Pokud parametr dotazu `include` není prázdný, předpokládá se implicitně, že je tato hlavička pravdivá. Pokud je hodnota true, vlastnost `Content-Length` pro soubory, která označuje velikost souboru, bude aktuální.

Pouze hlavičky požadavků NFS

Žádný.

Text požadavku

Žádný.

Odpověď

Odpověď obsahuje stavový kód HTTP, sadu hlaviček odpovědí a text odpovědi ve formátu XML.

Stavový kód

Úspěšná operace vrátí stavový kód 200 (OK). Informace o stavových kódech naleznete v tématu Stav a kódy chyb.

Hlavičky odpovědi

Odpověď pro tuto operaci zahrnuje hlavičky v následujících tabulkách. Odpověď může obsahovat také další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.

Běžná hlavička odpovědi

Hlavička odpovědi	Popis
`Content-Type`	Určuje formát, ve kterém se vrátí výsledky. V současné době je tato hodnota `application/xml`.
`x-ms-request-id`	Tato hlavička jednoznačně identifikuje požadavek, který byl proveden, a lze ho použít k řešení potíží s požadavkem. Další informace najdete v tématu řešení potíží s operacemi rozhraní API.
`x-ms-version`	Označuje verzi služby Azure Files použitou ke spuštění požadavku.
`Date` nebo `x-ms-date`	Hodnota data a času UTC, která označuje čas, kdy byla odpověď zahájena. Služba vygeneruje tuto hodnotu.
`x-ms-client-request-id`	Tato hlavička slouží k řešení potíží s požadavky a odpovídajícími odpověďmi. Hodnota této hlavičky se rovná hodnotě hlavičky `x-ms-client-request-id`, pokud se nachází v požadavku. Hodnota je maximálně 1024 viditelných znaků ASCII. Pokud v požadavku není hlavička `x-ms-client-request-id`, nebude tato hlavička v odpovědi k dispozici.

Hlavičky odpovědi pouze smb

Žádný.

Pouze hlavičky odpovědi NFS

Žádný.

Text odpovědi

Formát odpovědi XML je následující.

Prvky Marker, ShareSnapshota MaxResults jsou k dispozici pouze v případě, že je zadáte v identifikátoru URI požadavku. Prvek NextMarker má hodnotu pouze v případě, že výsledky seznamu nejsou dokončeny.

Prvek Content-Length je vrácen ve výpisu souborů, který označuje velikost souboru. Tato hodnota však nemusí být up-to-date, protože klient SMB nebo NFS mohl soubor upravit místně. Hodnota Content-Length nemusí odrážet tento fakt, dokud se popisovač nezavře nebo se přeruší op-lock protokolu SMB. Chcete-li načíst aktuální hodnoty vlastností, použijte x-ms-file-extended-info: true pro adresář umístěný ve sdílené složce s povoleným protokolem SMB nebo volejte Získat vlastnosti souboru pro konkrétní soubor.

Ve verzích 2021-12-02 a novějších bude List Directory and Files všechny FileName, DirectoryName, Prefix nebo DirectoryPath elementy, které obsahují neplatné znaky v JAZYCE XML (konkrétně U+FFFE nebo U+FFFF). Pokud je kódován, Name, Prefix nebo EnumerationResults element bude obsahovat atribut Encoded=true. K tomu dochází pouze pro hodnoty elementu Name obsahující znaky neplatné v jazyce XML, nikoli zbývající Name elementy v odpovědi.

Text odpovědi pro sdílené složky s povoleným protokolem SMB

<?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>

Ve verzích 2020-04-08, 2020-06-12 a 2020-08-08-04 se FileId vrátí pro soubory a adresáře, pokud je hlavička x-ms-file-extended-info pravdivá. Ve verzi 2020-10-02 a novějších se FileId vždy vrátí pro soubory a adresáře.

Ve verzi 2020-04-08 vrátí include={timestamps} následující vlastnosti časového razítka: CreationTime, LastAccessTimea LastWriteTime. Ve verzi 2020-06-12 a novějších vrátí include={timestamps} následující vlastnosti časového razítka: CreationTime, LastAccessTime, LastWriteTime, ChangeTimea Last-Modified.

Ve verzi 2020-10-02 a novějších se DirectoryId vrátí v odpovědi. Určuje FileId adresáře, na kterém se rozhraní API volá.

Text odpovědi pro sdílené složky s povoleným protokolem NFS

<?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>
      </Properties>
    </File>
    <Directory>
      <FileId>file-id</FileId>
      <Name>directory-name</Name>
    </Directory>
  </Entries>
  <NextMarker />
</EnumerationResults>

Formát data a verze rozhraní API pro pole časového razítka

Element	Formát data a času	Ukázková hodnota	Verze rozhraní API
`CreationTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 a novější
`LastAccessTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 a novější
`LastWriteTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 a novější
`ChangeTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-06-12 a novější
`Last-Modified`	RFC 1123	`Thu, 17 Sep 2020 13:38:07 GMT`	2020-06-12 a novější

Oprávnění

Tuto operaci může volat pouze vlastník účtu.

Poznámky

Hodnota vrácená v elementu Content-Length odpovídá hodnotě hlavičky x-ms-content-length souboru.

Každý vrácený prvek Directory se počítá do maximálního výsledku stejně jako každý prvek File. Soubory a adresáře jsou uvedeny intermingingled, v lexicky seřazené pořadí v textu odpovědi.

Výpis je omezen na jednu úroveň hierarchie adresářů. Pokud chcete zobrazit seznam více úrovní, můžete iterativním způsobem provádět více volání. Použijte hodnotu Directory vrácenou z jednoho výsledku v následném volání List Directories and Files.

Viz také

operace v adresářích

Sdílet prostřednictvím

Výpis adresářů a souborů

Dostupnost protokolu

Prosba

Parametry identifikátoru URI

Běžné parametry identifikátoru URI

Parametry identifikátoru URI pouze protokolu SMB

Pouze parametry identifikátoru URI systému souborů NFS

Hlavičky požadavku

Běžné hlavičky požadavků

Hlavičky požadavků jenom smb

Pouze hlavičky požadavků NFS

Text požadavku

Odpověď

Stavový kód

Hlavičky odpovědi

Běžná hlavička odpovědi

Hlavičky odpovědi pouze smb

Pouze hlavičky odpovědi NFS

Text odpovědi

Text odpovědi pro sdílené složky s povoleným protokolem SMB

Text odpovědi pro sdílené složky s povoleným protokolem NFS

Formát data a verze rozhraní API pro pole časového razítka

Oprávnění

Poznámky

Viz také

Další materiály