Mappen en bestanden weergeven

Artikel
03/29/2023

De List Directories and Files bewerking retourneert een lijst met bestanden of mappen onder de opgegeven share of map. De inhoud wordt alleen voor één niveau van de adreslijsthiërarchie weergegeven.

Protocol beschikbaarheid

Bestandsshareprotocol ingeschakeld	Beschikbaar
SMB
NFS

Aanvraag

U kunt de List Directories and Files aanvraag als volgt samenstellen. HTTPS wordt aanbevolen.

Methode	Aanvraag-URI	HTTP-versie
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&comp=list`	HTTP/1.1
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&sharesnapshot=<DateTime>&comp=list`	HTTP/1.1

Vervang de padonderdelen die in de aanvraag-URI worden weergegeven, als volgt door uw eigen onderdelen:

Padonderdeel	Description
`myaccount`	De naam van uw opslagaccount.
`myshare`	De naam van de bestandsshare.
`mydirectorypath`	Het pad naar de map.

Zie Shares, mappen, bestanden en metagegevens een naam geven en hiernaar verwijzen voor meer informatie over beperkingen voor padnamen.

URI-parameters

U kunt de volgende aanvullende parameters opgeven voor de URI.

Parameter	Beschrijving
`prefix`	Optioneel. Versie 2016-05-31 en hoger. Filtert de resultaten om alleen bestanden en mappen te retourneren met namen die beginnen met het opgegeven voorvoegsel.
`sharesnapshot`	Optioneel. Versie 2017-04-17 en hoger. De parameter momentopname van share is een ondoorzichtige `DateTime` waarde die, indien aanwezig, de momentopname van de share aangeeft die moet worden opgevraagd voor de lijst met bestanden en mappen.
`marker`	Optioneel. Een tekenreekswaarde die het gedeelte van de lijst aangeeft dat moet worden geretourneerd bij de volgende lijstbewerking. De bewerking retourneert een markeringswaarde in de hoofdtekst van het antwoord als de geretourneerde lijst niet is voltooid. U kunt vervolgens de markeringswaarde in een volgende aanroep gebruiken om de volgende set lijstitems aan te vragen. De markeringswaarde is ondoorzichtig voor de client.
`maxresults`	Optioneel. Hiermee geeft u het maximum aantal bestanden of mappen te retourneren. Als de aanvraag niet opgeeft `maxresults`of een waarde opgeeft die groter is dan 5000, retourneert de server maximaal 5000 items. Als u een `maxresults` waarde instelt die kleiner is dan of gelijk is aan nul, resulteert dit in foutcode 400 (Ongeldige aanvraag).
`include={Timestamps, ETag, Attributes, PermissionKey}`	Optioneel beschikbaar vanaf versie 2020-04-08. Hiermee geeft u een of meer eigenschappen op die moeten worden opgenomen in het antwoord: `Timestamps` `ETag` `Attributes` (Win32-bestandskenmerken) `PermissionKey` Als u meer dan een van deze opties op de URI wilt opgeven, moet u elke optie scheiden met een met URL gecodeerde komma (`%82`). Er wordt impliciet van uitgegaan dat de header `x-ms-file-extended-info` waar is wanneer deze parameter wordt opgegeven.
`timeout`	Optioneel. De `timeout` parameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor Azure Files bewerkingen voor meer informatie.

Aanvraagheaders

In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.

Aanvraagheader	Beschrijving
`Authorization`	Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie.
`Date` of `x-ms-date`	Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie.
`x-ms-version`	Vereist voor alle geautoriseerde aanvragen, optioneel voor anonieme aanvragen. Hiermee geeft u de versie van de bewerking te gebruiken voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-services voor meer informatie.
`x-ms-client-request-id`	Optioneel. Biedt een door de client gegenereerde, ondoorzichtige waarde met een limiet van 1 kibibyte (KiB) die wordt vastgelegd in de logboeken wanneer logboekregistratie is geconfigureerd. We raden u ten zeerste aan deze header te gebruiken om activiteiten aan de clientzijde te correleren met aanvragen die de server ontvangt. Zie Azure Files bewaken voor meer informatie.
`x-ms-file-extended-info: {true}`	Optioneel. Versie 2020-04-08 en hoger. Deze header wordt impliciet verondersteld waar te zijn als de `include` queryparameter niet leeg is. Als dit waar is, is de `Content-Length` eigenschap up-to-date. In versies 2020-04-08, 2020-06-12 en 2020-08-04 wordt `FileId` alleen geretourneerd voor bestanden en mappen als deze header waar is. In versies 2020-10-02 en hoger wordt `FileId` altijd geretourneerd voor bestanden en mappen.
`x-ms-file-request-intent`	Vereist als `Authorization` de header een OAuth-token opgeeft. Acceptabele waarde is `backup`. Deze header geeft aan dat de `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action` of `Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` moet worden verleend als deze zijn opgenomen in het RBAC-beleid dat is toegewezen aan de identiteit die is geautoriseerd met behulp van de `Authorization` header. Beschikbaar voor versie 2022-11-02 en hoger.
`x-ms-allow-trailing-dot: { <Boolean> }`	Optioneel. Versie 2022-11-02 en hoger. De Booleaanse waarde geeft aan of een volgpunt in de aanvraag-URL moet worden ingekort of niet. Zie Shares, mappen, bestanden en metagegevens een naam geven en hiernaar verwijzen voor meer informatie.

