Megosztás a következőn keresztül:

Címtárak és fájlok listázása

  • Cikk

A List Directories and Files művelet a megadott megosztás vagy könyvtár alatti fájlok vagy könyvtárak listáját adja vissza. Csak a címtárhierarchia egyetlen szintjén sorolja fel a tartalmat. Ezt a műveletet a 2025-05-05-ös és újabb verzió támogatja az engedélyezett NFS protokollal rendelkező fájlmegosztások esetében.

Protokoll rendelkezésre állása

Engedélyezett fájlmegosztási protokoll Beszerezhető
SMB Igen
NFS Igen

Kérés

A List Directories and Files kérés a következőképpen jön létre. Javasoljuk, hogy HTTPS-t használjon.

Módszer URI kérése HTTP-verzió
KAP https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&comp=list HTTP/1.1
KAP https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&sharesnapshot=<DateTime>&comp=list HTTP/1.1

Cserélje le a kérelem URI-jában látható elérésiút-összetevőket a sajátjára az alábbiak szerint:

Elérésiút-összetevő Leírás
myaccount A tárfiók neve.
myshare A fájlmegosztás neve.
mydirectorypath A könyvtár elérési útja.

Az útvonalelnevezési korlátozásokról további információt Megosztások, könyvtárak, fájlok és metaadatok elnevezése és hivatkozása.

URI-paraméterek

Az URI-n a következő további paramétereket adhatja meg.

Gyakori URI-paraméterek

Paraméter Leírás
prefix Szabadon választható. 2016-05-31-es és újabb verzió. Szűri az eredményeket, hogy csak olyan fájlokat és könyvtárakat adja vissza, amelyek neve a megadott előtaggal kezdődik.
sharesnapshot Szabadon választható. 2017-04-17-es és újabb verzió. A megosztási pillanatkép paraméter egy átlátszatlan DateTime érték, amely jelen esetben megadja a fájlok és könyvtárak listájának lekérdezéséhez szükséges megosztási pillanatképet.
marker Szabadon választható. A következő listaművelettel visszaadandó listarészt azonosító sztringérték. A művelet egy jelölőértéket ad vissza a válasz törzsében, ha a visszaadott lista nem fejeződött be. Ezt követően egy későbbi hívásban a jelölőérték használatával kérheti le a listaelemek következő készletét.

A jelölő értéke átlátszatlan az ügyfél számára.
maxresults Szabadon választható. Megadja a visszaadni kívánt fájlok vagy könyvtárak maximális számát. Ha a kérés nem ad meg maxresults, vagy 5000-nél nagyobb értéket ad meg, a kiszolgáló legfeljebb 5000 elemet ad vissza.

Ha a maxresults nullánál kisebb vagy egyenlő értékre állítja, a 400-ás hibaválaszkód (hibás kérelem) jelenik meg.
timeout Szabadon választható. A timeout paraméter másodpercben van kifejezve. További információ: Időtúllépések beállítása az Azure Files-műveletekhez.

Csak SMB URI-paraméterek

Paraméter Leírás
include={Timestamps, ETag, Attributes, PermissionKey} Opcionálisan elérhető, a 2020-04-08-s verziótól kezdve. Egy vagy több tulajdonságot ad meg, amelyeket bele kell foglalni a válaszba:
  • Timestamps
  • ETag
  • Attributes (Win32 fájlattribútumok)
  • PermissionKey

Ha több beállítást szeretne megadni az URI-n, mindegyik beállítást url-kódolású vesszővel (%82) kell elválasztania.

A fejléc x-ms-file-extended-info implicit módon igaznak feltételezzük, ha ez a paraméter meg van adva.

Csak NFS URI-paraméterek

Egyik sem.

Kérelemfejlécek

A szükséges és nem kötelező kérelemfejléceket az alábbi táblázatok ismertetik:

Gyakori kérésfejlécek