Aanvraagbody

Geen.

Antwoord

Het antwoord bevat een HTTP-statuscode, een set antwoordheaders en een antwoordtekst in XML-indeling.

Statuscode

Een geslaagde bewerking retourneert statuscode 200 (OK). Zie Status- en foutcodes voor meer informatie over statuscodes.

Antwoordheaders

Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook extra, standaard HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.

Antwoordheader	Description
`Content-Type`	Hiermee geeft u de indeling op waarin de resultaten worden geretourneerd. Momenteel is `application/xml`deze waarde .
`x-ms-request-id`	Deze header identificeert op unieke wijze de aanvraag die is gedaan en kan worden gebruikt voor het oplossen van problemen met de aanvraag. Zie Problemen met API-bewerkingen oplossen voor meer informatie.
`x-ms-version`	Geeft de versie van Azure Files gebruikt om de aanvraag uit te voeren.
`Date` of `x-ms-date`	Een UTC-datum/tijd-waarde die de tijd aangeeft waarop het antwoord is gestart. De service genereert deze waarde.
`x-ms-client-request-id`	U kunt deze header gebruiken om problemen met aanvragen en bijbehorende antwoorden op te lossen. De waarde van deze header is gelijk aan de waarde van de `x-ms-client-request-id` header, als deze aanwezig is in de aanvraag. De waarde is maximaal 1024 zichtbare ASCII-tekens. Als de `x-ms-client-request-id` header niet aanwezig is in de aanvraag, is deze header niet aanwezig in het antwoord.

Hoofdtekst van de reactie

De indeling van het XML-antwoord is als volgt.

Houd er rekening mee dat de Markerelementen , ShareSnapshoten MaxResults alleen aanwezig zijn als u deze opgeeft in de aanvraag-URI. Het NextMarker element heeft alleen een waarde als de lijstresultaten niet volledig zijn.

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

Houd er rekening mee dat het Content-Length element wordt geretourneerd in de lijst. Deze waarde is echter mogelijk niet up-to-date, omdat een SMB-client het bestand mogelijk lokaal heeft gewijzigd. De waarde van Content-Length geeft dat feit mogelijk niet weer totdat de greep is gesloten of de op-lock is verbroken. Als u de huidige eigenschapswaarden wilt ophalen, gebruikt x-ms-file-extended-info: trueu of roept u Bestandseigenschappen ophalen aan.

In versies 2020-04-08, 2020-06-12 en 2020-08-04 wordt FileId geretourneerd voor bestanden en mappen als de header x-ms-file-extended-info waar is. In versie 2020-10-02 en hoger wordt FileId altijd geretourneerd voor bestanden en mappen.

In versie 2020-04-08 include={timestamps} worden de volgende timestamp-eigenschappen geretourneerd: CreationTime, LastAccessTimeen LastWriteTime. In versie 2020-06-12 en hoger include={timestamps} retourneert de volgende timestamp-eigenschappen: CreationTime, LastAccessTime, LastWriteTime, ChangeTimeen Last-Modified.

In versie 2020-10-02 en hoger wordt DirectoryId geretourneerd in het antwoord. Hiermee wordt de FileId van de map opgegeven waarop de API wordt aangeroepen.

In versies 2021-12-02 en nieuwer worden List Directory and Files alleNameFile elementwaarden ,NameDirectoryPrefix of DirectoryPath elementen met tekens die ongeldig zijn in XML (met name U+FFFE of U+FFFFFF) in procenten gecodeerd (per RFC 2396). Indien gecodeerd, bevat het Nameelement , Prefix of EnumerationResults een Encoded=true kenmerk. Houd er rekening mee dat dit alleen gebeurt voor de Name elementwaarden die de tekens bevatten die ongeldig zijn in XML, niet voor de resterende Name elementen in het antwoord.

Datum-/tijdnotatie en API-versie voor tijdstempelvelden

Element	Datum/tijd-indeling	Voorbeeldwaarde	API-versie
`CreationTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 en hoger
`LastAccessTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 en hoger
`LastWriteTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 en hoger
`ChangeTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-06-12 en hoger
`Last-Modified`	RFC 1123	`Thu, 17 Sep 2020 13:38:07 GMT`	2020-06-12 en hoger

Autorisatie

Alleen de accounteigenaar kan deze bewerking aanroepen.

Opmerkingen

De waarde die in het Content-Length -element wordt geretourneerd, komt overeen met de waarde van de header van het bestand x-ms-content-length .

Houd er rekening mee dat elk Directory geretourneerd element telt voor het maximale resultaat, net als elk File element. Bestanden en mappen worden door elkaar weergegeven, in lexicatisch gesorteerde volgorde in de hoofdtekst van het antwoord.

Vermelding is beperkt tot één niveau van de directoryhiërarchie. Als u meerdere niveaus wilt weergeven, kunt u meerdere aanroepen op een iteratieve manier uitvoeren. Gebruik de Directory waarde die wordt geretourneerd door het ene resultaat in een volgende aanroep van List Directories and Files.

Zie ook

Bewerkingen op directory's