Kérelem fejléce Leírás
Authorization Szükséges. Megadja az engedélyezési sémát, a fióknevet és az aláírást. További információ: Kérelmek engedélyezése az Azure Storage-.
Date vagy x-ms-date Szükséges. A kérelem koordinált egyetemes idejét (UTC) adja meg. További információ: Kérelmek engedélyezése az Azure Storage-.
x-ms-version Minden engedélyezett kéréshez szükséges. A kérelemhez használni kívánt művelet verzióját adja meg. Ezt a műveletet a 2025-05-05-ös és újabb verzió támogatja az engedélyezett NFS protokollal rendelkező fájlmegosztások esetében.

További információ: Az Azure Storage-szolgáltatások verziószámozása.
x-ms-client-request-id Szabadon választható. Ügyfél által generált, átlátszatlan értéket biztosít egy 1 kibibyte (KiB) karakterkorláttal, amelyet a naplózás konfigurálásakor rögzít a naplókban. Javasoljuk, hogy ezt a fejlécet használva korrelálja az ügyféloldali tevékenységeket a kiszolgáló által kapott kérésekkel. További információ: Monitor Azure Files.
x-ms-file-request-intent Kötelező, ha Authorization fejléc OAuth-jogkivonatot ad meg. Az elfogadható érték backup. Ez a fejléc azt határozza meg, hogy a Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action vagy Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action meg kell adni, ha azok szerepelnek a Authorization fejléc használatával engedélyezett identitáshoz rendelt RBAC-szabályzatban. A 2022-11-02-es és újabb verziókhoz érhető el.
x-ms-allow-trailing-dot: { <Boolean> } Szabadon választható. 2022-11-02-es és újabb verzió. A logikai érték azt határozza meg, hogy a kérelem URL-címében található záró pont levágható-e vagy sem.

Ez a fejléc figyelmen kívül lesz hagyva, ha a cél olyan fájlmegosztáson található, amelyen engedélyezve van az NFS protokoll, amely alapértelmezés szerint támogatja a záró pont használatát.

További információ: Megosztások, könyvtárak, fájlok és metaadatok elnevezése és hivatkozása.

Csak SMB-kérésfejlécek

Kérelem fejléce Leírás
x-ms-file-extended-info: {true} Szabadon választható. 2020-04-08-s és újabb verzió. Ez a fejléc implicit módon igaz, ha a include lekérdezési paraméter nem üres. Ha igaz, a fájlok Content-Length tulajdonsága, amely a fájl méretét jelzi, naprakész lesz.

Csak NFS-kérelemfejlécek

Egyik sem.

Kérelem törzse

Egyik sem.

Válasz

A válasz tartalmaz egy HTTP-állapotkódot, egy válaszfejléceket és egy XML formátumú választörzset.

Állapotkód

A sikeres művelet a 200-ra (OK) vonatkozó állapotkódot adja vissza. Az állapotkódokkal kapcsolatos információkért lásd állapot- és hibakódokat.

Válaszfejlécek

A műveletre adott válasz az alábbi táblázatok fejléceit tartalmazza. A válasz további szabványos HTTP-fejléceket is tartalmazhat. Minden szabványos fejléc megfelel a HTTP/1.1 protokoll specifikációjának .

Gyakori válaszfejlécek

Válaszfejléc Leírás
Content-Type Azt a formátumot adja meg, amelyben az eredmények vissza lesznek adva. Ez az érték jelenleg application/xml.
x-ms-request-id Ez a fejléc egyedileg azonosítja a végrehajtott kérést, és a kérés hibaelhárításához használható. További információ: API-műveletek hibaelhárítása.
x-ms-version A kérés futtatásához használt Azure Files-verziót jelzi.
Date vagy x-ms-date UTC dátum/idő érték, amely a válasz indításának időpontját jelzi. A szolgáltatás létrehozza ezt az értéket.
x-ms-client-request-id Ezzel a fejlécmel elháríthatja a kéréseket és a megfelelő válaszokat. Ennek az élőfejnek az értéke megegyezik a x-ms-client-request-id fejléc értékével, ha az szerepel a kérelemben. Az érték legfeljebb 1024 látható ASCII-karakter lehet. Ha a x-ms-client-request-id fejléc nem szerepel a kérelemben, akkor ez a fejléc nem jelenik meg a válaszban.

Csak SMB-válaszfejlécek

Egyik sem.

Csak NFS-válaszfejlécek

Egyik sem.

Válasz törzse

Az XML-válasz formátuma a következő.

A Marker, ShareSnapshotés MaxResults elemek csak akkor jelennek meg, ha a kérelem URI-ján adja meg őket. A NextMarker elem csak akkor rendelkezik értékkel, ha a lista eredményei nem fejeződnek be.

A Content-Length elem a fájlok listájában lesz visszaadva, amely a fájl méretét jelzi. Előfordulhat azonban, hogy ez az érték nem up-todátum, mert egy SMB- vagy NFS-ügyfél helyileg módosította a fájlt. Előfordulhat, hogy a Content-Length értéke nem tükrözi ezt a tényt, amíg a fogópont be nem záródik, vagy az SMB op-lock megszakad. Az aktuális tulajdonságértékek lekéréséhez használja a x-ms-file-extended-info: true egy engedélyezett SMB protokollal rendelkező fájlmegosztáson található könyvtárhoz, vagy hívja meg a fájltulajdonságok lekérése az adott fájlhoz.

A 2021-12-02-es és újabb verziókban a List Directory and Files százalékban kódolja (RFC 2396-ra vetítve) az XML-ben érvénytelen karaktereket tartalmazó FileName, DirectoryName, Prefix vagy DirectoryPath elemértékeket (különösen az U+FFFE vagy az U+FFFF). Kódolás esetén a Name, Prefix vagy EnumerationResults elem tartalmaz egy Encoded=true attribútumot. Ez csak az XML-ben érvénytelen karaktereket tartalmazó Name elemértékek esetében fordul elő, a válasz többi Name eleme nem.

Az SMB protokollt használó fájlmegosztások választörzse

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

A 2020-04-08,2020-06-12 és 2020-08-04 verziókban FileId a rendszer visszaadja a fájlok és könyvtárak FileId, ha a fejléc igaz. A 2020-10-02-es és újabb verziókban a rendszer mindig FileId ad vissza fájlokat és könyvtárakat.

A 2020-04-08-es verzióban include={timestamps} a következő időbélyeg-tulajdonságokat adja vissza: CreationTime, LastAccessTimeés LastWriteTime. A 2020-06-12 és újabb verziókban include={timestamps} a következő időbélyeg-tulajdonságokat adja vissza: CreationTime, LastAccessTime, LastWriteTime, ChangeTimeés Last-Modified.

A 2020-10-02-es és újabb verziókban DirectoryId lesz visszaadva a válasz. Megadja annak a könyvtárnak a FileId, amelyen az API-t meghívják.

Az NFS protokollt használó fájlmegosztások választörzse

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

Datetime formátum és API-verzió időbélyegmezőkhöz

Elem Datetime formátum Mintaérték API-verzió
CreationTime ISO 8601 2020-09-17T13:38:03.2740000Z 2020.04.08- és újabb verziók
LastAccessTime ISO 8601 2020-09-17T13:38:03.2740000Z 2020.04.08- és újabb verziók
LastWriteTime ISO 8601 2020-09-17T13:38:03.2740000Z 2020.04.08- és újabb verziók
ChangeTime ISO 8601 2020-09-17T13:38:03.2740000Z 2020-06-12 és újabb verziók
Last-Modified RFC 1123 Thu, 17 Sep 2020 13:38:07 GMT 2020-06-12 és újabb verziók

Felhatalmazás

Ezt a műveletet csak a fióktulajdonos hívhatja meg.

Megjegyzések

A Content-Length elemben visszaadott érték a fájl x-ms-content-length fejlécének értékének felel meg.

Minden Directory visszaadott elem a maximális eredmény felé számlál, ahogy az egyes File elemek is. A fájlok és könyvtárak a válasz törzsében lexikálisan rendezett sorrendben vannak felsorolva.

A lista a címtárhierarchia egyetlen szintjére korlátozódik. Több szint listázásához több hívást is kezdeményezhet iteratív módon. Használja az Directory értéket, amelyet egy eredményből a List Directories and Fileskövetkező hívása eredményez.

Lásd még:

könyvtárakon